@sudoplatform/sudo-email
    Preparing search index...

    Interface EmailMask

    The Sudo Platform SDK representation of an email mask.

    EmailMask

    interface EmailMask {
        createdAt: Date;
        expiresAt?: Date;
        id: string;
        identityId: string;
        inboundDelivered: number;
        inboundReceived: number;
        maskAddress: string;
        metadata?: Record<string, any>;
        outboundDelivered: number;
        outboundReceived: number;
        owner: string;
        owners: Owner[];
        realAddress: string;
        realAddressType: EmailMaskRealAddressType;
        spamCount: number;
        status: EmailMaskStatus;
        updatedAt: Date;
        version: number;
        virusCount: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt expiresAt? id identityId inboundDelivered inboundReceived maskAddress metadata? outboundDelivered outboundReceived owner owners realAddress realAddressType spamCount status updatedAt version virusCount

    Properties

    createdAt: Date

    Date and time when the email mask was created.

    expiresAt?: Date

    Optional TTL signifying when the email mask will be automatically deactivated.

    id: string

    Unique identifier of the email mask.

    identityId: string

    The identityId of the user that owns the email mask resource.

    inboundDelivered: number

    Number of inbound messages delivered to the real email address.

    inboundReceived: number

    Number of inbound messages received by the email mask.

    maskAddress: string

    The mask email address that will be publicly visible.

    metadata?: Record<string, any>

    Optional metadata associated with the email mask.

    outboundDelivered: number

    Number of outbound messages successfully sent from the real email address through the email mask.

    outboundReceived: number

    Number of outbound messages attempted to be sent from the real email address through the email mask.

    owner: string

    Identifier of the user owns the email mask resource.

    owners: Owner[]

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

    realAddress: string

    The real email address that the mask forwards to.

    realAddressType: EmailMaskRealAddressType

    The type of the real email address.

    spamCount: number

    Number of inbound messages that were flagged as spam.

    status: EmailMaskStatus

    The status of the email mask.

    updatedAt: Date

    Date and time when the email mask was last updated.

    version: number

    Version of the email mask resource.

    virusCount: number

    Number of inbound messages that were flagged as viruses.

    Settings

    Member Visibility

    On This Page

    Properties