Skip to content

\InboxControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
create_inbox post /inboxes 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_inbox_ruleset post /inboxes/{inboxId}/rulesets Create an inbox ruleset
create_inbox_with_defaults post /inboxes/withDefaults Create an inbox with default options. Uses MailSlurp domain pool address and is private.
create_inbox_with_options post /inboxes/withOptions Create an inbox with options. Extended options for inbox creation.
delete_all_inbox_emails delete /inboxes/{inboxId}/deleteAllInboxEmails Delete all emails in a given inboxes.
delete_all_inboxes delete /inboxes Delete all inboxes
delete_inbox delete /inboxes/{inboxId} Delete inbox
does_inbox_exist get /inboxes/exists Does inbox exist
flush_expired delete /inboxes/expired Remove expired inboxes
get_all_inboxes get /inboxes/paginated List All Inboxes Paginated
get_all_scheduled_jobs get /inboxes/scheduled-jobs Get all scheduled email sending jobs for account
get_delivery_statuses_by_inbox_id get /inboxes/{inboxId}/delivery-status
get_emails get /inboxes/{inboxId}/emails 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_smtp_access get /inboxes/imap-smtp-access
get_inbox get /inboxes/{inboxId} Get Inbox. Returns properties of an inbox.
get_inbox_by_email_address get /inboxes/byEmailAddress Search for an inbox with the provided email address
get_inbox_by_name get /inboxes/byName Search for an inbox with the given name
get_inbox_count get /inboxes/count Get total inbox count
get_inbox_email_count get /inboxes/{inboxId}/emails/count Get email count in inbox
get_inbox_emails_paginated get /inboxes/{inboxId}/emails/paginated Get inbox emails paginated
get_inbox_ids get /inboxes/ids Get all inbox IDs
get_inbox_sent_emails get /inboxes/{inboxId}/sent Get Inbox Sent Emails
get_inbox_tags get /inboxes/tags Get inbox tags
get_inboxes get /inboxes List Inboxes and email addresses
get_latest_email_in_inbox get /inboxes/getLatestEmail Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.
get_organization_inboxes get /inboxes/organization List Organization Inboxes Paginated
get_scheduled_jobs_by_inbox_id get /inboxes/{inboxId}/scheduled-jobs Get all scheduled email sending jobs for the inbox
list_inbox_rulesets get /inboxes/{inboxId}/rulesets List inbox rulesets
list_inbox_tracking_pixels get /inboxes/{inboxId}/tracking-pixels List inbox tracking pixels
send_email post /inboxes/{inboxId} Send Email
send_email_and_confirm post /inboxes/{inboxId}/confirm Send email and return sent confirmation
send_email_with_queue post /inboxes/{inboxId}/with-queue Send email with queue
send_smtp_envelope post /inboxes/{inboxId}/smtp-envelope Send email using an SMTP mail envelope and message body and return sent confirmation
send_test_email post /inboxes/{inboxId}/send-test-email Send a test email to inbox
send_with_schedule post /inboxes/{inboxId}/with-schedule Send email with with delay or schedule
set_inbox_favourited put /inboxes/{inboxId}/favourite Set inbox favourited state
update_inbox patch /inboxes/{inboxId} Update Inbox. Change name and description. Email address is not editable.

create_inbox

crate::models::InboxDto create_inbox(email_address, tags, name, description, use_domain_pool, favourite, expires_at, expires_in, allow_team_access, inbox_type, virtual_inbox) 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.

Parameters

Name Type Description Required Notes
email_address Option<String> A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as 123@mailslurp.com. If you use the useDomainPool option when the email address is null it will generate an email address with a more varied domain ending such as 123@mailslurp.info or 123@mailslurp.biz. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so SMTP inboxes will only work with SMTP type domains. Avoid SMTP inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
tags Option<Vec> Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
name Option<String> Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
description Option<String> Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
use_domain_pool Option<bool> Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default @mailslurp.com email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in @mailslurp.{world,info,xyz,...} . This means a TLD is randomly selecting from a list of .biz, .info, .xyz etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of @mailslurp.com or custom email address provided by the emailAddress field. Note this feature is only available for HTTP inbox types.
favourite Option<bool> Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
expires_at Option<String> Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
expires_in Option<i64> Number of milliseconds that inbox should exist for
allow_team_access Option<bool> DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
inbox_type Option<String> HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at mx.mailslurp.com.
virtual_inbox Option<bool> Virtual inbox prevents any outbound emails from being sent. It creates sent email records but will never send real emails to recipients. Great for testing and faking email sending.

Return type

crate::models::InboxDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

create_inbox_ruleset

crate::models::InboxRulesetDto create_inbox_ruleset(inbox_id, create_inbox_ruleset_options) Create an inbox ruleset

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

Parameters

Name Type Description Required Notes
inbox_id String inboxId [required]
create_inbox_ruleset_options CreateInboxRulesetOptions [required]

Return type

crate::models::InboxRulesetDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

create_inbox_with_defaults

crate::models::InboxDto create_inbox_with_defaults() Create an inbox with default options. Uses MailSlurp domain pool address and is private.

Parameters

This endpoint does not need any parameter.

Return type

crate::models::InboxDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

create_inbox_with_options

crate::models::InboxDto create_inbox_with_options(create_inbox_dto) 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.

Parameters

Name Type Description Required Notes
create_inbox_dto CreateInboxDto [required]

Return type

crate::models::InboxDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_all_inbox_emails

delete_all_inbox_emails(inbox_id) Delete all emails in a given inboxes.

Deletes all emails in an inbox. Be careful as emails cannot be recovered

Parameters

Name Type Description Required Notes
inbox_id String [required]

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_all_inboxes

delete_all_inboxes() 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.

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_inbox

delete_inbox(inbox_id) 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.

Parameters

Name Type Description Required Notes
inbox_id String [required]

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

does_inbox_exist

crate::models::InboxExistsDto does_inbox_exist(email_address) Does inbox exist

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

Parameters

Name Type Description Required Notes
email_address String Email address [required]

Return type

crate::models::InboxExistsDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

flush_expired

crate::models::FlushExpiredInboxesResult flush_expired(before) Remove expired inboxes

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

Parameters

Name Type Description Required Notes
before Option<String> Optional expired at before flag to flush expired inboxes that have expired before the given time

Return type

crate::models::FlushExpiredInboxesResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_all_inboxes

crate::models::PageInboxProjection get_all_inboxes(page, size, sort, favourite, search, tag, team_access, since, before, inbox_type, domain_id) 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 (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.

Parameters

Name Type Description Required Notes
page Option<i32> Optional page in list pagination [default to 0]
size Option<i32> Optional page size in list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
favourite Option<bool> Optionally filter results for favourites only [default to false]
search Option<String> Optionally filter by search words partial matching ID, tags, name, and email address
tag Option<String> Optionally filter by tags. Will return inboxes that include given tags
team_access Option<bool> DEPRECATED. Optionally filter by team access.
since Option<String> Optional filter by created after given date time
before Option<String> Optional filter by created before given date time
inbox_type Option<String> Optional filter by inbox type
domain_id Option<String> Optional domain ID filter

Return type

crate::models::PageInboxProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_all_scheduled_jobs

crate::models::PageScheduledJobs get_all_scheduled_jobs(page, size, sort, since, before) Get all scheduled email sending jobs for account

Schedule sending of emails using scheduled jobs. These can be inbox or account level.

Parameters

Name Type Description Required Notes
page Option<i32> Optional page in scheduled job list pagination [default to 0]
size Option<i32> Optional page size in scheduled job list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageScheduledJobs

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_delivery_statuses_by_inbox_id

crate::models::PageDeliveryStatus get_delivery_statuses_by_inbox_id(inbox_id, page, size, sort, since, before)

Get all email delivery statuses for an inbox

Parameters

Name Type Description Required Notes
inbox_id String [required]
page Option<i32> Optional page in delivery status list pagination [default to 0]
size Option<i32> Optional page size in delivery status list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageDeliveryStatus

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_emails

Vec get_emails(inbox_id, size, limit, sort, retry_timeout, delay_timeout, min_count, unread_only, before, since) 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

Parameters

Name Type Description Required Notes
inbox_id String Id of inbox that emails belongs to [required]
size Option<i32> Alias for limit. Assessed first before assessing any passed limit.
limit Option<i32> Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
sort Option<String> Sort the results by received date and direction ASC or DESC
retry_timeout Option<i64> Maximum milliseconds to spend retrying inbox database until minCount emails are returned
delay_timeout Option<i64>
min_count Option<i64> Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
unread_only Option<bool>
before Option<String> Exclude emails received after this ISO 8601 date time
since Option<String> Exclude emails received before this ISO 8601 date time

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_imap_smtp_access

crate::models::ImapSmtpAccessDetails get_imap_smtp_access(inbox_id)

Get IMAP and SMTP access usernames and passwords

Parameters

Name Type Description Required Notes
inbox_id Option<String> Inbox ID

Return type

crate::models::ImapSmtpAccessDetails

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox

crate::models::InboxDto get_inbox(inbox_id) Get Inbox. Returns properties of an inbox.

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

Parameters

Name Type Description Required Notes
inbox_id String [required]

Return type

crate::models::InboxDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_by_email_address

crate::models::InboxByEmailAddressResult get_inbox_by_email_address(email_address) Search for an inbox with the provided email address

Get a inbox result by email address

Parameters

Name Type Description Required Notes
email_address String [required]

Return type

crate::models::InboxByEmailAddressResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_by_name

crate::models::InboxByNameResult get_inbox_by_name(name) Search for an inbox with the given name

Get a inbox result by name

Parameters

Name Type Description Required Notes
name String [required]

Return type

crate::models::InboxByNameResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_count

crate::models::CountDto get_inbox_count() Get total inbox count

Parameters

This endpoint does not need any parameter.

Return type

crate::models::CountDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_email_count

crate::models::CountDto get_inbox_email_count(inbox_id) Get email count in inbox

Parameters

Name Type Description Required Notes
inbox_id String Id of inbox that emails belongs to [required]

Return type

crate::models::CountDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_emails_paginated

crate::models::PageEmailPreview get_inbox_emails_paginated(inbox_id, page, size, sort, since, before) Get inbox emails paginated

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

Parameters

Name Type Description Required Notes
inbox_id String Id of inbox that emails belongs to [required]
page Option<i32> Optional page in inbox emails list pagination [default to 0]
size Option<i32> Optional page size in inbox emails list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
since Option<String> Optional filter by received after given date time
before Option<String> Optional filter by received before given date time

Return type

crate::models::PageEmailPreview

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_ids

crate::models::InboxIdsResult get_inbox_ids() Get all inbox IDs

Get list of inbox IDs

Parameters

This endpoint does not need any parameter.

Return type

crate::models::InboxIdsResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_sent_emails

crate::models::PageSentEmailProjection get_inbox_sent_emails(inbox_id, page, size, sort, search_filter, since, before) 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.

Parameters

Name Type Description Required Notes
inbox_id String [required]
page Option<i32> Optional page in inbox sent email list pagination [default to 0]
size Option<i32> Optional page size in inbox sent email list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
search_filter Option<String> Optional sent email search
since Option<String> Optional filter by sent after given date time
before Option<String> Optional filter by sent before given date time

Return type

crate::models::PageSentEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inbox_tags

Vec get_inbox_tags() Get inbox tags

Get all inbox tags

Parameters

This endpoint does not need any parameter.

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_inboxes

Vec get_inboxes(size, sort, since, before) List Inboxes and email addresses

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.

Parameters

Name Type Description Required Notes
size Option<i32> Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated getAllEmails for larger queries. [default to 100]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
since Option<String> Optional filter by created after given date time
before Option<String> Optional filter by created before given date time

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_latest_email_in_inbox

crate::models::Email get_latest_email_in_inbox(inbox_id, timeout_millis) 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

Parameters

Name Type Description Required Notes
inbox_id String ID of the inbox you want to get the latest email from [required]
timeout_millis i64 Timeout milliseconds to wait for latest email [required]

Return type

crate::models::Email

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_organization_inboxes

crate::models::PageOrganizationInboxProjection get_organization_inboxes(page, size, sort, search_filter, since, before) 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 (zero based), page size (how many results to return), and a sort direction (based on createdAt time).

Parameters

Name Type Description Required Notes
page Option<i32> Optional page in list pagination [default to 0]
size Option<i32> Optional page size in list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
search_filter Option<String> Optional search filter
since Option<String> Optional filter by created after given date time
before Option<String> Optional filter by created before given date time

Return type

crate::models::PageOrganizationInboxProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_scheduled_jobs_by_inbox_id

crate::models::PageScheduledJobs get_scheduled_jobs_by_inbox_id(inbox_id, page, size, sort, since, before) Get all scheduled email sending jobs for the inbox

Schedule sending of emails using scheduled jobs.

Parameters

Name Type Description Required Notes
inbox_id String [required]
page Option<i32> Optional page in scheduled job list pagination [default to 0]
size Option<i32> Optional page size in scheduled job list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageScheduledJobs

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

list_inbox_rulesets

crate::models::PageInboxRulesetDto list_inbox_rulesets(inbox_id, page, size, sort, search_filter, since, before) List inbox rulesets

List all rulesets attached to an inbox

Parameters

Name Type Description Required Notes
inbox_id String [required]
page Option<i32> Optional page in inbox ruleset list pagination [default to 0]
size Option<i32> Optional page size in inbox ruleset list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
search_filter Option<String> Optional search filter
since Option<String> Optional filter by created after given date time
before Option<String> Optional filter by created before given date time

Return type

crate::models::PageInboxRulesetDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

list_inbox_tracking_pixels

crate::models::PageTrackingPixelProjection list_inbox_tracking_pixels(inbox_id, page, size, sort, search_filter, since, before) List inbox tracking pixels

List all tracking pixels sent from an inbox

Parameters

Name Type Description Required Notes
inbox_id String [required]
page Option<i32> Optional page in inbox tracking pixel list pagination [default to 0]
size Option<i32> Optional page size in inbox tracking pixel list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
search_filter Option<String> Optional search filter
since Option<String> Optional filter by created after given date time
before Option<String> Optional filter by created before given date time

Return type

crate::models::PageTrackingPixelProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

send_email

send_email(inbox_id, send_email_options) 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.

Parameters

Name Type Description Required Notes
inbox_id String ID of the inbox you want to send the email from [required]
send_email_options SendEmailOptions [required]

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

send_email_and_confirm

crate::models::SentEmailDto send_email_and_confirm(inbox_id, send_email_options) 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.

Parameters

Name Type Description Required Notes
inbox_id String ID of the inbox you want to send the email from [required]
send_email_options SendEmailOptions [required]

Return type

crate::models::SentEmailDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

send_email_with_queue

send_email_with_queue(inbox_id, validate_before_enqueue, send_email_options) 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.

Parameters

Name Type Description Required Notes
inbox_id String ID of the inbox you want to send the email from [required]
validate_before_enqueue bool Validate before adding to queue [required]
send_email_options SendEmailOptions [required]

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

send_smtp_envelope

crate::models::SentEmailDto send_smtp_envelope(inbox_id, send_smtp_envelope_options) 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.

Parameters

Name Type Description Required Notes
inbox_id String ID of the inbox you want to send the email from [required]
send_smtp_envelope_options SendSmtpEnvelopeOptions [required]

Return type

crate::models::SentEmailDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

send_test_email

send_test_email(inbox_id) Send a test email to inbox

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

Parameters

Name Type Description Required Notes
inbox_id String [required]

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

send_with_schedule

send_with_schedule(inbox_id, send_email_options, send_at_timestamp, send_at_now_plus_seconds, validate_before_enqueue) 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.

Parameters

Name Type Description Required Notes
inbox_id String ID of the inbox you want to send the email from [required]
send_email_options SendEmailOptions [required]
send_at_timestamp Option<String> Sending timestamp
send_at_now_plus_seconds Option<i64> Send after n seconds
validate_before_enqueue Option<bool> Validate before adding to queue

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

set_inbox_favourited

crate::models::InboxDto set_inbox_favourited(inbox_id, set_inbox_favourited_options) Set inbox favourited state

Set and return new favourite state for an inbox

Parameters

Name Type Description Required Notes
inbox_id String ID of inbox to set favourite state [required]
set_inbox_favourited_options SetInboxFavouritedOptions [required]

Return type

crate::models::InboxDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

update_inbox

crate::models::InboxDto update_inbox(inbox_id, update_inbox_options) Update Inbox. Change name and description. Email address is not editable.

Update editable fields on an inbox

Parameters

Name Type Description Required Notes
inbox_id String [required]
update_inbox_options UpdateInboxOptions [required]

Return type

crate::models::InboxDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]