jmap-kit
    Preparing search index...

    Type Alias VacationResponseObjectSettable

    VacationResponseObject properties that may be set via a VacationResponse/set call.

    RFC 8621 Section 8: Vacation Response

    type VacationResponseObjectSettable = {
        fromDate?: UTCDate | null;
        htmlBody?: string | null;
        isEnabled: boolean;
        subject?: string | null;
        textBody?: string | null;
        toDate?: UTCDate | null;
    }
    Index

    Properties

    fromDate? htmlBody? isEnabled subject? textBody? toDate?

    Properties

    fromDate?: UTCDate | null

    If isEnabled is true, messages that arrive on or after this date-time (but before the toDate if defined) should receive the user's vacation response. If null, the vacation response is effective immediately.

    htmlBody?: string | null

    The HTML body to send in response to messages when the vacation response is enabled. If this is null, the server MAY choose to generate an HTML body part from the textBody when sending vacation responses or MAY choose to send the response as plaintext only.

    isEnabled: boolean

    Should a vacation response be sent if a message arrives between the fromDate and toDate?

    subject?: string | null

    The subject that will be used by the message sent in response to messages when the vacation response is enabled. If null, an appropriate subject SHOULD be set by the server.

    textBody?: string | null

    The plaintext body to send in response to messages when the vacation response is enabled. If this is null, the server SHOULD generate a plaintext body part from the htmlBody when sending vacation responses but MAY choose to send the response as HTML only. If both textBody and htmlBody are null, an appropriate default body SHOULD be generated for responses by the server.

    toDate?: UTCDate | null

    If isEnabled is true, messages that arrive before this date-time (but on or after the fromDate if defined) should receive the user's vacation response. If null, the vacation response is effective indefinitely.

    Settings

    Member Visibility

    On This Page

    Properties