jmap-kit
    Preparing search index...

    Type Alias IdentityObjectSettable

    IdentityObject properties that may be set via an Identity/set call.

    RFC 8621 Section 6: Identities

    type IdentityObjectSettable = {
        bcc?: EmailAddress[] | null;
        email: string;
        htmlSignature?: string;
        name?: string;
        replyTo?: EmailAddress[] | null;
        textSignature?: string;
    }
    Index

    Properties

    bcc? email htmlSignature? name? replyTo? textSignature?

    Properties

    bcc?: EmailAddress[] | null

    (default: null) The Bcc value the client SHOULD set when creating a new Email from this Identity.

    RFC 8621 Section 4.1.2.3 for the definition of EmailAddress.

    email: string

    (immutable) The From email address the client MUST use when creating a new Email from this Identity. If the mailbox part of the address (the section before the @) is the single character * (e.g., *@example.com), the client may use any valid address ending in that domain (e.g., foo@example.com).

    htmlSignature?: string

    (default: "") A signature the client SHOULD insert into new HTML messages that will be sent from this Identity. This text MUST be an HTML snippet to be inserted into the <body></body> section of the HTML. Clients MAY ignore this and/or combine this with a client-specific signature preference.

    name?: string

    (default: "") The From name the client SHOULD use when creating a new Email from this Identity.

    replyTo?: EmailAddress[] | null

    (default: null) The Reply-To value the client SHOULD set when creating a new Email from this Identity.

    RFC 8621 Section 4.1.2.3 for the definition of EmailAddress.

    textSignature?: string

    (default: "") A signature the client SHOULD insert into new plaintext messages that will be sent from this Identity. Clients MAY ignore this and/or combine this with a client-specific signature preference.

    Settings

    Member Visibility

    On This Page

    Properties