Email

Properties

NameTypeDescriptionNotes
analysisEmailAnalysis[optional] [default to null]
attachmentsListList 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.[optional] [default to null]
bccListList of BCC recipients email addresses that the email was addressed to. See recipients object for names.[optional] [default to null]
bodyStringThe 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.[optional] [default to null]
bodyExcerptStringAn excerpt of the body of the email message for quick preview .[optional] [default to null]
bodyMD5HashStringA hash signature of the email message using MD5. Useful for comparing emails without fetching full body.[optional] [default to null]
ccListList of CC recipients email addresses that the email was addressed to. See recipients object for names.[optional] [default to null]
charsetStringDetected character set of the email body such as UTF-8[optional] [default to null]
createdAtDateWhen was the email received by MailSlurp[optional] [default to null]
fromStringWho the email was sent from. An email address - see fromName for the sender name.[optional] [default to null]
headersMapCollection of SMTP headers attached to email[optional] [default to null]
idUUIDID of the email entity[optional] [default to null]
inboxIdUUIDID of the inbox that received the email[optional] [default to null]
isHTMLBooleanIs the email body HTML[optional] [default to null]
readBooleanRead 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.[optional] [default to null]
recipientsEmailRecipients[optional] [default to null]
replyToStringThe replyTo field on the received email message[optional] [default to null]
senderSender[optional] [default to null]
subjectStringThe subject line of the email message as specified by SMTP subject header[optional] [default to null]
teamAccessBooleanCan the email be accessed by organization team members[optional] [default to null]
toListList of To recipient email addresses that the email was addressed to. See recipients object for names.[optional] [default to null]
updatedAtDateWhen was the email last updated[optional] [default to null]
userIdUUIDID of user that email belongs to[optional] [default to null]

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