AgentController

Get scoped hydrated email for an agent

Returns parsed email content after resolving the message inbox and checking agent scope.

get/agent/emails/{emailId}

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/agent/emails/{emailId}
  • Auth: API key in header x-api-key

Path parameters

emailIdstring uuid required

ID of email to inspect

Response

OK

idstring uuid required

ID of the email entity

userIdstring uuid required

ID of user that email belongs to

inboxIdstring uuid required

ID of the inbox that received the email

domainIdstring uuid nullable

ID of the domain that received the email

tostring[] required

List of To recipient email addresses that the email was addressed to. See recipients object for names.

fromstring nullable

Who the email was sent from. An email address - see fromName for the sender name.

replyTostring nullable

The replyTo field on the received email message

ccstring[] nullable

List of CC recipients email addresses that the email was addressed to. See recipients object for names.

bccstring[] nullable

List of BCC recipients email addresses that the email was addressed to. See recipients object for names.

headersobject nullable

Collection of SMTP headers attached to email

headersMapobject nullable

Multi-value map of SMTP headers attached to email

attachmentsstring[] nullable

List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension.

subjectstring nullable

The subject line of the email message as specified by SMTP subject header

bodystring nullable

The body of the email message as text parsed from the SMTP message body (does not include attachments). Fetch the raw content to access the SMTP message and use the attachments property to access attachments. The body is stored separately to the email entity so the body is not returned in paginated results only in full single email or wait requests.

bodyExcerptstring nullable

An excerpt of the body of the email message for quick preview. Takes HTML content part if exists falls back to TEXT content part if not

textExcerptstring nullable

An excerpt of the body of the email message for quick preview. Takes TEXT content part if exists

bodyMD5Hashstring nullable

A hash signature of the email message using MD5. Useful for comparing emails without fetching full body.

isHTMLboolean nullable

Is the email body content type HTML?

charsetstring nullable

Detected character set of the email body such as UTF-8

createdAtstring date-time required

When was the email received by MailSlurp

updatedAtstring date-time required

When was the email last updated

readboolean required

Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks.

teamAccessboolean required

Can the email be accessed by organization team members

isXAmpHtmlboolean nullable

Is the email body content type x-amp-html Amp4Email?

bodyPartContentTypesstring[] nullable

A list of detected multipart mime message body part content types such as text/plain and text/html. Can be used with email bodyPart endpoints to fetch individual body parts.

externalIdstring nullable

UID used by external IMAP server to identify email

messageIdstring nullable

RFC 5322 Message-ID header value without angle brackets.

threadIdstring uuid nullable

MailSlurp thread ID for email chain that enables lookup for In-Reply-To and References fields.

inReplyTostring nullable

Parsed value of In-Reply-To header. A Message-ID in a thread.

favouriteboolean nullable

Is email favourited

sizeBytesinteger nullable

Size of raw email message in bytes

xampHtmlboolean
htmlboolean

Changes

No recorded changes to this operation across all 1 revision of this API.