Module mailslurp::apis::inbox_controller_api [−][src]
Structs
CreateInboxParams | struct for passing parameters to the method |
CreateInboxWithOptionsParams | struct for passing parameters to the method |
DeleteInboxParams | struct for passing parameters to the method |
GetAllInboxesParams | struct for passing parameters to the method |
GetEmailsParams | struct for passing parameters to the method |
GetInboxEmailsPaginatedParams | struct for passing parameters to the method |
GetInboxParams | struct for passing parameters to the method |
GetInboxSentEmailsParams | struct for passing parameters to the method |
GetInboxesParams | struct for passing parameters to the method |
GetOrganizationInboxesParams | struct for passing parameters to the method |
SendEmailAndConfirmParams | struct for passing parameters to the method |
SendEmailParams | struct for passing parameters to the method |
SetInboxFavouritedParams | struct for passing parameters to the method |
UpdateInboxParams | struct for passing parameters to the method |
Enums
CreateInboxError | struct for typed errors of method |
CreateInboxWithOptionsError | struct for typed errors of method |
DeleteAllInboxesError | struct for typed errors of method |
DeleteInboxError | struct for typed errors of method |
GetAllInboxesError | struct for typed errors of method |
GetEmailsError | struct for typed errors of method |
GetInboxEmailsPaginatedError | struct for typed errors of method |
GetInboxError | struct for typed errors of method |
GetInboxSentEmailsError | struct for typed errors of method |
GetInboxTagsError | struct for typed errors of method |
GetInboxesError | struct for typed errors of method |
GetOrganizationInboxesError | struct for typed errors of method |
SendEmailAndConfirmError | struct for typed errors of method |
SendEmailError | struct for typed errors of method |
SetInboxFavouritedError | struct for typed errors of method |
UpdateInboxError | struct for typed errors of method |
Functions
create_inbox | 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. |
create_inbox_with_options | Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. |
delete_all_inboxes | Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. |
delete_inbox | Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. |
get_all_inboxes | List inboxes in paginated form. The results are available on the |
get_emails | 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 |
get_inbox | Returns an inbox’s properties, including its email address and ID. |
get_inbox_emails_paginated | Get a paginated list of emails in an inbox. Does not hold connections open. |
get_inbox_sent_emails | Returns an inbox’s sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead. |
get_inbox_tags | Get all inbox tags |
get_inboxes | List the inboxes you have created. Note use of the more advanced |
get_organization_inboxes | List organization inboxes in paginated form. These are inboxes created with |
send_email | Send an email from an inbox’s email address. The request body should contain the |
send_email_and_confirm | Sister method for standard |
set_inbox_favourited | Set and return new favourite state for an inbox |
update_inbox | Update editable fields on an inbox |