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

    Interface ProvisionEmailMaskInput

    Input for SudoEmailClient.provisionEmailMask

    ProvisionEmailMaskInput

    interface ProvisionEmailMaskInput {
        expiresAt?: Date;
        maskAddress: string;
        metadata?: Record<string, any>;
        ownershipProofToken: string;
        realAddress: string;
    }
    Index

    Properties

    expiresAt? maskAddress metadata? ownershipProofToken realAddress

    Properties

    expiresAt?: Date

    Optional expiration date for the email mask. If not provided, the mask will not expire.

    maskAddress: string

    The email mask address to be provisioned in the [local-part]@[domain] format.

    metadata?: Record<string, any>

    Optional metadata to associate with the email mask.

    ownershipProofToken: string

    The signed ownership proof of the Sudo to be associated with the provisioned email mask. The ownership proof must contain an audience of "sudoplatform".

    realAddress: string

    The real email address that the mask will forward to in the [local-part]@[domain] format.

    Settings

    Member Visibility

    On This Page

    Properties