jmap-kit
    Preparing search index...

    Type Alias EmailSubmissionObjectSettable

    EmailSubmissionObject properties that may be set via an EmailSubmission/set call.

    RFC 8621 Section 7: Email Submission

    type EmailSubmissionObjectSettable = {
        emailId: Id;
        envelope?: EmailSubmissionEnvelope | null;
        identityId: Id;
        undoStatus?: "pending" | "final" | "canceled";
    }
    Index

    Properties

    emailId envelope? identityId undoStatus?

    Properties

    emailId: Id

    (immutable) The id of the Email to send. The Email being sent does not have to be a draft, for example, when "redirecting" an existing Email to a different address.

    envelope?: EmailSubmissionEnvelope | null

    (immutable) Information for use when sending via SMTP. If null or omitted on creation, the server MUST generate this from the referenced Email.

    identityId: Id

    (immutable) The id of the Identity to associate with this submission.

    undoStatus?: "pending" | "final" | "canceled"

    This represents whether the submission may be canceled. This is server set on create and MUST be one of the following values:

    • pending: It may be possible to cancel this submission.
    • final: The message has been relayed to at least one recipient in a manner that cannot be recalled. It is no longer possible to cancel this submission.
    • canceled: The submission was canceled and will not be delivered to any recipient.

    Settings

    Member Visibility

    On This Page

    Properties