Email

Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is parsed. The body and attachments are written to disk and the fields such as to, from, subject etc are stored in a database. The body contains the email content. If you want the original SMTP message see the getRawEmail endpoints. The attachments can be fetched using the AttachmentController

Properties

NameTypeDescriptionNotes
analysisEmailAnalysis[optional]
attachmentslist[str]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]
bcclist[str]List of BCC recipients email addresses that the email was addressed to. See recipients object for names.[optional]
bodystrThe 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]
body_excerptstrAn excerpt of the body of the email message for quick preview .[optional]
body_md5_hashstrA hash signature of the email message using MD5. Useful for comparing emails without fetching full body.[optional]
cclist[str]List of CC recipients email addresses that the email was addressed to. See recipients object for names.[optional]
charsetstrDetected character set of the email body such as UTF-8[optional]
created_atdatetimeWhen was the email received by MailSlurp[optional]
_fromstrWho the email was sent from. An email address - see fromName for the sender name.[optional]
headersdict(str, str)Collection of SMTP headers attached to email[optional]
idstrID of the email entity[optional]
inbox_idstrID of the inbox that received the email[optional]
is_htmlboolIs the email body HTML[optional]
readboolRead 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]
recipientsEmailRecipients[optional]
reply_tostrThe replyTo field on the received email message[optional]
senderSender[optional]
subjectstrThe subject line of the email message as specified by SMTP subject header[optional]
team_accessboolCan the email be accessed by organization team members[optional]
tolist[str]List of To recipient email addresses that the email was addressed to. See recipients object for names.[optional]
updated_atdatetimeWhen was the email last updated[optional]
user_idstrID of user that email belongs to[optional]

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