Module mailslurp::apis::inbox_controller_api

Structs

CreateInboxParams	struct for passing parameters to the method create_inbox
CreateInboxWithOptionsParams	struct for passing parameters to the method create_inbox_with_options
DeleteInboxParams	struct for passing parameters to the method delete_inbox
GetAllInboxesParams	struct for passing parameters to the method get_all_inboxes
GetEmailsParams	struct for passing parameters to the method get_emails
GetInboxEmailsPaginatedParams	struct for passing parameters to the method get_inbox_emails_paginated
GetInboxParams	struct for passing parameters to the method get_inbox
GetInboxSentEmailsParams	struct for passing parameters to the method get_inbox_sent_emails
GetInboxesParams	struct for passing parameters to the method get_inboxes
GetOrganizationInboxesParams	struct for passing parameters to the method get_organization_inboxes
SendEmailAndConfirmParams	struct for passing parameters to the method send_email_and_confirm
SendEmailParams	struct for passing parameters to the method send_email
SetInboxFavouritedParams	struct for passing parameters to the method set_inbox_favourited
UpdateInboxParams	struct for passing parameters to the method update_inbox

Enums

CreateInboxError	struct for typed errors of method create_inbox
CreateInboxWithOptionsError	struct for typed errors of method create_inbox_with_options
DeleteAllInboxesError	struct for typed errors of method delete_all_inboxes
DeleteInboxError	struct for typed errors of method delete_inbox
GetAllInboxesError	struct for typed errors of method get_all_inboxes
GetEmailsError	struct for typed errors of method get_emails
GetInboxEmailsPaginatedError	struct for typed errors of method get_inbox_emails_paginated
GetInboxError	struct for typed errors of method get_inbox
GetInboxSentEmailsError	struct for typed errors of method get_inbox_sent_emails
GetInboxTagsError	struct for typed errors of method get_inbox_tags
GetInboxesError	struct for typed errors of method get_inboxes
GetOrganizationInboxesError	struct for typed errors of method get_organization_inboxes
SendEmailAndConfirmError	struct for typed errors of method send_email_and_confirm
SendEmailError	struct for typed errors of method send_email
SetInboxFavouritedError	struct for typed errors of method set_inbox_favourited
UpdateInboxError	struct for typed errors of method update_inbox

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 content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results. Results do not include team access inboxes by default. Use organization method to list team inboxes or set teamAccess to true.
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 minCount parameter. The server will retry the inbox database until the minCount is satisfied or the retryTimeout is reached
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 getAllEmails is recommended. You can provide a limit and sort parameter.
get_organization_inboxes	List organization inboxes in paginated form. These are inboxes created with allowTeamAccess flag enabled. Organization inboxes are readOnly for non-admin users. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
send_email	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.
send_email_and_confirm	Sister method for standard sendEmail method with the benefit of returning a SentEmail entity confirming the successful sending of the email with link the the sent object created for it.
set_inbox_favourited	Set and return new favourite state for an inbox
update_inbox	Update editable fields on an inbox