Interface EmailMessage

The Sudo Platform SDK representation of an email message.

EmailMessage

interface EmailMessage {
    bcc: EmailMessageAddress[];
    cc: EmailMessageAddress[];
    clientRefId?: string;
    createdAt: Date;
    date?: Date;
    direction: Direction;
    emailAddressId: string;
    encryptionStatus: EncryptionStatus;
    folderId: string;
    forwarded: boolean;
    from: EmailMessageAddress[];
    hasAttachments: boolean;
    id: string;
    owner: string;
    owners: Owner[];
    previousFolderId?: string;
    receivedAt?: Date;
    repliedTo: boolean;
    replyTo: EmailMessageAddress[];
    seen: boolean;
    sentAt?: Date;
    size: number;
    sortDate: Date;
    state: State;
    subject?: string;
    to: EmailMessageAddress[];
    updatedAt: Date;
    version: number;
}

Hierarchy (view full)

Properties

bcc cc clientRefId? createdAt date? direction emailAddressId encryptionStatus folderId forwarded from hasAttachments id owner owners previousFolderId? receivedAt? repliedTo replyTo seen sentAt? size sortDate state subject? to updatedAt version

Properties

bcc

bcc: EmailMessageAddress[]

List of blind carbon copy recipients of the email message.

cc

cc: EmailMessageAddress[]

List of carbon copy recipients of the email message.

Optional clientRefId

clientRefId?: string

Unique client reference identifier.

createdAt

createdAt: Date

Date when the email message was created.

Optional date

date?: Date

direction

direction: Direction

Direction of the email message.

emailAddressId

emailAddressId: string

Identifier of the email address that is associated with the email message - which address sent/received this message.

encryptionStatus

encryptionStatus: EncryptionStatus

folderId

folderId: string

Unique identifier of the email folder which the message is assigned to.

forwarded

forwarded: boolean

True if the email message has been forwarded.

from

from: EmailMessageAddress[]

List of recipients that the email message was sent from.

hasAttachments

hasAttachments: boolean

Whether or not message has attachments. Will be false if message was sent prior to this property being added

id

id: string

Unique identifier of the email message.

owner

owner: string

Identifier of the user that owns the email message.

owners

owners: Owner[]

List of identifiers of user/accounts associated with this email message.

Optional previousFolderId

previousFolderId?: string

Unique identifier of the previous email folder which the message resource was assigned to, if any.

Optional receivedAt

receivedAt?: Date

Date when the email message was received.

repliedTo

repliedTo: boolean

True if the email message has been replied to.

replyTo

replyTo: EmailMessageAddress[]

List of recipients that a reply to this email message will be sent to.

seen

seen: boolean

True if the user has previously seen the email message.

Optional sentAt

sentAt?: Date

Date when the email message was sent.

size

size: number

The size of the encrypted RFC822 data stored in the backend. This value is used to calculate the total storage used by an email address or user and used to enforce email storage related entitlements.

sortDate

sortDate: Date

Date when the email message was processed by the service.

state

state: State

Current state of the email message.

Optional subject

subject?: string

Subject header of the email message.

to

to: EmailMessageAddress[]

List of recipients that the email message is being sent to.

updatedAt

updatedAt: Date

Date when the email message was last updated.

version

version: number

Settings

Member Visibility

Theme

On This Page

bccccclientRefIdcreatedAtdatedirectionemailAddressIdencryptionStatusfolderIdforwardedfromhasAttachmentsidownerownerspreviousFolderIdreceivedAtrepliedToreplyToseensentAtsizesortDatestatesubjecttoupdatedAtversion