Interface EmailAddress

The Sudo Platform SDK representation of an email address provisioned by the email service.

EmailAddress

interface EmailAddress {
    alias?: string;
    createdAt: Date;
    emailAddress: string;
    folders: EmailFolder[];
    id: string;
    identityId: string;
    lastReceivedAt: undefined | Date;
    numberOfEmailMessages: number;
    owner: string;
    owners: Owner[];
    size: number;
    updatedAt: Date;
    version: number;
}

Hierarchy (view full)

Properties

alias? createdAt emailAddress folders id identityId lastReceivedAt numberOfEmailMessages owner owners size updatedAt version

Properties

Optional alias

alias?: string

An alias for the email address.

createdAt

createdAt: Date

Date when the email address was created.

emailAddress

emailAddress: string

Address in format 'local-part@domain' of the email address.

folders

folders: EmailFolder[]

id

id: string

Unique identifier of the email address.

identityId

identityId: string

lastReceivedAt

lastReceivedAt: undefined | Date

Date when the email address last received an email message.

numberOfEmailMessages

numberOfEmailMessages: number

The total number of email messages assigned to the email address.

owner

owner: string

Identifier of the user that owns the email address.

owners

owners: Owner[]

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

size

size: number

The total size of all email messages assigned to the email address.

updatedAt

updatedAt: Date

Date when the email address was last updated.

version

version: number

Version of this entity, increments on update.

Settings

Member Visibility

Theme

On This Page

aliascreatedAtemailAddressfoldersididentityIdlastReceivedAtnumberOfEmailMessagesownerownerssizeupdatedAtversion