mailslurp_client 15.0.5 → 15.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/mailslurp_client/api/alias_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/attachment_controller_api.rb +4 -4
- data/lib/mailslurp_client/api/bounce_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/common_actions_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/contact_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/domain_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/email_controller_api.rb +17 -14
- data/lib/mailslurp_client/api/expired_controller_api.rb +10 -10
- data/lib/mailslurp_client/api/export_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/form_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/group_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/inbox_controller_api.rb +95 -95
- data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/mail_server_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/missed_email_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/sent_emails_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/template_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/tracking_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/wait_for_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/webhook_controller_api.rb +1 -1
- data/lib/mailslurp_client/api_client.rb +1 -1
- data/lib/mailslurp_client/api_error.rb +1 -1
- data/lib/mailslurp_client/configuration.rb +5 -5
- data/lib/mailslurp_client/models/abstract_webhook_payload.rb +16 -1
- data/lib/mailslurp_client/models/alias_dto.rb +40 -14
- data/lib/mailslurp_client/models/alias_projection.rb +41 -11
- data/lib/mailslurp_client/models/attachment_entity.rb +21 -1
- data/lib/mailslurp_client/models/attachment_meta_data.rb +21 -1
- data/lib/mailslurp_client/models/attachment_projection.rb +44 -24
- data/lib/mailslurp_client/models/basic_auth_options.rb +11 -1
- data/lib/mailslurp_client/models/bounce_projection.rb +11 -1
- data/lib/mailslurp_client/models/bounce_recipient.rb +21 -1
- data/lib/mailslurp_client/models/bounced_email_dto.rb +21 -1
- data/lib/mailslurp_client/models/bounced_recipient_dto.rb +16 -1
- data/lib/mailslurp_client/models/bulk_send_email_options.rb +6 -1
- data/lib/mailslurp_client/models/condition_option.rb +11 -1
- data/lib/mailslurp_client/models/contact_dto.rb +21 -1
- data/lib/mailslurp_client/models/contact_projection.rb +24 -14
- data/lib/mailslurp_client/models/content_match_options.rb +6 -1
- data/lib/mailslurp_client/models/count_dto.rb +6 -1
- data/lib/mailslurp_client/models/create_alias_options.rb +11 -1
- data/lib/mailslurp_client/models/create_contact_options.rb +1 -1
- data/lib/mailslurp_client/models/create_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/create_group_options.rb +6 -1
- data/lib/mailslurp_client/models/create_inbox_dto.rb +1 -1
- data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +11 -1
- data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +16 -1
- data/lib/mailslurp_client/models/create_template_options.rb +11 -1
- data/lib/mailslurp_client/models/create_tracking_pixel_options.rb +1 -1
- data/lib/mailslurp_client/models/create_webhook_options.rb +6 -1
- data/lib/mailslurp_client/models/describe_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +11 -1
- data/lib/mailslurp_client/models/dns_lookup_options.rb +6 -1
- data/lib/mailslurp_client/models/dns_lookup_result.rb +21 -1
- data/lib/mailslurp_client/models/dns_lookup_results.rb +6 -1
- data/lib/mailslurp_client/models/domain_dto.rb +65 -14
- data/lib/mailslurp_client/models/domain_name_record.rb +21 -1
- data/lib/mailslurp_client/models/domain_preview.rb +33 -8
- data/lib/mailslurp_client/models/download_attachment_dto.rb +16 -1
- data/lib/mailslurp_client/models/email.rb +55 -14
- data/lib/mailslurp_client/models/email_analysis.rb +1 -1
- data/lib/mailslurp_client/models/email_content_match_result.rb +11 -1
- data/lib/mailslurp_client/models/email_links_result.rb +11 -1
- data/lib/mailslurp_client/models/email_preview.rb +16 -1
- data/lib/mailslurp_client/models/email_projection.rb +64 -44
- data/lib/mailslurp_client/models/email_recipients.rb +1 -1
- data/lib/mailslurp_client/models/email_text_lines_result.rb +11 -1
- data/lib/mailslurp_client/models/email_verification_result.rb +34 -14
- data/lib/mailslurp_client/models/expiration_defaults.rb +11 -1
- data/lib/mailslurp_client/models/expired_inbox_dto.rb +16 -1
- data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +21 -1
- data/lib/mailslurp_client/models/export_link.rb +6 -1
- data/lib/mailslurp_client/models/export_options.rb +6 -1
- data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +11 -1
- data/lib/mailslurp_client/models/forward_email_options.rb +1 -1
- data/lib/mailslurp_client/models/gravatar_url.rb +11 -1
- data/lib/mailslurp_client/models/group_contacts_dto.rb +11 -1
- data/lib/mailslurp_client/models/group_dto.rb +16 -1
- data/lib/mailslurp_client/models/group_projection.rb +16 -1
- data/lib/mailslurp_client/models/html_validation_result.rb +30 -14
- data/lib/mailslurp_client/models/inbox_dto.rb +26 -1
- data/lib/mailslurp_client/models/inbox_exists_dto.rb +6 -1
- data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +31 -1
- data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +6 -1
- data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +11 -1
- data/lib/mailslurp_client/models/inbox_preview.rb +21 -1
- data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +36 -1
- data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +6 -1
- data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +11 -1
- data/lib/mailslurp_client/models/inline_object.rb +1 -1
- data/lib/mailslurp_client/models/ip_address_result.rb +11 -1
- data/lib/mailslurp_client/models/json_schema_dto.rb +6 -1
- data/lib/mailslurp_client/models/match_option.rb +11 -1
- data/lib/mailslurp_client/models/match_options.rb +1 -1
- data/lib/mailslurp_client/models/missed_email.rb +36 -1
- data/lib/mailslurp_client/models/missed_email_projection.rb +11 -1
- data/lib/mailslurp_client/models/name_server_record.rb +21 -1
- data/lib/mailslurp_client/models/organization_inbox_projection.rb +26 -1
- data/lib/mailslurp_client/models/page_alias.rb +30 -21
- data/lib/mailslurp_client/models/page_attachment_entity.rb +30 -21
- data/lib/mailslurp_client/models/page_bounced_email.rb +30 -21
- data/lib/mailslurp_client/models/page_bounced_recipients.rb +30 -21
- data/lib/mailslurp_client/models/page_contact_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_email_preview.rb +30 -21
- data/lib/mailslurp_client/models/page_email_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_group_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +30 -21
- data/lib/mailslurp_client/models/page_inbox_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +30 -21
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_sent_email_projection.rb +42 -3
- data/lib/mailslurp_client/models/page_template_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_thread_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_webhook_projection.rb +30 -21
- data/lib/mailslurp_client/models/page_webhook_result.rb +30 -21
- data/lib/mailslurp_client/models/{pageable.rb → pageable_object.rb} +4 -4
- data/lib/mailslurp_client/models/raw_email_json.rb +6 -1
- data/lib/mailslurp_client/models/recipient.rb +11 -1
- data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +25 -14
- data/lib/mailslurp_client/models/reply_to_email_options.rb +25 -14
- data/lib/mailslurp_client/models/send_email_options.rb +13 -3
- data/lib/mailslurp_client/models/sender.rb +11 -1
- data/lib/mailslurp_client/models/sent_email_dto.rb +34 -14
- data/lib/mailslurp_client/models/sent_email_projection.rb +57 -17
- data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +6 -1
- data/lib/mailslurp_client/models/simple_send_email_options.rb +6 -1
- data/lib/mailslurp_client/models/sort.rb +1 -1
- data/lib/mailslurp_client/models/template_dto.rb +26 -1
- data/lib/mailslurp_client/models/template_projection.rb +36 -11
- data/lib/mailslurp_client/models/template_variable.rb +11 -1
- data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +11 -1
- data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +11 -1
- data/lib/mailslurp_client/models/thread_projection.rb +52 -17
- data/lib/mailslurp_client/models/tracking_pixel_dto.rb +26 -1
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +21 -1
- data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +24 -14
- data/lib/mailslurp_client/models/unread_count.rb +6 -1
- data/lib/mailslurp_client/models/unseen_error_count_dto.rb +6 -1
- data/lib/mailslurp_client/models/update_alias_options.rb +1 -1
- data/lib/mailslurp_client/models/update_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/update_group_contacts.rb +6 -1
- data/lib/mailslurp_client/models/update_inbox_options.rb +1 -1
- data/lib/mailslurp_client/models/upload_attachment_options.rb +1 -1
- data/lib/mailslurp_client/models/validation_dto.rb +11 -1
- data/lib/mailslurp_client/models/validation_message.rb +6 -1
- data/lib/mailslurp_client/models/verify_email_address_options.rb +6 -1
- data/lib/mailslurp_client/models/wait_for_conditions.rb +11 -1
- data/lib/mailslurp_client/models/webhook_dto.rb +46 -1
- data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +41 -1
- data/lib/mailslurp_client/models/webhook_email_read_payload.rb +36 -1
- data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +36 -1
- data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +36 -1
- data/lib/mailslurp_client/models/webhook_new_email_payload.rb +56 -1
- data/lib/mailslurp_client/models/webhook_projection.rb +42 -17
- data/lib/mailslurp_client/models/webhook_redrive_result.rb +11 -1
- data/lib/mailslurp_client/models/webhook_result_dto.rb +51 -1
- data/lib/mailslurp_client/models/webhook_test_request.rb +16 -1
- data/lib/mailslurp_client/models/webhook_test_response.rb +1 -1
- data/lib/mailslurp_client/models/webhook_test_result.rb +11 -1
- data/lib/mailslurp_client/version.rb +2 -2
- data/lib/mailslurp_client.rb +2 -2
- metadata +2 -2
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -22,16 +22,16 @@ module MailSlurpClient
|
|
22
22
|
# Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
|
23
23
|
# Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @option opts [String] :
|
26
|
-
# @option opts [Array<String>] :
|
27
|
-
# @option opts [String] :
|
28
|
-
# @option opts [String] :
|
29
|
-
# @option opts [Boolean] :
|
30
|
-
# @option opts [Boolean] :
|
31
|
-
# @option opts [DateTime] :
|
32
|
-
# @option opts [Integer] :
|
33
|
-
# @option opts [Boolean] :
|
34
|
-
# @option opts [String] :
|
25
|
+
# @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
|
26
|
+
# @option opts [Array<String>] :tags Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
|
27
|
+
# @option opts [String] :name Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
|
28
|
+
# @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
|
29
|
+
# @option opts [Boolean] :use_domain_pool Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types.
|
30
|
+
# @option opts [Boolean] :favourite Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
|
31
|
+
# @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
|
32
|
+
# @option opts [Integer] :expires_in Number of milliseconds that inbox should exist for
|
33
|
+
# @option opts [Boolean] :allow_team_access DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
|
34
|
+
# @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`.
|
35
35
|
# @return [InboxDto]
|
36
36
|
def create_inbox(opts = {})
|
37
37
|
data, _status_code, _headers = create_inbox_with_http_info(opts)
|
@@ -41,40 +41,40 @@ module MailSlurpClient
|
|
41
41
|
# Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
|
42
42
|
# Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
|
43
43
|
# @param [Hash] opts the optional parameters
|
44
|
-
# @option opts [String] :
|
45
|
-
# @option opts [Array<String>] :
|
46
|
-
# @option opts [String] :
|
47
|
-
# @option opts [String] :
|
48
|
-
# @option opts [Boolean] :
|
49
|
-
# @option opts [Boolean] :
|
50
|
-
# @option opts [DateTime] :
|
51
|
-
# @option opts [Integer] :
|
52
|
-
# @option opts [Boolean] :
|
53
|
-
# @option opts [String] :
|
44
|
+
# @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
|
45
|
+
# @option opts [Array<String>] :tags Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
|
46
|
+
# @option opts [String] :name Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
|
47
|
+
# @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
|
48
|
+
# @option opts [Boolean] :use_domain_pool Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types.
|
49
|
+
# @option opts [Boolean] :favourite Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
|
50
|
+
# @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
|
51
|
+
# @option opts [Integer] :expires_in Number of milliseconds that inbox should exist for
|
52
|
+
# @option opts [Boolean] :allow_team_access DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
|
53
|
+
# @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`.
|
54
54
|
# @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
|
55
55
|
def create_inbox_with_http_info(opts = {})
|
56
56
|
if @api_client.config.debugging
|
57
57
|
@api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox ...'
|
58
58
|
end
|
59
59
|
allowable_values = ["HTTP_INBOX", "SMTP_INBOX"]
|
60
|
-
if @api_client.config.client_side_validation && opts[:'
|
61
|
-
fail ArgumentError, "invalid value for \"
|
60
|
+
if @api_client.config.client_side_validation && opts[:'inbox_type'] && !allowable_values.include?(opts[:'inbox_type'])
|
61
|
+
fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{allowable_values}"
|
62
62
|
end
|
63
63
|
# resource path
|
64
64
|
local_var_path = '/inboxes'
|
65
65
|
|
66
66
|
# query parameters
|
67
67
|
query_params = opts[:query_params] || {}
|
68
|
-
query_params[:'
|
69
|
-
query_params[:'
|
70
|
-
query_params[:'
|
71
|
-
query_params[:'
|
72
|
-
query_params[:'
|
73
|
-
query_params[:'
|
74
|
-
query_params[:'
|
75
|
-
query_params[:'
|
76
|
-
query_params[:'
|
77
|
-
query_params[:'
|
68
|
+
query_params[:'emailAddress'] = opts[:'email_address'] if !opts[:'email_address'].nil?
|
69
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :multi) if !opts[:'tags'].nil?
|
70
|
+
query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
|
71
|
+
query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
|
72
|
+
query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].nil?
|
73
|
+
query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
|
74
|
+
query_params[:'expiresAt'] = opts[:'expires_at'] if !opts[:'expires_at'].nil?
|
75
|
+
query_params[:'expiresIn'] = opts[:'expires_in'] if !opts[:'expires_in'].nil?
|
76
|
+
query_params[:'allowTeamAccess'] = opts[:'allow_team_access'] if !opts[:'allow_team_access'].nil?
|
77
|
+
query_params[:'inboxType'] = opts[:'inbox_type'] if !opts[:'inbox_type'].nil?
|
78
78
|
|
79
79
|
# header parameters
|
80
80
|
header_params = opts[:header_params] || {}
|
@@ -111,7 +111,7 @@ module MailSlurpClient
|
|
111
111
|
|
112
112
|
# Create an inbox ruleset
|
113
113
|
# Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
|
114
|
-
# @param inbox_id [String]
|
114
|
+
# @param inbox_id [String] inboxId
|
115
115
|
# @param create_inbox_ruleset_options [CreateInboxRulesetOptions]
|
116
116
|
# @param [Hash] opts the optional parameters
|
117
117
|
# @return [InboxRulesetDto]
|
@@ -122,7 +122,7 @@ module MailSlurpClient
|
|
122
122
|
|
123
123
|
# Create an inbox ruleset
|
124
124
|
# Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
|
125
|
-
# @param inbox_id [String]
|
125
|
+
# @param inbox_id [String] inboxId
|
126
126
|
# @param create_inbox_ruleset_options [CreateInboxRulesetOptions]
|
127
127
|
# @param [Hash] opts the optional parameters
|
128
128
|
# @return [Array<(InboxRulesetDto, Integer, Hash)>] InboxRulesetDto data, response status code and response headers
|
@@ -542,7 +542,7 @@ module MailSlurpClient
|
|
542
542
|
# @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
|
543
543
|
# @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
|
544
544
|
# @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
|
545
|
-
# @option opts [Boolean] :
|
545
|
+
# @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access.
|
546
546
|
# @option opts [DateTime] :since Optional filter by created after given date time
|
547
547
|
# @option opts [DateTime] :before Optional filter by created before given date time
|
548
548
|
# @return [PageInboxProjection]
|
@@ -560,7 +560,7 @@ module MailSlurpClient
|
|
560
560
|
# @option opts [Boolean] :favourite Optionally filter results for favourites only
|
561
561
|
# @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
|
562
562
|
# @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
|
563
|
-
# @option opts [Boolean] :
|
563
|
+
# @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access.
|
564
564
|
# @option opts [DateTime] :since Optional filter by created after given date time
|
565
565
|
# @option opts [DateTime] :before Optional filter by created before given date time
|
566
566
|
# @return [Array<(PageInboxProjection, Integer, Hash)>] PageInboxProjection data, response status code and response headers
|
@@ -583,7 +583,7 @@ module MailSlurpClient
|
|
583
583
|
query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
|
584
584
|
query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
|
585
585
|
query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
|
586
|
-
query_params[:'
|
586
|
+
query_params[:'teamAccess'] = opts[:'team_access'] if !opts[:'team_access'].nil?
|
587
587
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
588
588
|
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
589
589
|
|
@@ -622,7 +622,7 @@ module MailSlurpClient
|
|
622
622
|
|
623
623
|
# Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.
|
624
624
|
# List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
|
625
|
-
# @param
|
625
|
+
# @param inbox_id [String] Id of inbox that emails belongs to
|
626
626
|
# @param [Hash] opts the optional parameters
|
627
627
|
# @option opts [Integer] :alias_for_limit__assessed_first_before_assessing_any_passed_limit_
|
628
628
|
# @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
|
@@ -631,17 +631,17 @@ module MailSlurpClient
|
|
631
631
|
# @option opts [Integer] :delay_timeout
|
632
632
|
# @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
|
633
633
|
# @option opts [Boolean] :unread_only
|
634
|
-
# @option opts [DateTime] :
|
635
|
-
# @option opts [DateTime] :
|
634
|
+
# @option opts [DateTime] :before Exclude emails received after this ISO 8601 date time
|
635
|
+
# @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
|
636
636
|
# @return [Array<EmailPreview>]
|
637
|
-
def get_emails(
|
638
|
-
data, _status_code, _headers = get_emails_with_http_info(
|
637
|
+
def get_emails(inbox_id, opts = {})
|
638
|
+
data, _status_code, _headers = get_emails_with_http_info(inbox_id, opts)
|
639
639
|
data
|
640
640
|
end
|
641
641
|
|
642
642
|
# Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.
|
643
643
|
# List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
|
644
|
-
# @param
|
644
|
+
# @param inbox_id [String] Id of inbox that emails belongs to
|
645
645
|
# @param [Hash] opts the optional parameters
|
646
646
|
# @option opts [Integer] :alias_for_limit__assessed_first_before_assessing_any_passed_limit_
|
647
647
|
# @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
|
@@ -650,16 +650,16 @@ module MailSlurpClient
|
|
650
650
|
# @option opts [Integer] :delay_timeout
|
651
651
|
# @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
|
652
652
|
# @option opts [Boolean] :unread_only
|
653
|
-
# @option opts [DateTime] :
|
654
|
-
# @option opts [DateTime] :
|
653
|
+
# @option opts [DateTime] :before Exclude emails received after this ISO 8601 date time
|
654
|
+
# @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
|
655
655
|
# @return [Array<(Array<EmailPreview>, Integer, Hash)>] Array<EmailPreview> data, response status code and response headers
|
656
|
-
def get_emails_with_http_info(
|
656
|
+
def get_emails_with_http_info(inbox_id, opts = {})
|
657
657
|
if @api_client.config.debugging
|
658
658
|
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_emails ...'
|
659
659
|
end
|
660
|
-
# verify the required parameter '
|
661
|
-
if @api_client.config.client_side_validation &&
|
662
|
-
fail ArgumentError, "Missing the required parameter '
|
660
|
+
# verify the required parameter 'inbox_id' is set
|
661
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
662
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_emails"
|
663
663
|
end
|
664
664
|
if @api_client.config.client_side_validation && !opts[:'alias_for_limit__assessed_first_before_assessing_any_passed_limit_'].nil? && opts[:'alias_for_limit__assessed_first_before_assessing_any_passed_limit_'] > 100
|
665
665
|
fail ArgumentError, 'invalid value for "opts[:"alias_for_limit__assessed_first_before_assessing_any_passed_limit_"]" when calling InboxControllerApi.get_emails, must be smaller than or equal to 100.'
|
@@ -674,7 +674,7 @@ module MailSlurpClient
|
|
674
674
|
fail ArgumentError, "invalid value for \"sort_the_results_by_received_date_and_direction_asc_or_desc\", must be one of #{allowable_values}"
|
675
675
|
end
|
676
676
|
# resource path
|
677
|
-
local_var_path = '/inboxes/{inboxId}/emails'.sub('{' + '
|
677
|
+
local_var_path = '/inboxes/{inboxId}/emails'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
678
678
|
|
679
679
|
# query parameters
|
680
680
|
query_params = opts[:query_params] || {}
|
@@ -685,8 +685,8 @@ module MailSlurpClient
|
|
685
685
|
query_params[:'delayTimeout'] = opts[:'delay_timeout'] if !opts[:'delay_timeout'].nil?
|
686
686
|
query_params[:'minCount'] = opts[:'min_count'] if !opts[:'min_count'].nil?
|
687
687
|
query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil?
|
688
|
-
query_params[:'
|
689
|
-
query_params[:'
|
688
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
689
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
690
690
|
|
691
691
|
# header parameters
|
692
692
|
header_params = opts[:header_params] || {}
|
@@ -838,28 +838,28 @@ module MailSlurpClient
|
|
838
838
|
end
|
839
839
|
|
840
840
|
# Get email count in inbox
|
841
|
-
# @param
|
841
|
+
# @param inbox_id [String] Id of inbox that emails belongs to
|
842
842
|
# @param [Hash] opts the optional parameters
|
843
843
|
# @return [CountDto]
|
844
|
-
def get_inbox_email_count(
|
845
|
-
data, _status_code, _headers = get_inbox_email_count_with_http_info(
|
844
|
+
def get_inbox_email_count(inbox_id, opts = {})
|
845
|
+
data, _status_code, _headers = get_inbox_email_count_with_http_info(inbox_id, opts)
|
846
846
|
data
|
847
847
|
end
|
848
848
|
|
849
849
|
# Get email count in inbox
|
850
|
-
# @param
|
850
|
+
# @param inbox_id [String] Id of inbox that emails belongs to
|
851
851
|
# @param [Hash] opts the optional parameters
|
852
852
|
# @return [Array<(CountDto, Integer, Hash)>] CountDto data, response status code and response headers
|
853
|
-
def get_inbox_email_count_with_http_info(
|
853
|
+
def get_inbox_email_count_with_http_info(inbox_id, opts = {})
|
854
854
|
if @api_client.config.debugging
|
855
855
|
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_email_count ...'
|
856
856
|
end
|
857
|
-
# verify the required parameter '
|
858
|
-
if @api_client.config.client_side_validation &&
|
859
|
-
fail ArgumentError, "Missing the required parameter '
|
857
|
+
# verify the required parameter 'inbox_id' is set
|
858
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
859
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_email_count"
|
860
860
|
end
|
861
861
|
# resource path
|
862
|
-
local_var_path = '/inboxes/{inboxId}/emails/count'.sub('{' + '
|
862
|
+
local_var_path = '/inboxes/{inboxId}/emails/count'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
863
863
|
|
864
864
|
# query parameters
|
865
865
|
query_params = opts[:query_params] || {}
|
@@ -899,7 +899,7 @@ module MailSlurpClient
|
|
899
899
|
|
900
900
|
# Get inbox emails paginated
|
901
901
|
# Get a paginated list of emails in an inbox. Does not hold connections open.
|
902
|
-
# @param
|
902
|
+
# @param inbox_id [String] Id of inbox that emails belongs to
|
903
903
|
# @param [Hash] opts the optional parameters
|
904
904
|
# @option opts [Integer] :page Optional page index in inbox emails list pagination (default to 0)
|
905
905
|
# @option opts [Integer] :size Optional page size in inbox emails list pagination (default to 20)
|
@@ -907,14 +907,14 @@ module MailSlurpClient
|
|
907
907
|
# @option opts [DateTime] :since Optional filter by received after given date time
|
908
908
|
# @option opts [DateTime] :before Optional filter by received before given date time
|
909
909
|
# @return [PageEmailPreview]
|
910
|
-
def get_inbox_emails_paginated(
|
911
|
-
data, _status_code, _headers = get_inbox_emails_paginated_with_http_info(
|
910
|
+
def get_inbox_emails_paginated(inbox_id, opts = {})
|
911
|
+
data, _status_code, _headers = get_inbox_emails_paginated_with_http_info(inbox_id, opts)
|
912
912
|
data
|
913
913
|
end
|
914
914
|
|
915
915
|
# Get inbox emails paginated
|
916
916
|
# Get a paginated list of emails in an inbox. Does not hold connections open.
|
917
|
-
# @param
|
917
|
+
# @param inbox_id [String] Id of inbox that emails belongs to
|
918
918
|
# @param [Hash] opts the optional parameters
|
919
919
|
# @option opts [Integer] :page Optional page index in inbox emails list pagination
|
920
920
|
# @option opts [Integer] :size Optional page size in inbox emails list pagination
|
@@ -922,20 +922,20 @@ module MailSlurpClient
|
|
922
922
|
# @option opts [DateTime] :since Optional filter by received after given date time
|
923
923
|
# @option opts [DateTime] :before Optional filter by received before given date time
|
924
924
|
# @return [Array<(PageEmailPreview, Integer, Hash)>] PageEmailPreview data, response status code and response headers
|
925
|
-
def get_inbox_emails_paginated_with_http_info(
|
925
|
+
def get_inbox_emails_paginated_with_http_info(inbox_id, opts = {})
|
926
926
|
if @api_client.config.debugging
|
927
927
|
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_emails_paginated ...'
|
928
928
|
end
|
929
|
-
# verify the required parameter '
|
930
|
-
if @api_client.config.client_side_validation &&
|
931
|
-
fail ArgumentError, "Missing the required parameter '
|
929
|
+
# verify the required parameter 'inbox_id' is set
|
930
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
931
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_emails_paginated"
|
932
932
|
end
|
933
933
|
allowable_values = ["ASC", "DESC"]
|
934
934
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
935
935
|
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
936
936
|
end
|
937
937
|
# resource path
|
938
|
-
local_var_path = '/inboxes/{inboxId}/emails/paginated'.sub('{' + '
|
938
|
+
local_var_path = '/inboxes/{inboxId}/emails/paginated'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
939
939
|
|
940
940
|
# query parameters
|
941
941
|
query_params = opts[:query_params] || {}
|
@@ -983,7 +983,7 @@ module MailSlurpClient
|
|
983
983
|
# @param inbox_id [String]
|
984
984
|
# @param [Hash] opts the optional parameters
|
985
985
|
# @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
|
986
|
-
# @option opts [Integer] :
|
986
|
+
# @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
|
987
987
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
988
988
|
# @option opts [String] :search_filter Optional sent email search
|
989
989
|
# @option opts [DateTime] :since Optional filter by sent after given date time
|
@@ -999,7 +999,7 @@ module MailSlurpClient
|
|
999
999
|
# @param inbox_id [String]
|
1000
1000
|
# @param [Hash] opts the optional parameters
|
1001
1001
|
# @option opts [Integer] :page Optional page index in inbox sent email list pagination
|
1002
|
-
# @option opts [Integer] :
|
1002
|
+
# @option opts [Integer] :size Optional page size in inbox sent email list pagination
|
1003
1003
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
1004
1004
|
# @option opts [String] :search_filter Optional sent email search
|
1005
1005
|
# @option opts [DateTime] :since Optional filter by sent after given date time
|
@@ -1023,7 +1023,7 @@ module MailSlurpClient
|
|
1023
1023
|
# query parameters
|
1024
1024
|
query_params = opts[:query_params] || {}
|
1025
1025
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
1026
|
-
query_params[:'
|
1026
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
1027
1027
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1028
1028
|
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
1029
1029
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
@@ -1361,7 +1361,7 @@ module MailSlurpClient
|
|
1361
1361
|
# @param inbox_id [String]
|
1362
1362
|
# @param [Hash] opts the optional parameters
|
1363
1363
|
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
|
1364
|
-
# @option opts [Integer] :
|
1364
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
|
1365
1365
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
1366
1366
|
# @option opts [String] :search_filter Optional search filter
|
1367
1367
|
# @option opts [DateTime] :since Optional filter by created after given date time
|
@@ -1377,7 +1377,7 @@ module MailSlurpClient
|
|
1377
1377
|
# @param inbox_id [String]
|
1378
1378
|
# @param [Hash] opts the optional parameters
|
1379
1379
|
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
|
1380
|
-
# @option opts [Integer] :
|
1380
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
|
1381
1381
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
1382
1382
|
# @option opts [String] :search_filter Optional search filter
|
1383
1383
|
# @option opts [DateTime] :since Optional filter by created after given date time
|
@@ -1401,7 +1401,7 @@ module MailSlurpClient
|
|
1401
1401
|
# query parameters
|
1402
1402
|
query_params = opts[:query_params] || {}
|
1403
1403
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
1404
|
-
query_params[:'
|
1404
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
1405
1405
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1406
1406
|
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
1407
1407
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
@@ -1442,35 +1442,35 @@ module MailSlurpClient
|
|
1442
1442
|
|
1443
1443
|
# Send Email
|
1444
1444
|
# Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.
|
1445
|
-
# @param
|
1445
|
+
# @param inbox_id [String] ID of the inbox you want to send the email from
|
1446
1446
|
# @param send_email_options [SendEmailOptions]
|
1447
1447
|
# @param [Hash] opts the optional parameters
|
1448
1448
|
# @return [nil]
|
1449
|
-
def send_email(
|
1450
|
-
send_email_with_http_info(
|
1449
|
+
def send_email(inbox_id, send_email_options, opts = {})
|
1450
|
+
send_email_with_http_info(inbox_id, send_email_options, opts)
|
1451
1451
|
nil
|
1452
1452
|
end
|
1453
1453
|
|
1454
1454
|
# Send Email
|
1455
1455
|
# Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.
|
1456
|
-
# @param
|
1456
|
+
# @param inbox_id [String] ID of the inbox you want to send the email from
|
1457
1457
|
# @param send_email_options [SendEmailOptions]
|
1458
1458
|
# @param [Hash] opts the optional parameters
|
1459
1459
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1460
|
-
def send_email_with_http_info(
|
1460
|
+
def send_email_with_http_info(inbox_id, send_email_options, opts = {})
|
1461
1461
|
if @api_client.config.debugging
|
1462
1462
|
@api_client.config.logger.debug 'Calling API: InboxControllerApi.send_email ...'
|
1463
1463
|
end
|
1464
|
-
# verify the required parameter '
|
1465
|
-
if @api_client.config.client_side_validation &&
|
1466
|
-
fail ArgumentError, "Missing the required parameter '
|
1464
|
+
# verify the required parameter 'inbox_id' is set
|
1465
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
1466
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_email"
|
1467
1467
|
end
|
1468
1468
|
# verify the required parameter 'send_email_options' is set
|
1469
1469
|
if @api_client.config.client_side_validation && send_email_options.nil?
|
1470
1470
|
fail ArgumentError, "Missing the required parameter 'send_email_options' when calling InboxControllerApi.send_email"
|
1471
1471
|
end
|
1472
1472
|
# resource path
|
1473
|
-
local_var_path = '/inboxes/{inboxId}'.sub('{' + '
|
1473
|
+
local_var_path = '/inboxes/{inboxId}'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
1474
1474
|
|
1475
1475
|
# query parameters
|
1476
1476
|
query_params = opts[:query_params] || {}
|
@@ -1510,35 +1510,35 @@ module MailSlurpClient
|
|
1510
1510
|
|
1511
1511
|
# Send email and return sent confirmation
|
1512
1512
|
# Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it.
|
1513
|
-
# @param
|
1513
|
+
# @param inbox_id [String] ID of the inbox you want to send the email from
|
1514
1514
|
# @param send_email_options [SendEmailOptions]
|
1515
1515
|
# @param [Hash] opts the optional parameters
|
1516
1516
|
# @return [SentEmailDto]
|
1517
|
-
def send_email_and_confirm(
|
1518
|
-
data, _status_code, _headers = send_email_and_confirm_with_http_info(
|
1517
|
+
def send_email_and_confirm(inbox_id, send_email_options, opts = {})
|
1518
|
+
data, _status_code, _headers = send_email_and_confirm_with_http_info(inbox_id, send_email_options, opts)
|
1519
1519
|
data
|
1520
1520
|
end
|
1521
1521
|
|
1522
1522
|
# Send email and return sent confirmation
|
1523
1523
|
# Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it.
|
1524
|
-
# @param
|
1524
|
+
# @param inbox_id [String] ID of the inbox you want to send the email from
|
1525
1525
|
# @param send_email_options [SendEmailOptions]
|
1526
1526
|
# @param [Hash] opts the optional parameters
|
1527
1527
|
# @return [Array<(SentEmailDto, Integer, Hash)>] SentEmailDto data, response status code and response headers
|
1528
|
-
def send_email_and_confirm_with_http_info(
|
1528
|
+
def send_email_and_confirm_with_http_info(inbox_id, send_email_options, opts = {})
|
1529
1529
|
if @api_client.config.debugging
|
1530
1530
|
@api_client.config.logger.debug 'Calling API: InboxControllerApi.send_email_and_confirm ...'
|
1531
1531
|
end
|
1532
|
-
# verify the required parameter '
|
1533
|
-
if @api_client.config.client_side_validation &&
|
1534
|
-
fail ArgumentError, "Missing the required parameter '
|
1532
|
+
# verify the required parameter 'inbox_id' is set
|
1533
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
1534
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_email_and_confirm"
|
1535
1535
|
end
|
1536
1536
|
# verify the required parameter 'send_email_options' is set
|
1537
1537
|
if @api_client.config.client_side_validation && send_email_options.nil?
|
1538
1538
|
fail ArgumentError, "Missing the required parameter 'send_email_options' when calling InboxControllerApi.send_email_and_confirm"
|
1539
1539
|
end
|
1540
1540
|
# resource path
|
1541
|
-
local_var_path = '/inboxes/{inboxId}/confirm'.sub('{' + '
|
1541
|
+
local_var_path = '/inboxes/{inboxId}/confirm'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
1542
1542
|
|
1543
1543
|
# query parameters
|
1544
1544
|
query_params = opts[:query_params] || {}
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|