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

    Interface ProvisionEmailAddressInput

    Input for SudoEmailClient.provisionEmailAddress.

    ProvisionEmailAddressInput

    interface ProvisionEmailAddressInput {
        alias?: string;
        allowSymmetricKeyGeneration?: boolean;
        emailAddress: string;
        ownershipProofToken: string;
    }
    Index

    Properties

    alias? allowSymmetricKeyGeneration? emailAddress ownershipProofToken

    Properties

    alias?: string

    An alias for the email address.

    allowSymmetricKeyGeneration?: boolean

    (optional) If false and no symmetric key is found, a KeyNotFoundError will be thrown. Defaults to true.

    emailAddress: string

    The email address to provision, in the form ${localPart}@${domain}.

    ownershipProofToken: string

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

    Settings

    Member Visibility

    On This Page

    Properties