EmailPreview

Properties

NameTypeDescriptionNotes
AttachmentsString[]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]
BccString[]List of BCC recipients email addresses that the email was addressed to. See recipients object for names.[optional]
CcString[]List of CC recipients email addresses that the email was addressed to. See recipients object for names.[optional]
CreatedAtSystem.DateTimeWhen was the email received by MailSlurp[optional]
VarFromStringWho the email was sent from. An email address - see fromName for the sender name.[optional]
IdStringID of the email entity[optional]
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]
SubjectStringThe subject line of the email message as specified by SMTP subject header[optional]
ToString[]List of To recipient email addresses that the email was addressed to. See recipients object for names.[optional]

Examples

  • Prepare the resource
$EmailPreview = Initialize-maislurp-client-powershellEmailPreview  -Attachments null `
 -Bcc null `
 -Cc null `
 -CreatedAt null `
 -VarFrom null `
 -Id null `
 -Read null `
 -Subject null `
 -To null
  • Convert the resource to JSON
$EmailPreview | ConvertTo-JSON

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