mailslurp_client 7.0.8 → 7.2.4
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.rb +12 -3
- metadata +11 -372
- data/Gemfile +0 -9
- data/LICENSE +0 -22
- data/Makefile +0 -3
- data/README.md +0 -239
- data/Rakefile +0 -10
- data/docs/AliasControllerApi.md +0 -337
- data/docs/AttachmentControllerApi.md +0 -126
- data/docs/AttachmentMetaData.md +0 -23
- data/docs/BasicAuthOptions.md +0 -19
- data/docs/BulkActionsControllerApi.md +0 -165
- data/docs/BulkSendEmailOptions.md +0 -19
- data/docs/CommonActionsControllerApi.md +0 -218
- data/docs/ContactControllerApi.md +0 -274
- data/docs/ContactDto.md +0 -31
- data/docs/ContactProjection.md +0 -27
- data/docs/CreateAnonymousAliasOptions.md +0 -17
- data/docs/CreateContactOptions.md +0 -31
- data/docs/CreateDomainOptions.md +0 -17
- data/docs/CreateGroupOptions.md +0 -19
- data/docs/CreateOwnedAliasOptions.md +0 -23
- data/docs/CreateTemplateOptions.md +0 -19
- data/docs/CreateWebhookOptions.md +0 -21
- data/docs/DomainControllerApi.md +0 -223
- data/docs/DomainDto.md +0 -29
- data/docs/DomainPreview.md +0 -21
- data/docs/Email.md +0 -49
- data/docs/EmailAnalysis.md +0 -25
- data/docs/EmailControllerApi.md +0 -740
- data/docs/EmailPreview.md +0 -31
- data/docs/EmailProjection.md +0 -33
- data/docs/FormControllerApi.md +0 -79
- data/docs/ForwardEmailOptions.md +0 -23
- data/docs/GroupContactsDto.md +0 -19
- data/docs/GroupControllerApi.md +0 -437
- data/docs/GroupDto.md +0 -23
- data/docs/GroupProjection.md +0 -23
- data/docs/HTMLValidationResult.md +0 -21
- data/docs/Inbox.md +0 -33
- data/docs/InboxControllerApi.md +0 -705
- data/docs/InboxProjection.md +0 -29
- data/docs/JsonNode.md +0 -59
- data/docs/MatchOption.md +0 -21
- data/docs/MatchOptions.md +0 -17
- data/docs/ModelAlias.md +0 -31
- data/docs/PageAlias.md +0 -37
- data/docs/PageContactProjection.md +0 -37
- data/docs/PageEmailPreview.md +0 -37
- data/docs/PageEmailProjection.md +0 -37
- data/docs/PageGroupProjection.md +0 -37
- data/docs/PageInboxProjection.md +0 -37
- data/docs/PageTemplateProjection.md +0 -37
- data/docs/PageWebhookProjection.md +0 -37
- data/docs/Pageable.md +0 -27
- data/docs/RawEmailJson.md +0 -17
- data/docs/SendEmailOptions.md +0 -45
- data/docs/SetInboxFavouritedOptions.md +0 -17
- data/docs/SimpleSendEmailOptions.md +0 -23
- data/docs/Sort.md +0 -21
- data/docs/TemplateControllerApi.md +0 -274
- data/docs/TemplateDto.md +0 -25
- data/docs/TemplateProjection.md +0 -25
- data/docs/TemplateVariable.md +0 -19
- data/docs/UnreadCount.md +0 -17
- data/docs/UpdateGroupContacts.md +0 -17
- data/docs/UpdateInboxOptions.md +0 -25
- data/docs/UploadAttachmentOptions.md +0 -21
- data/docs/ValidationDto.md +0 -19
- data/docs/ValidationMessage.md +0 -19
- data/docs/WaitForConditions.md +0 -29
- data/docs/WaitForControllerApi.md +0 -317
- data/docs/WebhookControllerApi.md +0 -339
- data/docs/WebhookDto.md +0 -33
- data/docs/WebhookProjection.md +0 -27
- data/docs/WebhookTestRequest.md +0 -23
- data/docs/WebhookTestResponse.md +0 -19
- data/docs/WebhookTestResult.md +0 -21
- data/git_push.sh +0 -58
- data/lib/mailslurp_client/api/alias_controller_api.rb +0 -405
- data/lib/mailslurp_client/api/attachment_controller_api.rb +0 -160
- data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +0 -203
- data/lib/mailslurp_client/api/common_actions_controller_api.rb +0 -257
- data/lib/mailslurp_client/api/contact_controller_api.rb +0 -323
- data/lib/mailslurp_client/api/domain_controller_api.rb +0 -264
- data/lib/mailslurp_client/api/email_controller_api.rb +0 -852
- data/lib/mailslurp_client/api/form_controller_api.rb +0 -104
- data/lib/mailslurp_client/api/group_controller_api.rb +0 -519
- data/lib/mailslurp_client/api/inbox_controller_api.rb +0 -822
- data/lib/mailslurp_client/api/template_controller_api.rb +0 -323
- data/lib/mailslurp_client/api/wait_for_controller_api.rb +0 -359
- data/lib/mailslurp_client/api/webhook_controller_api.rb +0 -405
- data/lib/mailslurp_client/api_client.rb +0 -386
- data/lib/mailslurp_client/api_error.rb +0 -57
- data/lib/mailslurp_client/configuration.rb +0 -248
- data/lib/mailslurp_client/models/attachment_meta_data.rb +0 -238
- data/lib/mailslurp_client/models/basic_auth_options.rb +0 -226
- data/lib/mailslurp_client/models/bulk_send_email_options.rb +0 -219
- data/lib/mailslurp_client/models/contact_dto.rb +0 -288
- data/lib/mailslurp_client/models/contact_projection.rb +0 -261
- data/lib/mailslurp_client/models/create_anonymous_alias_options.rb +0 -208
- data/lib/mailslurp_client/models/create_contact_options.rb +0 -277
- data/lib/mailslurp_client/models/create_domain_options.rb +0 -208
- data/lib/mailslurp_client/models/create_group_options.rb +0 -220
- data/lib/mailslurp_client/models/create_owned_alias_options.rb +0 -238
- data/lib/mailslurp_client/models/create_template_options.rb +0 -225
- data/lib/mailslurp_client/models/create_webhook_options.rb +0 -227
- data/lib/mailslurp_client/models/domain_dto.rb +0 -296
- data/lib/mailslurp_client/models/domain_preview.rb +0 -240
- data/lib/mailslurp_client/models/email.rb +0 -376
- data/lib/mailslurp_client/models/email_analysis.rb +0 -248
- data/lib/mailslurp_client/models/email_preview.rb +0 -286
- data/lib/mailslurp_client/models/email_projection.rb +0 -307
- data/lib/mailslurp_client/models/forward_email_options.rb +0 -244
- data/lib/mailslurp_client/models/group_contacts_dto.rb +0 -227
- data/lib/mailslurp_client/models/group_dto.rb +0 -248
- data/lib/mailslurp_client/models/group_projection.rb +0 -248
- data/lib/mailslurp_client/models/html_validation_result.rb +0 -243
- data/lib/mailslurp_client/models/inbox.rb +0 -290
- data/lib/mailslurp_client/models/inbox_projection.rb +0 -272
- data/lib/mailslurp_client/models/json_node.rb +0 -429
- data/lib/mailslurp_client/models/match_option.rb +0 -274
- data/lib/mailslurp_client/models/match_options.rb +0 -210
- data/lib/mailslurp_client/models/model_alias.rb +0 -284
- data/lib/mailslurp_client/models/page_alias.rb +0 -298
- data/lib/mailslurp_client/models/page_contact_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_email_preview.rb +0 -298
- data/lib/mailslurp_client/models/page_email_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_group_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_inbox_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_template_projection.rb +0 -298
- data/lib/mailslurp_client/models/page_webhook_projection.rb +0 -298
- data/lib/mailslurp_client/models/pageable.rb +0 -251
- data/lib/mailslurp_client/models/raw_email_json.rb +0 -211
- data/lib/mailslurp_client/models/send_email_options.rb +0 -392
- data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +0 -208
- data/lib/mailslurp_client/models/simple_send_email_options.rb +0 -237
- data/lib/mailslurp_client/models/sort.rb +0 -224
- data/lib/mailslurp_client/models/template_dto.rb +0 -269
- data/lib/mailslurp_client/models/template_projection.rb +0 -269
- data/lib/mailslurp_client/models/template_variable.rb +0 -259
- data/lib/mailslurp_client/models/unread_count.rb +0 -211
- data/lib/mailslurp_client/models/update_group_contacts.rb +0 -213
- data/lib/mailslurp_client/models/update_inbox_options.rb +0 -250
- data/lib/mailslurp_client/models/upload_attachment_options.rb +0 -228
- data/lib/mailslurp_client/models/validation_dto.rb +0 -217
- data/lib/mailslurp_client/models/validation_message.rb +0 -220
- data/lib/mailslurp_client/models/wait_for_conditions.rb +0 -316
- data/lib/mailslurp_client/models/webhook_dto.rb +0 -326
- data/lib/mailslurp_client/models/webhook_projection.rb +0 -277
- data/lib/mailslurp_client/models/webhook_test_request.rb +0 -284
- data/lib/mailslurp_client/models/webhook_test_response.rb +0 -215
- data/lib/mailslurp_client/models/webhook_test_result.rb +0 -235
- data/lib/mailslurp_client/version.rb +0 -15
- data/mailslurp_client.gemspec +0 -39
- data/spec/api/alias_controller_api_spec.rb +0 -107
- data/spec/api/attachment_controller_api_spec.rb +0 -61
- data/spec/api/bulk_actions_controller_api_spec.rb +0 -68
- data/spec/api/common_actions_controller_api_spec.rb +0 -129
- data/spec/api/contact_controller_api_spec.rb +0 -91
- data/spec/api/domain_controller_api_spec.rb +0 -82
- data/spec/api/email_controller_api_spec.rb +0 -162
- data/spec/api/form_controller_api_spec.rb +0 -54
- data/spec/api/group_controller_api_spec.rb +0 -126
- data/spec/api/inbox_controller_api_spec.rb +0 -172
- data/spec/api/template_controller_api_spec.rb +0 -91
- data/spec/api/wait_for_controller_api_spec.rb +0 -107
- data/spec/api/webhook_controller_api_spec.rb +0 -107
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/attachment_meta_data_spec.rb +0 -59
- data/spec/models/basic_auth_options_spec.rb +0 -47
- data/spec/models/bulk_send_email_options_spec.rb +0 -47
- data/spec/models/contact_dto_spec.rb +0 -83
- data/spec/models/contact_projection_spec.rb +0 -71
- data/spec/models/create_anonymous_alias_options_spec.rb +0 -41
- data/spec/models/create_contact_options_spec.rb +0 -83
- data/spec/models/create_domain_options_spec.rb +0 -41
- data/spec/models/create_group_options_spec.rb +0 -47
- data/spec/models/create_owned_alias_options_spec.rb +0 -59
- data/spec/models/create_template_options_spec.rb +0 -47
- data/spec/models/create_webhook_options_spec.rb +0 -53
- data/spec/models/domain_dto_spec.rb +0 -77
- data/spec/models/domain_preview_spec.rb +0 -53
- data/spec/models/email_analysis_spec.rb +0 -65
- data/spec/models/email_preview_spec.rb +0 -83
- data/spec/models/email_projection_spec.rb +0 -89
- data/spec/models/email_spec.rb +0 -137
- data/spec/models/forward_email_options_spec.rb +0 -59
- data/spec/models/group_contacts_dto_spec.rb +0 -47
- data/spec/models/group_dto_spec.rb +0 -59
- data/spec/models/group_projection_spec.rb +0 -59
- data/spec/models/html_validation_result_spec.rb +0 -53
- data/spec/models/inbox_projection_spec.rb +0 -77
- data/spec/models/inbox_spec.rb +0 -89
- data/spec/models/json_node_spec.rb +0 -171
- data/spec/models/match_option_spec.rb +0 -61
- data/spec/models/match_options_spec.rb +0 -41
- data/spec/models/model_alias_spec.rb +0 -83
- data/spec/models/page_alias_spec.rb +0 -101
- data/spec/models/page_contact_projection_spec.rb +0 -101
- data/spec/models/page_email_preview_spec.rb +0 -101
- data/spec/models/page_email_projection_spec.rb +0 -101
- data/spec/models/page_group_projection_spec.rb +0 -101
- data/spec/models/page_inbox_projection_spec.rb +0 -101
- data/spec/models/page_template_projection_spec.rb +0 -101
- data/spec/models/page_webhook_projection_spec.rb +0 -101
- data/spec/models/pageable_spec.rb +0 -71
- data/spec/models/raw_email_json_spec.rb +0 -41
- data/spec/models/send_email_options_spec.rb +0 -129
- data/spec/models/set_inbox_favourited_options_spec.rb +0 -41
- data/spec/models/simple_send_email_options_spec.rb +0 -59
- data/spec/models/sort_spec.rb +0 -53
- data/spec/models/template_dto_spec.rb +0 -65
- data/spec/models/template_projection_spec.rb +0 -65
- data/spec/models/template_variable_spec.rb +0 -51
- data/spec/models/unread_count_spec.rb +0 -41
- data/spec/models/update_group_contacts_spec.rb +0 -41
- data/spec/models/update_inbox_options_spec.rb +0 -65
- data/spec/models/upload_attachment_options_spec.rb +0 -53
- data/spec/models/validation_dto_spec.rb +0 -47
- data/spec/models/validation_message_spec.rb +0 -47
- data/spec/models/wait_for_conditions_spec.rb +0 -85
- data/spec/models/webhook_dto_spec.rb +0 -93
- data/spec/models/webhook_projection_spec.rb +0 -71
- data/spec/models/webhook_test_request_spec.rb +0 -63
- data/spec/models/webhook_test_response_spec.rb +0 -47
- data/spec/models/webhook_test_result_spec.rb +0 -53
- data/spec/spec_helper.rb +0 -111
@@ -1,82 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#MailSlurp API
|
3
|
-
|
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 ## Basic Concepts ### Inboxes Inboxes have real email addresses that can send and receive emails. You can create inboxes with specific email addresses (using custom domains). You can also use randomly assigned MailSlurp addresses as unique, disposable test addresses. See the InboxController or [inbox and email address guide](https://www.mailslurp.com/guides/) for more information. ### Receive Emails You can receive emails in a number of ways. You can fetch emails and attachments directly from an inbox. Or you can use `waitFor` endpoints to hold a connection open until an email is received that matches given criteria (such as subject or body content). You can also use webhooks to have emails from multiple inboxes forwarded to your server via HTTP POST. InboxController methods with `waitFor` in the name have a long timeout period and instruct MailSlurp to wait until an expected email is received. You can set conditions on email counts, subject or body matches, and more. Most receive methods only return an email ID and not the full email (to keep response sizes low). To fetch the full body or attachments for an email use the email's ID with EmailController endpoints. See the InboxController or [receiving emails guide](https://www.mailslurp.com/guides/) for more information. ### Send Emails You can send templated HTML emails in several ways. You must first create an inbox to send an email. An inbox can have a specific address or a randomly assigned one. You can send emails from an inbox using `to`, `cc`, and `bcc` recipient lists or with contacts and contact groups. Emails can contain plain-text or HTML bodies. You can also use email templates that support [moustache](https://mustache.github.io/) template variables. You can send attachments by first posting files to the AttachmentController and then using the returned IDs in the `attachments` field of the send options. See the InboxController or [sending emails guide](https://www.mailslurp.com/guides/) for more information. ### Templates MailSlurp emails support templates. You can create templates in the dashboard or API that contain [moustache](https://mustache.github.io/) style variables: for instance `Hello {{name}}`. Then when sending emails you can pass a map of variables names and values to be used. Additionally, when sending emails with contact groups you can use properties of the contact in your templates like `{{firstName}}` and `{{lastName}}`. > You can do a lot more with MailSlurp so see the included documentation for more information.
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.3
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'spec_helper'
|
14
|
-
require 'json'
|
15
|
-
|
16
|
-
# Unit tests for MailSlurpClient::DomainControllerApi
|
17
|
-
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
-
# Please update as you see appropriate
|
19
|
-
describe 'DomainControllerApi' do
|
20
|
-
before do
|
21
|
-
# run before each test
|
22
|
-
@api_instance = MailSlurpClient::DomainControllerApi.new
|
23
|
-
end
|
24
|
-
|
25
|
-
after do
|
26
|
-
# run after each test
|
27
|
-
end
|
28
|
-
|
29
|
-
describe 'test an instance of DomainControllerApi' do
|
30
|
-
it 'should create an instance of DomainControllerApi' do
|
31
|
-
expect(@api_instance).to be_instance_of(MailSlurpClient::DomainControllerApi)
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
# unit tests for create_domain
|
36
|
-
# Create Domain
|
37
|
-
# Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.
|
38
|
-
# @param domain_options domainOptions
|
39
|
-
# @param [Hash] opts the optional parameters
|
40
|
-
# @return [DomainDto]
|
41
|
-
describe 'create_domain test' do
|
42
|
-
it 'should work' do
|
43
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
-
end
|
45
|
-
end
|
46
|
-
|
47
|
-
# unit tests for delete_domain
|
48
|
-
# Delete a domain
|
49
|
-
# Delete a domain. This will disable any existing inboxes that use this domain.
|
50
|
-
# @param id id
|
51
|
-
# @param [Hash] opts the optional parameters
|
52
|
-
# @return [nil]
|
53
|
-
describe 'delete_domain test' do
|
54
|
-
it 'should work' do
|
55
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
56
|
-
end
|
57
|
-
end
|
58
|
-
|
59
|
-
# unit tests for get_domain
|
60
|
-
# Get a domain
|
61
|
-
# Returns domain verification status and tokens for a given domain
|
62
|
-
# @param id id
|
63
|
-
# @param [Hash] opts the optional parameters
|
64
|
-
# @return [DomainDto]
|
65
|
-
describe 'get_domain test' do
|
66
|
-
it 'should work' do
|
67
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
68
|
-
end
|
69
|
-
end
|
70
|
-
|
71
|
-
# unit tests for get_domains
|
72
|
-
# Get domains
|
73
|
-
# List all custom domains you have created
|
74
|
-
# @param [Hash] opts the optional parameters
|
75
|
-
# @return [Array<DomainPreview>]
|
76
|
-
describe 'get_domains test' do
|
77
|
-
it 'should work' do
|
78
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
79
|
-
end
|
80
|
-
end
|
81
|
-
|
82
|
-
end
|
@@ -1,162 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#MailSlurp API
|
3
|
-
|
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 ## Basic Concepts ### Inboxes Inboxes have real email addresses that can send and receive emails. You can create inboxes with specific email addresses (using custom domains). You can also use randomly assigned MailSlurp addresses as unique, disposable test addresses. See the InboxController or [inbox and email address guide](https://www.mailslurp.com/guides/) for more information. ### Receive Emails You can receive emails in a number of ways. You can fetch emails and attachments directly from an inbox. Or you can use `waitFor` endpoints to hold a connection open until an email is received that matches given criteria (such as subject or body content). You can also use webhooks to have emails from multiple inboxes forwarded to your server via HTTP POST. InboxController methods with `waitFor` in the name have a long timeout period and instruct MailSlurp to wait until an expected email is received. You can set conditions on email counts, subject or body matches, and more. Most receive methods only return an email ID and not the full email (to keep response sizes low). To fetch the full body or attachments for an email use the email's ID with EmailController endpoints. See the InboxController or [receiving emails guide](https://www.mailslurp.com/guides/) for more information. ### Send Emails You can send templated HTML emails in several ways. You must first create an inbox to send an email. An inbox can have a specific address or a randomly assigned one. You can send emails from an inbox using `to`, `cc`, and `bcc` recipient lists or with contacts and contact groups. Emails can contain plain-text or HTML bodies. You can also use email templates that support [moustache](https://mustache.github.io/) template variables. You can send attachments by first posting files to the AttachmentController and then using the returned IDs in the `attachments` field of the send options. See the InboxController or [sending emails guide](https://www.mailslurp.com/guides/) for more information. ### Templates MailSlurp emails support templates. You can create templates in the dashboard or API that contain [moustache](https://mustache.github.io/) style variables: for instance `Hello {{name}}`. Then when sending emails you can pass a map of variables names and values to be used. Additionally, when sending emails with contact groups you can use properties of the contact in your templates like `{{firstName}}` and `{{lastName}}`. > You can do a lot more with MailSlurp so see the included documentation for more information.
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.3
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'spec_helper'
|
14
|
-
require 'json'
|
15
|
-
|
16
|
-
# Unit tests for MailSlurpClient::EmailControllerApi
|
17
|
-
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
-
# Please update as you see appropriate
|
19
|
-
describe 'EmailControllerApi' do
|
20
|
-
before do
|
21
|
-
# run before each test
|
22
|
-
@api_instance = MailSlurpClient::EmailControllerApi.new
|
23
|
-
end
|
24
|
-
|
25
|
-
after do
|
26
|
-
# run after each test
|
27
|
-
end
|
28
|
-
|
29
|
-
describe 'test an instance of EmailControllerApi' do
|
30
|
-
it 'should create an instance of EmailControllerApi' do
|
31
|
-
expect(@api_instance).to be_instance_of(MailSlurpClient::EmailControllerApi)
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
# unit tests for delete_all_emails
|
36
|
-
# Delete all emails
|
37
|
-
# Deletes all emails
|
38
|
-
# @param [Hash] opts the optional parameters
|
39
|
-
# @return [nil]
|
40
|
-
describe 'delete_all_emails test' do
|
41
|
-
it 'should work' do
|
42
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
43
|
-
end
|
44
|
-
end
|
45
|
-
|
46
|
-
# unit tests for delete_email
|
47
|
-
# Delete Email
|
48
|
-
# Deletes an email and removes it from the inbox
|
49
|
-
# @param email_id emailId
|
50
|
-
# @param [Hash] opts the optional parameters
|
51
|
-
# @return [nil]
|
52
|
-
describe 'delete_email test' do
|
53
|
-
it 'should work' do
|
54
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
55
|
-
end
|
56
|
-
end
|
57
|
-
|
58
|
-
# unit tests for download_attachment
|
59
|
-
# Get email attachment
|
60
|
-
# Returns the specified attachment for a given email as a byte stream (file download). Get the attachmentId from the email response.
|
61
|
-
# @param attachment_id attachmentId
|
62
|
-
# @param email_id emailId
|
63
|
-
# @param [Hash] opts the optional parameters
|
64
|
-
# @option opts [String] :api_key Can pass apiKey in url for this request if you wish to download the file in a browser
|
65
|
-
# @return [String]
|
66
|
-
describe 'download_attachment test' do
|
67
|
-
it 'should work' do
|
68
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
69
|
-
end
|
70
|
-
end
|
71
|
-
|
72
|
-
# unit tests for forward_email
|
73
|
-
# Forward Email
|
74
|
-
# Forward email content to given recipients
|
75
|
-
# @param email_id emailId
|
76
|
-
# @param forward_email_options forwardEmailOptions
|
77
|
-
# @param [Hash] opts the optional parameters
|
78
|
-
# @return [nil]
|
79
|
-
describe 'forward_email test' do
|
80
|
-
it 'should work' do
|
81
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
82
|
-
end
|
83
|
-
end
|
84
|
-
|
85
|
-
# unit tests for get_attachment_meta_data
|
86
|
-
# Get email attachment metadata
|
87
|
-
# Returns the metadata such as name and content-type for a given attachment and email.
|
88
|
-
# @param attachment_id attachmentId
|
89
|
-
# @param email_id emailId
|
90
|
-
# @param [Hash] opts the optional parameters
|
91
|
-
# @return [AttachmentMetaData]
|
92
|
-
describe 'get_attachment_meta_data test' do
|
93
|
-
it 'should work' do
|
94
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
95
|
-
end
|
96
|
-
end
|
97
|
-
|
98
|
-
# unit tests for get_attachments
|
99
|
-
# Get all email attachment metadata
|
100
|
-
# Returns an array of attachment metadata such as name and content-type for a given email if present.
|
101
|
-
# @param email_id emailId
|
102
|
-
# @param [Hash] opts the optional parameters
|
103
|
-
# @return [Array<AttachmentMetaData>]
|
104
|
-
describe 'get_attachments test' do
|
105
|
-
it 'should work' do
|
106
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
107
|
-
end
|
108
|
-
end
|
109
|
-
|
110
|
-
# unit tests for get_email
|
111
|
-
# Get Email Content
|
112
|
-
# Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawMessage endpoint
|
113
|
-
# @param email_id emailId
|
114
|
-
# @param [Hash] opts the optional parameters
|
115
|
-
# @return [Email]
|
116
|
-
describe 'get_email test' do
|
117
|
-
it 'should work' do
|
118
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
119
|
-
end
|
120
|
-
end
|
121
|
-
|
122
|
-
# unit tests for get_emails_paginated
|
123
|
-
# Get all emails
|
124
|
-
# Responses are paginated
|
125
|
-
# @param [Hash] opts the optional parameters
|
126
|
-
# @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated
|
127
|
-
# @option opts [Integer] :page Optional page index in email list pagination
|
128
|
-
# @option opts [Integer] :size Optional page size in email list pagination
|
129
|
-
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
130
|
-
# @option opts [Boolean] :unread_only Optional filter for unread emails only
|
131
|
-
# @return [PageEmailProjection]
|
132
|
-
describe 'get_emails_paginated test' do
|
133
|
-
it 'should work' do
|
134
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
135
|
-
end
|
136
|
-
end
|
137
|
-
|
138
|
-
# unit tests for get_raw_email_contents
|
139
|
-
# Get Raw Email Content
|
140
|
-
# Returns a raw, unparsed and unprocessed email
|
141
|
-
# @param email_id emailId
|
142
|
-
# @param [Hash] opts the optional parameters
|
143
|
-
# @return [String]
|
144
|
-
describe 'get_raw_email_contents test' do
|
145
|
-
it 'should work' do
|
146
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
147
|
-
end
|
148
|
-
end
|
149
|
-
|
150
|
-
# unit tests for validate_email
|
151
|
-
# Validate email
|
152
|
-
# Validate HTML content of email
|
153
|
-
# @param email_id emailId
|
154
|
-
# @param [Hash] opts the optional parameters
|
155
|
-
# @return [ValidationDto]
|
156
|
-
describe 'validate_email test' do
|
157
|
-
it 'should work' do
|
158
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
159
|
-
end
|
160
|
-
end
|
161
|
-
|
162
|
-
end
|
@@ -1,54 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#MailSlurp API
|
3
|
-
|
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
|
-
|
6
|
-
The version of the OpenAPI document: d1659dc1567a5b62f65d0612107a50aace03e085
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.3
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'spec_helper'
|
14
|
-
require 'json'
|
15
|
-
|
16
|
-
# Unit tests for MailSlurpClient::FormControllerApi
|
17
|
-
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
-
# Please update as you see appropriate
|
19
|
-
describe 'FormControllerApi' do
|
20
|
-
before do
|
21
|
-
# run before each test
|
22
|
-
@api_instance = MailSlurpClient::FormControllerApi.new
|
23
|
-
end
|
24
|
-
|
25
|
-
after do
|
26
|
-
# run after each test
|
27
|
-
end
|
28
|
-
|
29
|
-
describe 'test an instance of FormControllerApi' do
|
30
|
-
it 'should create an instance of FormControllerApi' do
|
31
|
-
expect(@api_instance).to be_instance_of(MailSlurpClient::FormControllerApi)
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
# unit tests for submit_form
|
36
|
-
# Submit a form to be parsed and sent as an email to an address determined by the form fields
|
37
|
-
# This endpoint allows you to submit HTML forms and receive the field values and files via email. #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email. You must provide at-least a `_to` email address or a `_toAlias` email alias ID to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding `name` attributes or as URL query parameters such as `?_to=test@example.com` The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments. #### Submitting This endpoint accepts form submission via POST method. It accepts `application/x-www-form-urlencoded`, and `multipart/form-data` content-types. #### HTML Example ```html <form action=\"https://api.mailslurp.com/forms\" method=\"post\" > <input name=\"_to\" type=\"hidden\" value=\"test@example.com\"/> <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> ``` #### URL Example ```html <form action=\"https://api.mailslurp.com/forms?_toAlias=test@example.com\" method=\"post\" > <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> ``` The email address is specified by a `_to` field OR is extracted from an email alias specified by a `_toAlias` field (see the alias controller for more information). Endpoint accepts . You can specify a content type in HTML forms using the `enctype` attribute, for instance: `<form enctype=\"multipart/form-data\">`.
|
38
|
-
# @param [Hash] opts the optional parameters
|
39
|
-
# @option opts [String] :_email_address Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
|
40
|
-
# @option opts [String] :_redirect_to Optional URL to redirect form submitter to after submission. If not present user will see a success message.
|
41
|
-
# @option opts [String] :_spam_check Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
|
42
|
-
# @option opts [String] :_subject Optional subject of the email that will be sent.
|
43
|
-
# @option opts [String] :_success_message Optional success message to display if no _redirectTo present.
|
44
|
-
# @option opts [String] :_to The email address that submitted form should be sent to. Either this or _toAlias must be present for a form to be successfully submitted..
|
45
|
-
# @option opts [String] :_to_alias ID of an email alias to that form should be sent to. Aliases must be created before submission and can be used to hide an email address and reduce spam.
|
46
|
-
# @option opts [String] :other_parameters All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.
|
47
|
-
# @return [String]
|
48
|
-
describe 'submit_form test' do
|
49
|
-
it 'should work' do
|
50
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
51
|
-
end
|
52
|
-
end
|
53
|
-
|
54
|
-
end
|
@@ -1,126 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#MailSlurp API
|
3
|
-
|
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 ## Basic Concepts ### Inboxes Inboxes have real email addresses that can send and receive emails. You can create inboxes with specific email addresses (using custom domains). You can also use randomly assigned MailSlurp addresses as unique, disposable test addresses. See the InboxController or [inbox and email address guide](https://www.mailslurp.com/guides/) for more information. ### Receive Emails You can receive emails in a number of ways. You can fetch emails and attachments directly from an inbox. Or you can use `waitFor` endpoints to hold a connection open until an email is received that matches given criteria (such as subject or body content). You can also use webhooks to have emails from multiple inboxes forwarded to your server via HTTP POST. InboxController methods with `waitFor` in the name have a long timeout period and instruct MailSlurp to wait until an expected email is received. You can set conditions on email counts, subject or body matches, and more. Most receive methods only return an email ID and not the full email (to keep response sizes low). To fetch the full body or attachments for an email use the email's ID with EmailController endpoints. See the InboxController or [receiving emails guide](https://www.mailslurp.com/guides/) for more information. ### Send Emails You can send templated HTML emails in several ways. You must first create an inbox to send an email. An inbox can have a specific address or a randomly assigned one. You can send emails from an inbox using `to`, `cc`, and `bcc` recipient lists or with contacts and contact groups. Emails can contain plain-text or HTML bodies. You can also use email templates that support [moustache](https://mustache.github.io/) template variables. You can send attachments by first posting files to the AttachmentController and then using the returned IDs in the `attachments` field of the send options. See the InboxController or [sending emails guide](https://www.mailslurp.com/guides/) for more information. ### Templates MailSlurp emails support templates. You can create templates in the dashboard or API that contain [moustache](https://mustache.github.io/) style variables: for instance `Hello {{name}}`. Then when sending emails you can pass a map of variables names and values to be used. Additionally, when sending emails with contact groups you can use properties of the contact in your templates like `{{firstName}}` and `{{lastName}}`. > You can do a lot more with MailSlurp so see the included documentation for more information.
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.3
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'spec_helper'
|
14
|
-
require 'json'
|
15
|
-
|
16
|
-
# Unit tests for MailSlurpClient::GroupControllerApi
|
17
|
-
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
-
# Please update as you see appropriate
|
19
|
-
describe 'GroupControllerApi' do
|
20
|
-
before do
|
21
|
-
# run before each test
|
22
|
-
@api_instance = MailSlurpClient::GroupControllerApi.new
|
23
|
-
end
|
24
|
-
|
25
|
-
after do
|
26
|
-
# run after each test
|
27
|
-
end
|
28
|
-
|
29
|
-
describe 'test an instance of GroupControllerApi' do
|
30
|
-
it 'should create an instance of GroupControllerApi' do
|
31
|
-
expect(@api_instance).to be_instance_of(MailSlurpClient::GroupControllerApi)
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
# unit tests for add_contacts_to_group
|
36
|
-
# Add contacts to a group
|
37
|
-
# @param group_id groupId
|
38
|
-
# @param update_group_contacts_option updateGroupContactsOption
|
39
|
-
# @param [Hash] opts the optional parameters
|
40
|
-
# @return [GroupContactsDto]
|
41
|
-
describe 'add_contacts_to_group test' do
|
42
|
-
it 'should work' do
|
43
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
-
end
|
45
|
-
end
|
46
|
-
|
47
|
-
# unit tests for create_group
|
48
|
-
# Create a group
|
49
|
-
# @param create_group_options createGroupOptions
|
50
|
-
# @param [Hash] opts the optional parameters
|
51
|
-
# @return [GroupDto]
|
52
|
-
describe 'create_group test' do
|
53
|
-
it 'should work' do
|
54
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
55
|
-
end
|
56
|
-
end
|
57
|
-
|
58
|
-
# unit tests for delete_group
|
59
|
-
# Delete group
|
60
|
-
# @param group_id groupId
|
61
|
-
# @param [Hash] opts the optional parameters
|
62
|
-
# @return [nil]
|
63
|
-
describe 'delete_group test' do
|
64
|
-
it 'should work' do
|
65
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
66
|
-
end
|
67
|
-
end
|
68
|
-
|
69
|
-
# unit tests for get_all_groups
|
70
|
-
# Get all Contact Groups in paginated format
|
71
|
-
# @param [Hash] opts the optional parameters
|
72
|
-
# @option opts [Integer] :page Optional page index in inbox list pagination
|
73
|
-
# @option opts [Integer] :size Optional page size in inbox list pagination
|
74
|
-
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
75
|
-
# @return [PageGroupProjection]
|
76
|
-
describe 'get_all_groups test' do
|
77
|
-
it 'should work' do
|
78
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
79
|
-
end
|
80
|
-
end
|
81
|
-
|
82
|
-
# unit tests for get_group
|
83
|
-
# Get group
|
84
|
-
# @param group_id groupId
|
85
|
-
# @param [Hash] opts the optional parameters
|
86
|
-
# @return [GroupDto]
|
87
|
-
describe 'get_group test' do
|
88
|
-
it 'should work' do
|
89
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
90
|
-
end
|
91
|
-
end
|
92
|
-
|
93
|
-
# unit tests for get_group_with_contacts
|
94
|
-
# Get group and contacts belonging to it
|
95
|
-
# @param group_id groupId
|
96
|
-
# @param [Hash] opts the optional parameters
|
97
|
-
# @return [GroupContactsDto]
|
98
|
-
describe 'get_group_with_contacts test' do
|
99
|
-
it 'should work' do
|
100
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
101
|
-
end
|
102
|
-
end
|
103
|
-
|
104
|
-
# unit tests for get_groups
|
105
|
-
# Get all groups
|
106
|
-
# @param [Hash] opts the optional parameters
|
107
|
-
# @return [Array<GroupProjection>]
|
108
|
-
describe 'get_groups test' do
|
109
|
-
it 'should work' do
|
110
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
111
|
-
end
|
112
|
-
end
|
113
|
-
|
114
|
-
# unit tests for remove_contacts_from_group
|
115
|
-
# Remove contacts from a group
|
116
|
-
# @param group_id groupId
|
117
|
-
# @param update_group_contacts_option updateGroupContactsOption
|
118
|
-
# @param [Hash] opts the optional parameters
|
119
|
-
# @return [GroupContactsDto]
|
120
|
-
describe 'remove_contacts_from_group test' do
|
121
|
-
it 'should work' do
|
122
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
123
|
-
end
|
124
|
-
end
|
125
|
-
|
126
|
-
end
|
@@ -1,172 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#MailSlurp API
|
3
|
-
|
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 ## Basic Concepts ### Inboxes Inboxes have real email addresses that can send and receive emails. You can create inboxes with specific email addresses (using custom domains). You can also use randomly assigned MailSlurp addresses as unique, disposable test addresses. See the InboxController or [inbox and email address guide](https://www.mailslurp.com/guides/) for more information. ### Receive Emails You can receive emails in a number of ways. You can fetch emails and attachments directly from an inbox. Or you can use `waitFor` endpoints to hold a connection open until an email is received that matches given criteria (such as subject or body content). You can also use webhooks to have emails from multiple inboxes forwarded to your server via HTTP POST. InboxController methods with `waitFor` in the name have a long timeout period and instruct MailSlurp to wait until an expected email is received. You can set conditions on email counts, subject or body matches, and more. Most receive methods only return an email ID and not the full email (to keep response sizes low). To fetch the full body or attachments for an email use the email's ID with EmailController endpoints. See the InboxController or [receiving emails guide](https://www.mailslurp.com/guides/) for more information. ### Send Emails You can send templated HTML emails in several ways. You must first create an inbox to send an email. An inbox can have a specific address or a randomly assigned one. You can send emails from an inbox using `to`, `cc`, and `bcc` recipient lists or with contacts and contact groups. Emails can contain plain-text or HTML bodies. You can also use email templates that support [moustache](https://mustache.github.io/) template variables. You can send attachments by first posting files to the AttachmentController and then using the returned IDs in the `attachments` field of the send options. See the InboxController or [sending emails guide](https://www.mailslurp.com/guides/) for more information. ### Templates MailSlurp emails support templates. You can create templates in the dashboard or API that contain [moustache](https://mustache.github.io/) style variables: for instance `Hello {{name}}`. Then when sending emails you can pass a map of variables names and values to be used. Additionally, when sending emails with contact groups you can use properties of the contact in your templates like `{{firstName}}` and `{{lastName}}`. > You can do a lot more with MailSlurp so see the included documentation for more information.
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.2.3
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'spec_helper'
|
14
|
-
require 'json'
|
15
|
-
|
16
|
-
# Unit tests for MailSlurpClient::InboxControllerApi
|
17
|
-
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
-
# Please update as you see appropriate
|
19
|
-
describe 'InboxControllerApi' do
|
20
|
-
before do
|
21
|
-
# run before each test
|
22
|
-
@api_instance = MailSlurpClient::InboxControllerApi.new
|
23
|
-
end
|
24
|
-
|
25
|
-
after do
|
26
|
-
# run after each test
|
27
|
-
end
|
28
|
-
|
29
|
-
describe 'test an instance of InboxControllerApi' do
|
30
|
-
it 'should create an instance of InboxControllerApi' do
|
31
|
-
expect(@api_instance).to be_instance_of(MailSlurpClient::InboxControllerApi)
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
# unit tests for create_inbox
|
36
|
-
# Create an Inbox (email address)
|
37
|
-
# Create a new inbox and with a ranmdomized 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.
|
38
|
-
# @param [Hash] opts the optional parameters
|
39
|
-
# @option opts [String] :description Optional description for an inbox.
|
40
|
-
# @option opts [String] :email_address Optional email address including domain you wish inbox to use (eg: test123@mydomain.com). Only supports domains that you have registered and verified with MailSlurp using dashboard or `createDomain` method.
|
41
|
-
# @option opts [DateTime] :expires_at Optional expires at timestamp. If your plan supports this feature you can specify when an inbox should expire. If left empty inbox will exist permanently or expire when your plan dictates
|
42
|
-
# @option opts [Boolean] :favourite Is inbox favourited.
|
43
|
-
# @option opts [String] :name Optional name for an inbox.
|
44
|
-
# @option opts [Array<String>] :tags Optional tags for an inbox. Can be used for searching and filtering inboxes.
|
45
|
-
# @return [Inbox]
|
46
|
-
describe 'create_inbox test' do
|
47
|
-
it 'should work' do
|
48
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
49
|
-
end
|
50
|
-
end
|
51
|
-
|
52
|
-
# unit tests for delete_all_inboxes
|
53
|
-
# Delete all inboxes
|
54
|
-
# Permanently delete all inboxes and associated email addresses and all emails within the given inboxes
|
55
|
-
# @param [Hash] opts the optional parameters
|
56
|
-
# @return [nil]
|
57
|
-
describe 'delete_all_inboxes test' do
|
58
|
-
it 'should work' do
|
59
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
60
|
-
end
|
61
|
-
end
|
62
|
-
|
63
|
-
# unit tests for delete_inbox
|
64
|
-
# Delete Inbox / Email Address
|
65
|
-
# Permanently delete an inbox and associated email address and all emails within the given inboxes
|
66
|
-
# @param inbox_id inboxId
|
67
|
-
# @param [Hash] opts the optional parameters
|
68
|
-
# @return [nil]
|
69
|
-
describe 'delete_inbox test' do
|
70
|
-
it 'should work' do
|
71
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
72
|
-
end
|
73
|
-
end
|
74
|
-
|
75
|
-
# unit tests for get_all_inboxes
|
76
|
-
# List Inboxes Paginated
|
77
|
-
# List inboxes in paginated form. Allows for page index, page size, and sort direction. Can also filter by favourited or email address like pattern.
|
78
|
-
# @param [Hash] opts the optional parameters
|
79
|
-
# @option opts [Boolean] :favourite Optionally filter results for favourites only
|
80
|
-
# @option opts [Integer] :page Optional page index in inbox list pagination
|
81
|
-
# @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
|
82
|
-
# @option opts [Integer] :size Optional page size in inbox list pagination
|
83
|
-
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
84
|
-
# @return [PageInboxProjection]
|
85
|
-
describe 'get_all_inboxes test' do
|
86
|
-
it 'should work' do
|
87
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
88
|
-
end
|
89
|
-
end
|
90
|
-
|
91
|
-
# unit tests for get_emails
|
92
|
-
# Get emails in an Inbox
|
93
|
-
# 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
|
94
|
-
# @param inbox_id Id of inbox that emails belongs to
|
95
|
-
# @param [Hash] opts the optional parameters
|
96
|
-
# @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction
|
97
|
-
# @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
|
98
|
-
# @option opts [Integer] :retry_timeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned
|
99
|
-
# @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
|
100
|
-
# @option opts [String] :sort Sort the results by received date and direction ASC or DESC
|
101
|
-
# @return [Array<EmailPreview>]
|
102
|
-
describe 'get_emails test' do
|
103
|
-
it 'should work' do
|
104
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
105
|
-
end
|
106
|
-
end
|
107
|
-
|
108
|
-
# unit tests for get_inbox
|
109
|
-
# Get Inbox / EmailAddress
|
110
|
-
# Returns an inbox's properties, including its email address and ID.
|
111
|
-
# @param inbox_id inboxId
|
112
|
-
# @param [Hash] opts the optional parameters
|
113
|
-
# @return [Inbox]
|
114
|
-
describe 'get_inbox test' do
|
115
|
-
it 'should work' do
|
116
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
117
|
-
end
|
118
|
-
end
|
119
|
-
|
120
|
-
# unit tests for get_inbox_emails_paginated
|
121
|
-
# Get inbox emails paginated
|
122
|
-
# Get a paginated list of emails in an inbox. Does not hold connections open.
|
123
|
-
# @param inbox_id Id of inbox that emails belongs to
|
124
|
-
# @param [Hash] opts the optional parameters
|
125
|
-
# @option opts [Integer] :page Optional page index in inbox emails list pagination
|
126
|
-
# @option opts [Integer] :size Optional page size in inbox emails list pagination
|
127
|
-
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
128
|
-
# @return [PageEmailPreview]
|
129
|
-
describe 'get_inbox_emails_paginated test' do
|
130
|
-
it 'should work' do
|
131
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
132
|
-
end
|
133
|
-
end
|
134
|
-
|
135
|
-
# unit tests for get_inboxes
|
136
|
-
# List Inboxes / Email Addresses
|
137
|
-
# List the inboxes you have created
|
138
|
-
# @param [Hash] opts the optional parameters
|
139
|
-
# @return [Array<Inbox>]
|
140
|
-
describe 'get_inboxes test' do
|
141
|
-
it 'should work' do
|
142
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
143
|
-
end
|
144
|
-
end
|
145
|
-
|
146
|
-
# unit tests for send_email
|
147
|
-
# Send Email
|
148
|
-
# Send an email from the inbox's email address. Specify the email recipients and contents in the request body. See the `SendEmailOptions` for more information. Note the `inboxId` refers to the inbox's id NOT its email address
|
149
|
-
# @param inbox_id ID of the inbox you want to send the email from
|
150
|
-
# @param [Hash] opts the optional parameters
|
151
|
-
# @option opts [SendEmailOptions] :send_email_options Options for the email
|
152
|
-
# @return [nil]
|
153
|
-
describe 'send_email test' do
|
154
|
-
it 'should work' do
|
155
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
156
|
-
end
|
157
|
-
end
|
158
|
-
|
159
|
-
# unit tests for set_inbox_favourited
|
160
|
-
# Set inbox favourited state
|
161
|
-
# Set and return new favourite state for an inbox
|
162
|
-
# @param inbox_id inboxId
|
163
|
-
# @param set_inbox_favourited_options setInboxFavouritedOptions
|
164
|
-
# @param [Hash] opts the optional parameters
|
165
|
-
# @return [Inbox]
|
166
|
-
describe 'set_inbox_favourited test' do
|
167
|
-
it 'should work' do
|
168
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
169
|
-
end
|
170
|
-
end
|
171
|
-
|
172
|
-
end
|