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

MethodHTTP requestDescription
deleteAllEmailsDELETE /emailsDelete all emails in all inboxes.
deleteEmailDELETE /emails/{emailId}Delete an email
downloadAttachmentGET /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.
downloadAttachmentBase64GET /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.
downloadBodyGET /emails/{emailId}/bodyGet email body as string. Returned as plain/text with content type header.
downloadBodyBytesGET /emails/{emailId}/body-bytesGet email body in bytes. Returned as octet-stream with content type header.
forwardEmailPOST /emails/{emailId}/forwardForward email to recipients
getAttachmentMetaDataGET /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.
getEmailGET /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.
getEmailAttachmentsGET /emails/{emailId}/attachmentsGet all email attachment metadata. Metadata includes name and size of attachments.
getEmailContentMatchPOST /emails/{emailId}/contentMatchGet email content regex pattern match results. Runs regex against email body and returns match groups.
getEmailCountGET /emails/emails/countGet email count
getEmailHTMLGET /emails/{emailId}/htmlGet email content as HTML. For displaying emails in browser context.
getEmailHTMLQueryGET /emails/{emailId}/htmlQueryParse and return text from an email, stripping HTML and decoding encoded characters
getEmailLinksGET /emails/{emailId}/linksParse and return list of links found in an email (only works for HTML content)
getEmailTextLinesGET /emails/{emailId}/textLinesParse and return text from an email, stripping HTML and decoding encoded characters
getEmailsPaginatedGET /emailsGet all emails in all inboxes in paginated form. Email API list all.
getGravatarUrlForEmailAddressGET /emails/gravatarFor
getLatestEmailGET /emails/latestGet latest email in all inboxes. Most recently received.
getLatestEmailInInboxGET /emails/latestInGet latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.
getOrganizationEmailsPaginatedGET /emails/organizationGet all organization emails. List team or shared test email accounts
getRawEmailContentsGET /emails/{emailId}/rawGet raw email string. Returns unparsed raw SMTP message with headers and body.
getRawEmailJsonGET /emails/{emailId}/raw/jsonGet raw email in JSON. Unparsed SMTP message in JSON wrapper format.
getUnreadEmailCountGET /emails/unreadCountGet unread email count
markAsReadPATCH /emails/{emailId}/readMark an email as read on unread
replyToEmailPUT /emails/{emailId}Reply to an email
sendEmailSourceOptionalPOST /emailsSend email
validateEmailPOST /emails/{emailId}/validateValidate email HTML contents
    open class func deleteAllEmails() -> Promise<Void>

Delete all emails in all inboxes.

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp


// Delete all emails in all inboxes.
EmailControllerAPI.deleteAllEmails().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (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 ]

    open class func deleteEmail( emailId: UUID) -> Promise<Void>

Delete an email

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email to delete

// Delete an email
EmailControllerAPI.deleteEmail(emailId: emailId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email to delete

Return type

Void (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 ]

    open class func downloadAttachment( emailId: UUID,  attachmentId: String,  apiKey: String? = nil) -> Promise<Data>

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email
let attachmentId = "attachmentId_example" // String | ID of attachment
let apiKey = "apiKey_example" // 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. (optional)

// 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.
EmailControllerAPI.downloadAttachment(emailId: emailId, attachmentId: attachmentId, apiKey: apiKey).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email
attachmentIdStringID of attachment
apiKeyStringCan 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.[optional]

Return type

Data

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 ]

    open class func downloadAttachmentBase64( emailId: UUID,  attachmentId: String) -> Promise<DownloadAttachmentDto>

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email
let attachmentId = "attachmentId_example" // String | ID of attachment

// 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`.
EmailControllerAPI.downloadAttachmentBase64(emailId: emailId, attachmentId: attachmentId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email
attachmentIdStringID of attachment

Return type

DownloadAttachmentDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func downloadBody( emailId: UUID) -> Promise<String>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email

// Get email body as string. Returned as `plain/text` with content type header.
EmailControllerAPI.downloadBody(emailId: emailId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email

Return type

String

Authorization

API_KEY

HTTP request headers

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

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

    open class func downloadBodyBytes( emailId: UUID) -> Promise<Data>

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email

// Get email body in bytes. Returned as `octet-stream` with content type header.
EmailControllerAPI.downloadBodyBytes(emailId: emailId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email

Return type

Data

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 ]

    open class func forwardEmail( emailId: UUID,  forwardEmailOptions: ForwardEmailOptions) -> Promise<SentEmailDto>

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email
let forwardEmailOptions = ForwardEmailOptions(to: ["to_example"], subject: "subject_example", cc: ["cc_example"], bcc: ["bcc_example"], from: "from_example", useInboxName: false) // ForwardEmailOptions | 

// Forward email to recipients
EmailControllerAPI.forwardEmail(emailId: emailId, forwardEmailOptions: forwardEmailOptions).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email
forwardEmailOptionsForwardEmailOptions

Return type

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 ]

    open class func getAttachmentMetaData( emailId: UUID,  attachmentId: String) -> Promise<AttachmentMetaData>

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email
let attachmentId = "attachmentId_example" // String | ID of attachment

// Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments  use the `downloadAttachment` methods.
EmailControllerAPI.getAttachmentMetaData(emailId: emailId, attachmentId: attachmentId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email
attachmentIdStringID of attachment

Return type

AttachmentMetaData

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func getEmail( emailId: UUID,  decode: Bool? = nil) -> Promise<Email>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | 
let decode = true // 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 (optional) (default to false)

// Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
EmailControllerAPI.getEmail(emailId: emailId, decode: decode).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUID
decodeBoolDecode 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[optional] [default to false]

Return type

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 ]

    open class func getEmailAttachments( emailId: UUID) -> Promise<[AttachmentMetaData]>

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email

// Get all email attachment metadata. Metadata includes name and size of attachments.
EmailControllerAPI.getEmailAttachments(emailId: emailId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email

Return type

**[AttachmentMetaData]**

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func getEmailContentMatch( emailId: UUID,  contentMatchOptions: ContentMatchOptions) -> Promise<EmailContentMatchResult>

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email to match against
let contentMatchOptions = ContentMatchOptions(pattern: "pattern_example") // ContentMatchOptions | 

// Get email content regex pattern match results. Runs regex against email body and returns match groups.
EmailControllerAPI.getEmailContentMatch(emailId: emailId, contentMatchOptions: contentMatchOptions).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email to match against
contentMatchOptionsContentMatchOptions

Return type

EmailContentMatchResult

Authorization

API_KEY

HTTP request headers

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

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

    open class func getEmailCount() -> Promise<CountDto>

Get email count

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp


// Get email count
EmailControllerAPI.getEmailCount().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

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 ]

    open class func getEmailHTML( emailId: UUID,  decode: Bool? = nil) -> Promise<String>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | 
let decode = true // Bool |  (optional) (default to false)

// Get email content as HTML. For displaying emails in browser context.
EmailControllerAPI.getEmailHTML(emailId: emailId, decode: decode).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUID
decodeBool[optional] [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 ]

    open class func getEmailHTMLQuery( emailId: UUID,  htmlSelector: String) -> Promise<EmailTextLinesResult>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email to perform HTML query on
let htmlSelector = "htmlSelector_example" // 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.

// Parse and return text from an email, stripping HTML and decoding encoded characters
EmailControllerAPI.getEmailHTMLQuery(emailId: emailId, htmlSelector: htmlSelector).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email to perform HTML query on
htmlSelectorStringHTML 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

EmailTextLinesResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func getEmailLinks( emailId: UUID) -> Promise<EmailLinksResult>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email to fetch text for

// Parse and return list of links found in an email (only works for HTML content)
EmailControllerAPI.getEmailLinks(emailId: emailId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email to fetch text for

Return type

EmailLinksResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func getEmailTextLines( emailId: UUID,  decodeHtmlEntities: Bool? = nil,  lineSeparator: String? = nil) -> Promise<EmailTextLinesResult>

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email to fetch text for
let decodeHtmlEntities = true // Bool | Decode HTML entities (optional)
let lineSeparator = "lineSeparator_example" // String | Line separator character (optional)

// Parse and return text from an email, stripping HTML and decoding encoded characters
EmailControllerAPI.getEmailTextLines(emailId: emailId, decodeHtmlEntities: decodeHtmlEntities, lineSeparator: lineSeparator).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email to fetch text for
decodeHtmlEntitiesBoolDecode HTML entities[optional]
lineSeparatorStringLine separator character[optional]

Return type

EmailTextLinesResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func getEmailsPaginated( inboxId: [UUID]? = nil,  page: Int? = nil,  size: Int? = nil,  sort: Sort_getEmailsPaginated? = nil,  unreadOnly: Bool? = nil,  searchFilter: String? = nil,  since: Date? = nil,  before: Date? = nil) -> Promise<PageEmailProjection>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let inboxId = [123] // [UUID] | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
let page = 987 // Int | Optional page  in email list pagination (optional) (default to 0)
let size = 987 // Int | Optional page size in email list pagination. Maximum size is 100. Use page  and sort to page through larger results (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
let unreadOnly = true // Bool | Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional) (default to false)
let searchFilter = "searchFilter_example" // String | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
let since = Date() // Date | Optional filter emails received after given date time (optional)
let before = Date() // Date | Optional filter emails received before given date time (optional)

// Get all emails in all inboxes in paginated form. Email API list all.
EmailControllerAPI.getEmailsPaginated(inboxId: inboxId, page: page, size: size, sort: sort, unreadOnly: unreadOnly, searchFilter: searchFilter, since: since, before: before).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
inboxId**[UUID]**Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.[optional]
pageIntOptional page in email list pagination[optional] [default to 0]
sizeIntOptional page size in email list pagination. Maximum size is 100. Use page and sort to page through larger results[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to .asc]
unreadOnlyBoolOptional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly[optional] [default to false]
searchFilterStringOptional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body[optional]
sinceDateOptional filter emails received after given date time[optional]
beforeDateOptional filter emails received before given date time[optional]

Return type

PageEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func getGravatarUrlForEmailAddress( emailAddress: String,  size: String? = nil) -> Promise<GravatarUrl>

Get gravatar url for email address

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailAddress = "emailAddress_example" // String | 
let size = "size_example" // String |  (optional)

EmailControllerAPI.getGravatarUrlForEmailAddress(emailAddress: emailAddress, size: size).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailAddressString
sizeString[optional]

Return type

GravatarUrl

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func getLatestEmail( inboxIds: [UUID]? = nil) -> Promise<Email>

Get latest email in all inboxes. Most recently received.

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let inboxIds = [123] // [UUID] | Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional)

// Get latest email in all inboxes. Most recently received.
EmailControllerAPI.getLatestEmail(inboxIds: inboxIds).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
inboxIds**[UUID]**Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes[optional]

Return type

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 ]

    open class func getLatestEmailInInbox( inboxId: UUID) -> Promise<Email>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let inboxId = 987 // UUID | ID of the inbox you want to get the latest email from

// Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
EmailControllerAPI.getLatestEmailInInbox(inboxId: inboxId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
inboxIdUUIDID of the inbox you want to get the latest email from

Return type

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 ]

    open class func getOrganizationEmailsPaginated( inboxId: [UUID]? = nil,  page: Int? = nil,  size: Int? = nil,  sort: Sort_getOrganizationEmailsPaginated? = nil,  unreadOnly: Bool? = nil,  searchFilter: String? = nil,  since: Date? = nil,  before: Date? = nil) -> Promise<PageEmailProjection>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let inboxId = [123] // [UUID] | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
let page = 987 // Int | Optional page  in email list pagination (optional) (default to 0)
let size = 987 // Int | Optional page size in email list pagination. Maximum size is 100. Use page  and sort to page through larger results (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
let unreadOnly = true // Bool | Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional) (default to false)
let searchFilter = "searchFilter_example" // String | Optional search filter search filter for emails. (optional)
let since = Date() // Date | Optional filter emails received after given date time (optional)
let before = Date() // Date | Optional filter emails received before given date time (optional)

// Get all organization emails. List team or shared test email accounts
EmailControllerAPI.getOrganizationEmailsPaginated(inboxId: inboxId, page: page, size: size, sort: sort, unreadOnly: unreadOnly, searchFilter: searchFilter, since: since, before: before).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
inboxId**[UUID]**Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.[optional]
pageIntOptional page in email list pagination[optional] [default to 0]
sizeIntOptional page size in email list pagination. Maximum size is 100. Use page and sort to page through larger results[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to .asc]
unreadOnlyBoolOptional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly[optional] [default to false]
searchFilterStringOptional search filter search filter for emails.[optional]
sinceDateOptional filter emails received after given date time[optional]
beforeDateOptional filter emails received before given date time[optional]

Return type

PageEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func getRawEmailContents( emailId: UUID) -> Promise<String>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email

// Get raw email string. Returns unparsed raw SMTP message with headers and body.
EmailControllerAPI.getRawEmailContents(emailId: emailId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email

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 ]

    open class func getRawEmailJson( emailId: UUID) -> Promise<RawEmailJson>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email

// Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
EmailControllerAPI.getRawEmailJson(emailId: emailId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email

Return type

RawEmailJson

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func getUnreadEmailCount() -> Promise<UnreadCount>

Get unread email count

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp


// Get unread email count
EmailControllerAPI.getUnreadEmailCount().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

UnreadCount

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func markAsRead( emailId: UUID,  read: Bool? = nil) -> Promise<EmailPreview>

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | 
let read = true // Bool | What value to assign to email read property. Default true. (optional) (default to true)

// Mark an email as read on unread
EmailControllerAPI.markAsRead(emailId: emailId, read: read).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUID
readBoolWhat value to assign to email read property. Default true.[optional] [default to true]

Return type

EmailPreview

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

    open class func replyToEmail( emailId: UUID,  replyToEmailOptions: ReplyToEmailOptions) -> Promise<SentEmailDto>

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of the email that should be replied to
let replyToEmailOptions = ReplyToEmailOptions(body: "body_example", isHTML: false, from: "from_example", replyTo: "replyTo_example", charset: "charset_example", attachments: ["attachments_example"], templateVariables: "TODO", template: 123, sendStrategy: "sendStrategy_example", useInboxName: false) // ReplyToEmailOptions | 

// Reply to an email
EmailControllerAPI.replyToEmail(emailId: emailId, replyToEmailOptions: replyToEmailOptions).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of the email that should be replied to
replyToEmailOptionsReplyToEmailOptions

Return type

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 ]

    open class func sendEmailSourceOptional( inboxId: UUID,  sendEmailOptions: SendEmailOptions,  useDomainPool: Bool? = nil) -> Promise<Void>

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.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let inboxId = 987 // UUID | ID of the inbox you want to send the email from
let sendEmailOptions = SendEmailOptions(toContacts: [123], toGroup: 123, to: ["to_example"], from: "from_example", cc: ["cc_example"], bcc: ["bcc_example"], subject: "subject_example", replyTo: "replyTo_example", body: "body_example", html: false, isHTML: false, charset: "charset_example", attachments: ["attachments_example"], templateVariables: "TODO", template: 123, sendStrategy: "sendStrategy_example", useInboxName: false, addTrackingPixel: false) // SendEmailOptions | 
let useDomainPool = true // Bool | Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)

// Send email
EmailControllerAPI.sendEmailSourceOptional(inboxId: inboxId, sendEmailOptions: sendEmailOptions, useDomainPool: useDomainPool).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
inboxIdUUIDID of the inbox you want to send the email from
sendEmailOptionsSendEmailOptions
useDomainPoolBoolUse domain pool. Optionally create inbox to send from using the mailslurp domain pool.[optional]

Return type

Void (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 ]

    open class func validateEmail( emailId: UUID) -> Promise<ValidationDto>

Validate email HTML contents

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let emailId = 987 // UUID | ID of email

// Validate email HTML contents
EmailControllerAPI.validateEmail(emailId: emailId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
emailIdUUIDID of email

Return type

ValidationDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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