Class InboxControllerApi

Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete. Cancel a scheduled email job

Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete. Cancel a scheduled email job

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 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.

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 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.

Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving Create an inbox ruleset

Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving Create an inbox ruleset

Create an inbox with default options. Uses MailSlurp domain pool address and is private.

Create an inbox with default options. Uses MailSlurp domain pool address and is private.

Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. Create an inbox with options. Extended options for inbox creation.

Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. Create an inbox with options. Extended options for inbox creation.

Deletes all emails in an inbox. Be careful as emails cannot be recovered Delete all emails in a given inboxes.

Deletes all emails in an inbox. Be careful as emails cannot be recovered Delete all emails in a given 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 all inboxes

Permanently delete all inboxes by description Delete inboxes by description

Permanently delete all inboxes by description Delete inboxes by description

Permanently delete all inboxes by name Delete inboxes by name

Permanently delete all inboxes by name Delete inboxes by name

Permanently delete all inboxes by tag Delete inboxes by tag

Permanently delete all inboxes by tag Delete inboxes by tag

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 all inboxes

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. 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. Delete inbox

Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses Does inbox exist

Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses Does inbox exist

Check if an inbox has automations. Does inbox have automations

Check if an inbox has automations. Does inbox have automations

Remove any expired inboxes for your account (instead of waiting for scheduled removal on server) Remove expired inboxes

Remove any expired inboxes for your account (instead of waiting for scheduled removal on server) Remove expired 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. List All Inboxes Paginated

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 All Inboxes Offset Paginated

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 All Inboxes Offset Paginated

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 All Inboxes Paginated

Returns paginated list of all plus alias addresses found for in account based on received emails that used the inbox address with a +xyz alias. Get all sub address plus address aliases for an inbox

Returns paginated list of all plus alias addresses found for in account based on received emails that used the inbox address with a +xyz alias. Get all sub address plus address aliases for an inbox

Schedule sending of emails using scheduled jobs. These can be inbox or account level. Get all scheduled email sending jobs for account

Schedule sending of emails using scheduled jobs. These can be inbox or account level. Get all scheduled email sending jobs for account

Get all email delivery statuses for an inbox

Get all email delivery statuses for an inbox

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 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.

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 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.

Get IMAP access usernames and passwords

Get IMAP access usernames and passwords

Get IMAP and SMTP access usernames and passwords

Get IMAP and SMTP access details in .env format

Get IMAP and SMTP access details in .env format

Get IMAP and SMTP access usernames and passwords

Get IMAP and SMTP server hosts

Get IMAP and SMTP server hosts

Returns an inbox's properties, including its email address and ID. Get Inbox. Returns properties of an inbox.

Get a inbox result by email address Search for an inbox with the provided email address

Get a inbox result by email address Search for an inbox with the provided email address

Get a inbox result by name Search for an inbox with the given name

Get a inbox result by name Search for an inbox with the given name

Get total inbox count

Get total inbox count

Get email count in inbox

Get email count in inbox

Get a paginated list of emails in an inbox. Does not hold connections open. Get inbox emails paginated

Get a paginated list of emails in an inbox. Does not hold connections open. Get inbox emails paginated

Get list of inbox IDs Get all inbox IDs

Get list of inbox IDs Get all inbox IDs

Returns a plus address object based on emails that used the inbox address with a +xyz alias. Get sub address plus address for an inbox

Returns a plus address object based on emails that used the inbox address with a +xyz alias. Get sub address plus address by ID

Returns a plus address object based on emails that used the inbox address with a +xyz alias. Get sub address plus address by ID

Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias. Get emails for a given inbox plus address

Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias. Get emails for a given inbox plus address

Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias. Get emails for a given inbox plus address

Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias. Get emails for a given inbox plus address

Returns a plus address object based on emails that used the inbox address with a +xyz alias. Get sub address plus address for an inbox

Returns paginated list of all plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias. Get sub address plus address aliases for an inbox

Returns paginated list of all plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias. Get sub address plus address aliases for an inbox

Returns an inbox's properties, including its email address and ID. Get Inbox. Returns properties of an inbox.

Get sent email count in inbox

Get sent email count in inbox

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 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 Sent Emails

Get all inbox tags Get inbox tags

Get all inbox tags paginated Get inbox tags paginated

Get all inbox tags paginated Get inbox tags paginated

Get all inbox tags Get inbox tags

List the inboxes you have created. Note use of the more advanced getAllInboxes is recommended and allows paginated access using a limit and sort parameter. List Inboxes and email addresses

Get all inboxes for a given inbox tag Get inboxes for a tag

Get all inboxes for a given inbox tag Get inboxes for a tag

List the inboxes you have created. Note use of the more advanced getAllInboxes is recommended and allows paginated access using a limit and sort parameter. List Inboxes and email addresses

Get the newest email in an inbox or wait for one to arrive Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.

Get the newest email in an inbox or wait for one to arrive Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.

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 Organization Inboxes Paginated

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 Organization Inboxes Paginated

List inboxes that have sent emails List all inboxes with sent emails

List inboxes that have sent emails List all inboxes with sent emails

Get a scheduled email job details. Get a scheduled email job

Get a scheduled email job details. Get a scheduled email job

Schedule sending of emails using scheduled jobs. Get all scheduled email sending jobs for the inbox

Schedule sending of emails using scheduled jobs. Get all scheduled email sending jobs for the inbox

Get SMTP access usernames and passwords

Get SMTP access usernames and passwords

Returns whether an email address is available Is email address available

Returns whether an email address is available Is email address available

List all rulesets attached to an inbox List inbox rulesets

List all rulesets attached to an inbox List inbox rulesets

List all tracking pixels sent from an inbox List inbox tracking pixels

List all tracking pixels sent from an inbox List inbox tracking pixels

Search inboxes and return 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. Search all inboxes and return matching inboxes

Search inboxes and return 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. Search all inboxes and return matching inboxes

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

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 email and return sent confirmation

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 email and return sent confirmation

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

Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. Send email with queue

Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. Send email with queue

Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY. Send email using an SMTP mail envelope and message body and return sent confirmation

Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY. Send email using an SMTP mail envelope and message body and return sent confirmation

Send an inbox a test email to test email receiving is working Send a test email to inbox

Send an inbox a test email to test email receiving is working Send a test email to inbox

Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending. Send email with with delay or schedule

Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending. Send email with with delay or schedule

Set and return new favorite state for an inbox Set inbox favourited state

Set and return new favorite state for an inbox Set inbox favourited state

Update IMAP access usernames and passwords

Update IMAP access usernames and passwords

Update editable fields on an inbox Update Inbox. Change name and description. Email address is not editable.

Update editable fields on an inbox Update Inbox. Change name and description. Email address is not editable.

Update SMTP access usernames and passwords

Update SMTP access usernames and passwords