Email

Properties

NameTypeDescriptionNotes
AnalysisEmailAnalysis[optional]
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 was addressed to[optional]
BodyStringThe body of the email message[optional]
BodyMD5HashStringA hash signature of the email message[optional]
CcString[]List of CC recipients email was addressed to[optional]
CharsetStringDetected character set of the email body such as UTF-8[optional]
CreatedAtSystem.DateTimeWhen was the email received by MailSlurp[optional]
VarFromStringWho the email was sent from[optional]
HeadersSystem.Collections.HashtableCollection of SMTP headers attached to email[optional]
IdStringID of the email entity[optional]
InboxIdStringID of the inbox that received the email[optional]
IsHTMLBooleanIs the email body HTML[optional]
ReadBooleanRead flag. Has the email ever been viewed in the dashboard or fetched via the API? If so the email is marked as read.[optional]
ReplyToStringThe replyTo field on the received email message[optional]
SubjectStringThe subject line of the email message[optional]
TeamAccessBooleanCan the email be accessed by organization team members[optional]
ToString[]List of To recipients that email was addressed to[optional]
UpdatedAtSystem.DateTimeWhen was the email last updated[optional]
UserIdStringID of user that email belongs to[optional]

Examples

  • Prepare the resource
$Email = Initialize-maislurp-client-powershellEmail  -Analysis null `
 -Attachments null `
 -Bcc null `
 -Body null `
 -BodyMD5Hash null `
 -Cc null `
 -Charset null `
 -CreatedAt null `
 -VarFrom null `
 -Headers null `
 -Id null `
 -InboxId null `
 -IsHTML null `
 -Read null `
 -ReplyTo null `
 -Subject null `
 -TeamAccess null `
 -To null `
 -UpdatedAt null `
 -UserId null
  • Convert the resource to JSON
$Email | ConvertTo-JSON

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