EmailControllerApi

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

MethodHTTP requestDescription
delete_all_emailsdelete /emailsDelete all emails in all inboxes.
delete_emaildelete /emails/{emailId}Delete an email
download_attachmentget /emails/{emailId}/attachments/{attachmentId}Get email attachment bytes. Returned as octet-stream with content type header. If you have trouble with byte responses try the downloadAttachmentBase64 response endpoints and convert the base 64 encoded content to a file or string.
download_attachment_base64get /emails/{emailId}/attachments/{attachmentId}/base64Get email attachment as base64 encoded string as an alternative to binary responses. Decode the base64FileContents as a utf-8 encoded string or array of bytes depending on the contentType.
download_bodyget /emails/{emailId}/bodyGet email body as string. Returned as plain/text with content type header.
download_body_bytesget /emails/{emailId}/body-bytesGet email body in bytes. Returned as octet-stream with content type header.
forward_emailpost /emails/{emailId}/forwardForward email to recipients
get_attachment_meta_dataget /emails/{emailId}/attachments/{attachmentId}/metadataGet email attachment metadata. This is the contentType and contentLength of an attachment. To get the individual attachments use the downloadAttachment methods.
get_attachments1get /emails/{emailId}/attachmentsGet all email attachment metadata. Metadata includes name and size of attachments.
get_emailget /emails/{emailId}Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
get_email_content_matchpost /emails/{emailId}/contentMatchGet email content regex pattern match results. Runs regex against email body and returns match groups.
get_email_htmlget /emails/{emailId}/htmlGet email content as HTML. For displaying emails in browser context.
get_email_html_queryget /emails/{emailId}/htmlQueryParse and return text from an email, stripping HTML and decoding encoded characters
get_email_linksget /emails/{emailId}/linksParse and return list of links found in an email (only works for HTML content)
get_email_text_linesget /emails/{emailId}/textLinesParse and return text from an email, stripping HTML and decoding encoded characters
get_emails_paginatedget /emailsGet all emails in all inboxes in paginated form. Email API list all.
get_gravatar_url_for_email_addressget /emails/gravatarForGet gravatar url for email address
get_latest_emailget /emails/latestGet latest email in all inboxes. Most recently received.
get_latest_email_in_inboxget /emails/latestInGet latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.
get_organization_emails_paginatedget /emails/organizationGet all organization emails. List team or shared test email accounts
get_raw_email_contentsget /emails/{emailId}/rawGet raw email string. Returns unparsed raw SMTP message with headers and body.
get_raw_email_jsonget /emails/{emailId}/raw/jsonGet raw email in JSON. Unparsed SMTP message in JSON wrapper format.
get_unread_email_countget /emails/unreadCountGet unread email count
mark_as_readpatch /emails/{emailId}/readMark an email as read on unread
reply_to_emailput /emails/{emailId}Reply to an email
send_email_source_optionalpost /emailsSend email
validate_emailpost /emails/{emailId}/validateValidate email HTML contents

delete_all_emails

delete_all_emails() Delete all emails in all inboxes.

Deletes all emails in your account. Be careful as emails cannot be recovered

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_email

delete_email(email_id) Delete an email

Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email to delete[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 ]

download_attachment

String download_attachment(attachment_id, email_id, api_key) Get email attachment bytes. Returned as octet-stream with content type header. If you have trouble with byte responses try the downloadAttachmentBase64 response endpoints and convert the base 64 encoded content to a file or string.

Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

Parameters

NameTypeDescriptionRequiredNotes
attachment_idStringID of attachment[required]
email_idStringID of email[required]
api_keyOption<String>Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly.

Return type

String

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

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

download_attachment_base64

crate::models::DownloadAttachmentDto download_attachment_base64(attachment_id, email_id) Get email attachment as base64 encoded string as an alternative to binary responses. Decode the base64FileContents as a utf-8 encoded string or array of bytes depending on the contentType.

Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the downloadAttachment method but allows some clients to get around issues with binary responses.

Parameters

NameTypeDescriptionRequiredNotes
attachment_idStringID of attachment[required]
email_idStringID of email[required]

Return type

crate::models::DownloadAttachmentDto

Authorization

API_KEY

HTTP request headers

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

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

download_body

String download_body(email_id) Get email body as string. Returned as plain/text with content type header.

Returns the specified email body for a given email as a string

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email[required]

Return type

String

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html, text/plain

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

download_body_bytes

String download_body_bytes(email_id) Get email body in bytes. Returned as octet-stream with content type header.

Returns the specified email body for a given email as a stream / array of bytes.

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email[required]

Return type

String

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

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

forward_email

crate::models::SentEmailDto forward_email(email_id, forward_email_options) Forward email to recipients

Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the from option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email[required]
forward_email_optionsForwardEmailOptionsforwardEmailOptions[required]

Return type

crate::models::SentEmailDto

Authorization

API_KEY

HTTP request headers

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

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

get_attachment_meta_data

crate::models::AttachmentMetaData get_attachment_meta_data(attachment_id, email_id) Get email attachment metadata. This is the contentType and contentLength of an attachment. To get the individual attachments use the downloadAttachment methods.

Returns the metadata such as name and content-type for a given attachment and email.

Parameters

NameTypeDescriptionRequiredNotes
attachment_idStringID of attachment[required]
email_idStringID of email[required]

Return type

crate::models::AttachmentMetaData

Authorization

API_KEY

HTTP request headers

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

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

get_attachments1

Veccrate::models::AttachmentMetaData get_attachments1(email_id) Get all email attachment metadata. Metadata includes name and size of attachments.

Returns an array of attachment metadata such as name and content-type for a given email if present.

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email[required]

Return type

Veccrate::models::AttachmentMetaData

Authorization

API_KEY

HTTP request headers

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

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

get_email

crate::models::Email get_email(email_id, decode) Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.

Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints

Parameters

NameTypeDescriptionRequiredNotes
email_idStringemailId[required]
decodeOption<bool>Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance =D7). This can be a pain for testing[default to false]

Return type

crate::models::Email

Authorization

API_KEY

HTTP request headers

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

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

get_email_content_match

crate::models::EmailContentMatchResult get_email_content_match(email_id, content_match_options) Get email content regex pattern match results. Runs regex against email body and returns match groups.

Return the matches for a given Java style regex pattern. Do not include the typical / at start or end of regex in some languages. Given an example your code is: 12345 the pattern to extract match looks like code is: (d{6}). This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: ['code is: 123456', '123456'] See https://docs.oracle.com/javase/8/docs/api/java/util/regex/ for more information of available patterns.

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email to match against[required]
content_match_optionsContentMatchOptionscontentMatchOptions[required]

Return type

crate::models::EmailContentMatchResult

Authorization

API_KEY

HTTP request headers

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

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

get_email_html

String get_email_html(email_id, decode) Get email content as HTML. For displaying emails in browser context.

Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: ?apiKey=xxx

Parameters

NameTypeDescriptionRequiredNotes
email_idStringemailId[required]
decodeOption<bool>decode[default to false]

Return type

String

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

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

get_email_html_query

crate::models::EmailTextLinesResult get_email_html_query(email_id, html_selector) Parse and return text from an email, stripping HTML and decoding encoded characters

Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email to perform HTML query on[required]
html_selectorOption<String>HTML selector to search for. Uses JQuery/JSoup/CSS style selector like ‘.my-div’ to match content. See https://jsoup.org/apidocs/org/jsoup/select/ for more information.

Return type

crate::models::EmailTextLinesResult

Authorization

API_KEY

HTTP request headers

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

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

crate::models::EmailLinksResult get_email_links(email_id) Parse and return list of links found in an email (only works for HTML content)

HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email to fetch text for[required]

Return type

crate::models::EmailLinksResult

Authorization

API_KEY

HTTP request headers

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

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

get_email_text_lines

crate::models::EmailTextLinesResult get_email_text_lines(email_id, decode_html_entities, line_separator) Parse and return text from an email, stripping HTML and decoding encoded characters

Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email to fetch text for[required]
decode_html_entitiesOption<bool>Decode HTML entities
line_separatorOption<String>Line separator character

Return type

crate::models::EmailTextLinesResult

Authorization

API_KEY

HTTP request headers

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

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

get_emails_paginated

crate::models::PageEmailProjection get_emails_paginated(before, inbox_id, page, search_filter, since, size, sort, unread_only) Get all emails in all inboxes in paginated form. Email API list all.

By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

Parameters

NameTypeDescriptionRequiredNotes
beforeOption<String>Optional filter emails received before given date time
inbox_idOption<Vec>Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
pageOption<i32>Optional page in email list pagination[default to 0]
search_filterOption<String>Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body[default to false]
sinceOption<String>Optional filter emails received after given date time
sizeOption<i32>Optional page size in email list pagination. Maximum size is 100. Use page and sort to page through larger results[default to 20]
sortOption<String>Optional createdAt sort direction ASC or DESC[default to ASC]
unread_onlyOption<bool>Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly[default to false]

Return type

crate::models::PageEmailProjection

Authorization

API_KEY

HTTP request headers

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

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

get_gravatar_url_for_email_address

crate::models::GravatarUrl get_gravatar_url_for_email_address(email_address, size) Get gravatar url for email address

Parameters

NameTypeDescriptionRequiredNotes
email_addressStringemailAddress[required]
sizeOption<String>size

Return type

crate::models::GravatarUrl

Authorization

API_KEY

HTTP request headers

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

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

get_latest_email

crate::models::Email get_latest_email(inbox_ids) Get latest email in all inboxes. Most recently received.

Get the newest email in all inboxes or in a passed set of inbox IDs

Parameters

NameTypeDescriptionRequiredNotes
inbox_idsOption<Vec>Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes

Return type

crate::models::Email

Authorization

API_KEY

HTTP request headers

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

[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) Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.

Get the newest email in all inboxes or in a passed set of inbox IDs

Parameters

NameTypeDescriptionRequiredNotes
inbox_idOption<String>ID of the inbox you want to get the latest email from

Return type

crate::models::Email

Authorization

API_KEY

HTTP request headers

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

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

get_organization_emails_paginated

crate::models::PageEmailProjection get_organization_emails_paginated(before, inbox_id, page, search_filter, since, size, sort, unread_only) Get all organization emails. List team or shared test email accounts

By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

Parameters

NameTypeDescriptionRequiredNotes
beforeOption<String>Optional filter emails received before given date time
inbox_idOption<Vec>Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
pageOption<i32>Optional page in email list pagination[default to 0]
search_filterOption<String>Optional search filter search filter for emails.
sinceOption<String>Optional filter emails received after given date time
sizeOption<i32>Optional page size in email list pagination. Maximum size is 100. Use page and sort to page through larger results[default to 20]
sortOption<String>Optional createdAt sort direction ASC or DESC[default to ASC]
unread_onlyOption<bool>Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly[default to false]

Return type

crate::models::PageEmailProjection

Authorization

API_KEY

HTTP request headers

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

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

get_raw_email_contents

String get_raw_email_contents(email_id) Get raw email string. Returns unparsed raw SMTP message with headers and body.

Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email[required]

Return type

String

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

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

get_raw_email_json

crate::models::RawEmailJson get_raw_email_json(email_id) Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.

Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email[required]

Return type

crate::models::RawEmailJson

Authorization

API_KEY

HTTP request headers

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

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

get_unread_email_count

crate::models::UnreadCount get_unread_email_count() Get unread email count

Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response

Parameters

This endpoint does not need any parameter.

Return type

crate::models::UnreadCount

Authorization

API_KEY

HTTP request headers

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

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

mark_as_read

crate::models::EmailPreview mark_as_read(email_id, read) Mark an email as read on unread

Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread

Parameters

NameTypeDescriptionRequiredNotes
email_idStringemailId[required]
readOption<bool>What value to assign to email read property. Default true.[default to true]

Return type

crate::models::EmailPreview

Authorization

API_KEY

HTTP request headers

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

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

reply_to_email

crate::models::SentEmailDto reply_to_email(email_id, reply_to_email_options) Reply to an email

Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to, cc, and bcc.

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of the email that should be replied to[required]
reply_to_email_optionsReplyToEmailOptionsreplyToEmailOptions[required]

Return type

crate::models::SentEmailDto

Authorization

API_KEY

HTTP request headers

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

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

send_email_source_optional

send_email_source_optional(inbox_id, use_domain_pool, send_email_options) Send email

Alias for InboxController.sendEmail method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.

Parameters

NameTypeDescriptionRequiredNotes
inbox_idOption<String>ID of the inbox you want to send the email from
use_domain_poolOption<bool>Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
send_email_optionsOption<SendEmailOptions>Options for the email

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 ]

validate_email

crate::models::ValidationDto validate_email(email_id) Validate email HTML contents

Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.

Parameters

NameTypeDescriptionRequiredNotes
email_idStringID of email[required]

Return type

crate::models::ValidationDto

Authorization

API_KEY

HTTP request headers

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

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