Skip to content

Email

Properties

Name Type Description Notes
id java.util.UUID ID of the email entity
userId java.util.UUID ID of user that email belongs to
inboxId java.util.UUID ID of the inbox that received the email
to kotlin.collections.List List of To recipient email addresses that the email was addressed to. See recipients object for names.
createdAt java.time.OffsetDateTime When was the email received by MailSlurp
updatedAt java.time.OffsetDateTime When was the email last updated
read kotlin.Boolean 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.
teamAccess kotlin.Boolean Can the email be accessed by organization team members
domainId java.util.UUID ID of the domain that received the email [optional]
from kotlin.String Who the email was sent from. An email address - see fromName for the sender name. [optional]
sender Sender [optional]
recipients EmailRecipients [optional]
replyTo kotlin.String The replyTo field on the received email message [optional]
cc kotlin.collections.List List of CC recipients email addresses that the email was addressed to. See recipients object for names. [optional]
bcc kotlin.collections.List List of BCC recipients email addresses that the email was addressed to. See recipients object for names. [optional]
headers kotlin.collections.Map Collection of SMTP headers attached to email [optional]
attachments kotlin.collections.List 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. [optional]
subject kotlin.String The subject line of the email message as specified by SMTP subject header [optional]
body kotlin.String 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. [optional]
bodyExcerpt kotlin.String An excerpt of the body of the email message for quick preview . [optional]
bodyMD5Hash kotlin.String A hash signature of the email message using MD5. Useful for comparing emails without fetching full body. [optional]
isHTML kotlin.Boolean Is the email body content type HTML? [optional]
charset kotlin.String Detected character set of the email body such as UTF-8 [optional]
analysis EmailAnalysis [optional]
html kotlin.Boolean [optional]