Module mailslurp::apis::inbox_controller_api [−][src]
Structs
struct for passing parameters to the method create_inbox
struct for passing parameters to the method create_inbox_ruleset
struct for passing parameters to the method create_inbox_with_options
struct for passing parameters to the method delete_inbox
struct for passing parameters to the method get_all_inboxes
struct for passing parameters to the method get_emails
struct for passing parameters to the method get_inbox_emails_paginated
struct for passing parameters to the method get_inbox
struct for passing parameters to the method get_inbox_sent_emails
struct for passing parameters to the method get_inboxes
struct for passing parameters to the method get_organization_inboxes
struct for passing parameters to the method list_inbox_rulesets
struct for passing parameters to the method list_inbox_tracking_pixels
struct for passing parameters to the method send_email_and_confirm
struct for passing parameters to the method send_email
struct for passing parameters to the method send_test_email
struct for passing parameters to the method set_inbox_favourited
struct for passing parameters to the method update_inbox
Enums
struct for typed errors of method create_inbox
struct for typed errors of method create_inbox_ruleset
struct for typed errors of method create_inbox_with_defaults
struct for typed errors of method create_inbox_with_options
struct for typed errors of method delete_all_inboxes
struct for typed errors of method delete_inbox
struct for typed errors of method get_all_inboxes
struct for typed errors of method get_emails
struct for typed errors of method get_inbox_emails_paginated
struct for typed errors of method get_inbox
struct for typed errors of method get_inbox_sent_emails
struct for typed errors of method get_inbox_tags
struct for typed errors of method get_inboxes
struct for typed errors of method get_organization_inboxes
struct for typed errors of method list_inbox_rulesets
struct for typed errors of method list_inbox_tracking_pixels
struct for typed errors of method send_email_and_confirm
struct for typed errors of method send_email
struct for typed errors of method send_test_email
struct for typed errors of method set_inbox_favourited
struct for typed errors of method update_inbox
Functions
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 a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
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.
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.
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.
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
Returns an inbox’s properties, including its email address and ID.
Get a paginated list of emails in an inbox. Does not hold connections open.
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 all inbox tags
List the inboxes you have created. Note use of the more advanced getAllEmails is recommended and allows paginated access using a limit and sort parameter.
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).
List all rulesets attached to an inbox
List all tracking pixels sent from an inbox
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.
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.
Send an inbox a test email to test email receiving is working
Set and return new favourite state for an inbox
Update editable fields on an inbox