@asposecloud/aspose-email-cloud/dist/src/model/email-dto.d.ts

Aspose.Email Cloud Node.js SDK

import * as model from "./index";
/**
 * Email message representation.
 */
export declare class EmailDto {
    /**
     * Attribute type map
     */
    static attributeTypeMap: Array<{
        name: string;
        baseName: string;
        type: string;
    }>;
    /**
     * Returns attribute type map
     */
    static getAttributeTypeMap(): {
        name: string;
        baseName: string;
        type: string;
    }[];
    /**
     * Collection of alternate views of message.
     */
    alternateViews: Array<model.AlternateView>;
    /**
     * Email message attachments.
     */
    attachments: Array<model.Attachment>;
    /**
     * BCC recipients.
     */
    bcc: Array<model.MailAddress>;
    /**
     * Email message body as plain text.
     */
    body: string;
    /**
     * Body encoding.
     */
    bodyEncoding: string;
    /**
     * The content type of message body. Enum, available values: PlainText, Html, Rtf
     */
    bodyType: string;
    /**
     * CC recipients.
     */
    cc: Array<model.MailAddress>;
    /**
     * Message date.
     */
    date: Date;
    /**
     * Delivery notifications. Items: Email delivery notification options. Enum, available values: Delay, Never, None, OnFailure, OnSuccess
     */
    deliveryNotificationOptions: Array<string>;
    /**
     * From address.
     */
    from: model.MailAddress;
    /**
     * Document headers.
     */
    headers: {
        [key: string]: string;
    };
    /**
     * HTML body.
     */
    htmlBody: string;
    /**
     * Html body as plain text. Read only.
     */
    htmlBodyText: string;
    /**
     * Indicates whether the message body is in Html.
     */
    isBodyHtml: boolean;
    /**
     * Indicates whether or not a message has been sent.
     */
    isDraft: boolean;
    /**
     * Indicates whether the message is encrypted. Read only.
     */
    isEncrypted: boolean;
    /**
     * Indicates whether the message is signed. Read only.
     */
    isSigned: boolean;
    /**
     * Linked resources of message.
     */
    linkedResources: Array<model.LinkedResource>;
    /**
     * Message id.
     */
    messageId: string;
    /**
     * Indicates whether original EML message is in TNEF format. Read only.
     */
    originalIsTnef: boolean;
    /**
     * Preferred encoding.
     */
    preferredTextEncoding: string;
    /**
     * Email priority status. Enum, available values: High, Low, Normal
     */
    priority: string;
    /**
     * Read receipt addresses.
     */
    readReceiptTo: Array<model.MailAddress>;
    /**
     * The list of addresses to reply to for the mail message.
     */
    replyToList: Array<model.MailAddress>;
    /**
     * ReversePath address.
     */
    reversePath: model.MailAddress;
    /**
     * Sender address.
     */
    sender: model.MailAddress;
    /**
     * Specifies the sensitivity of a MailMessage. Enum, available values: None, Normal, Personal, Private, CompanyConfidential
     */
    sensitivity: string;
    /**
     * Message subject.
     */
    subject: string;
    /**
     * Subject encoding.
     */
    subjectEncoding: string;
    /**
     * Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the local time and UTC represented as count of ticks (10 000 per millisecond).
     */
    timeZoneOffset: number;
    /**
     * The address collection that contains the recipients of message.
     */
    to: Array<model.MailAddress>;
    /**
     * The X-Mailer the software that created the e-mail message.
     */
    xMailer: string;
    /**
     * Gets or sets an epilogue text. It is located after the last boundary.
     */
    epilogue: string;
    /**
     * Gets or sets a preamble text. It is located before the first boundary and generally includes an explanatory note to non-MIME conformant readers.
     */
    preamble: string;
    /**
     * Email message representation.
     * @param alternateViews Collection of alternate views of message.
     * @param attachments Email message attachments.
     * @param bcc BCC recipients.
     * @param body Email message body as plain text.
     * @param bodyEncoding Body encoding.
     * @param bodyType The content type of message body. Enum, available values: PlainText, Html, Rtf
     * @param cc CC recipients.
     * @param date Message date.
     * @param deliveryNotificationOptions Delivery notifications.
     * @param from From address.
     * @param headers Document headers.
     * @param htmlBody HTML body.
     * @param htmlBodyText Html body as plain text. Read only.
     * @param isBodyHtml Indicates whether the message body is in Html.
     * @param isDraft Indicates whether or not a message has been sent.
     * @param isEncrypted Indicates whether the message is encrypted. Read only.
     * @param isSigned Indicates whether the message is signed. Read only.
     * @param linkedResources Linked resources of message.
     * @param messageId Message id.
     * @param originalIsTnef Indicates whether original EML message is in TNEF format. Read only.
     * @param preferredTextEncoding Preferred encoding.
     * @param priority Email priority status. Enum, available values: High, Low, Normal
     * @param readReceiptTo Read receipt addresses.
     * @param replyToList The list of addresses to reply to for the mail message.
     * @param reversePath ReversePath address.
     * @param sender Sender address.
     * @param sensitivity Specifies the sensitivity of a MailMessage. Enum, available values: None, Normal, Personal, Private, CompanyConfidential
     * @param subject Message subject.
     * @param subjectEncoding Subject encoding.
     * @param timeZoneOffset Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the local time and UTC represented as count of ticks (10 000 per millisecond).
     * @param to The address collection that contains the recipients of message.
     * @param xMailer The X-Mailer the software that created the e-mail message.
     * @param epilogue Gets or sets an epilogue text. It is located after the last boundary.
     * @param preamble Gets or sets a preamble text. It is located before the first boundary and generally includes an explanatory note to non-MIME conformant readers.
     */
    constructor(alternateViews?: Array<model.AlternateView>, attachments?: Array<model.Attachment>, bcc?: Array<model.MailAddress>, body?: string, bodyEncoding?: string, bodyType?: string, cc?: Array<model.MailAddress>, date?: Date, deliveryNotificationOptions?: Array<string>, from?: model.MailAddress, headers?: {
        [key: string]: string;
    }, htmlBody?: string, htmlBodyText?: string, isBodyHtml?: boolean, isDraft?: boolean, isEncrypted?: boolean, isSigned?: boolean, linkedResources?: Array<model.LinkedResource>, messageId?: string, originalIsTnef?: boolean, preferredTextEncoding?: string, priority?: string, readReceiptTo?: Array<model.MailAddress>, replyToList?: Array<model.MailAddress>, reversePath?: model.MailAddress, sender?: model.MailAddress, sensitivity?: string, subject?: string, subjectEncoding?: string, timeZoneOffset?: number, to?: Array<model.MailAddress>, xMailer?: string, epilogue?: string, preamble?: string);
}
/**
 *  EmailDto model builder
 */
export declare class EmailDtoBuilder {
    private readonly model;
    constructor(model: EmailDto);
    /**
     * Build model.
     */
    build(): EmailDto;
    /**
    * Collection of alternate views of message.
    */
    alternateViews(alternateViews: Array<model.AlternateView>): EmailDtoBuilder;
    /**
    * Email message attachments.
    */
    attachments(attachments: Array<model.Attachment>): EmailDtoBuilder;
    /**
    * BCC recipients.
    */
    bcc(bcc: Array<model.MailAddress>): EmailDtoBuilder;
    /**
    * Email message body as plain text.
    */
    body(body: string): EmailDtoBuilder;
    /**
    * Body encoding.
    */
    bodyEncoding(bodyEncoding: string): EmailDtoBuilder;
    /**
    * The content type of message body. Enum, available values: PlainText, Html, Rtf
    */
    bodyType(bodyType: string): EmailDtoBuilder;
    /**
    * CC recipients.
    */
    cc(cc: Array<model.MailAddress>): EmailDtoBuilder;
    /**
    * Message date.
    */
    date(date: Date): EmailDtoBuilder;
    /**
    * Delivery notifications. Items: Email delivery notification options. Enum, available values: Delay, Never, None, OnFailure, OnSuccess
    */
    deliveryNotificationOptions(deliveryNotificationOptions: Array<string>): EmailDtoBuilder;
    /**
    * From address.
    */
    from(from: model.MailAddress): EmailDtoBuilder;
    /**
    * Document headers.
    */
    headers(headers: {
        [key: string]: string;
    }): EmailDtoBuilder;
    /**
    * HTML body.
    */
    htmlBody(htmlBody: string): EmailDtoBuilder;
    /**
    * Html body as plain text. Read only.
    */
    htmlBodyText(htmlBodyText: string): EmailDtoBuilder;
    /**
    * Indicates whether the message body is in Html.
    */
    isBodyHtml(isBodyHtml: boolean): EmailDtoBuilder;
    /**
    * Indicates whether or not a message has been sent.
    */
    isDraft(isDraft: boolean): EmailDtoBuilder;
    /**
    * Indicates whether the message is encrypted. Read only.
    */
    isEncrypted(isEncrypted: boolean): EmailDtoBuilder;
    /**
    * Indicates whether the message is signed. Read only.
    */
    isSigned(isSigned: boolean): EmailDtoBuilder;
    /**
    * Linked resources of message.
    */
    linkedResources(linkedResources: Array<model.LinkedResource>): EmailDtoBuilder;
    /**
    * Message id.
    */
    messageId(messageId: string): EmailDtoBuilder;
    /**
    * Indicates whether original EML message is in TNEF format. Read only.
    */
    originalIsTnef(originalIsTnef: boolean): EmailDtoBuilder;
    /**
    * Preferred encoding.
    */
    preferredTextEncoding(preferredTextEncoding: string): EmailDtoBuilder;
    /**
    * Email priority status. Enum, available values: High, Low, Normal
    */
    priority(priority: string): EmailDtoBuilder;
    /**
    * Read receipt addresses.
    */
    readReceiptTo(readReceiptTo: Array<model.MailAddress>): EmailDtoBuilder;
    /**
    * The list of addresses to reply to for the mail message.
    */
    replyToList(replyToList: Array<model.MailAddress>): EmailDtoBuilder;
    /**
    * ReversePath address.
    */
    reversePath(reversePath: model.MailAddress): EmailDtoBuilder;
    /**
    * Sender address.
    */
    sender(sender: model.MailAddress): EmailDtoBuilder;
    /**
    * Specifies the sensitivity of a MailMessage. Enum, available values: None, Normal, Personal, Private, CompanyConfidential
    */
    sensitivity(sensitivity: string): EmailDtoBuilder;
    /**
    * Message subject.
    */
    subject(subject: string): EmailDtoBuilder;
    /**
    * Subject encoding.
    */
    subjectEncoding(subjectEncoding: string): EmailDtoBuilder;
    /**
    * Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the local time and UTC represented as count of ticks (10 000 per millisecond).
    */
    timeZoneOffset(timeZoneOffset: number): EmailDtoBuilder;
    /**
    * The address collection that contains the recipients of message.
    */
    to(to: Array<model.MailAddress>): EmailDtoBuilder;
    /**
    * The X-Mailer the software that created the e-mail message.
    */
    xMailer(xMailer: string): EmailDtoBuilder;
    /**
    * Gets or sets an epilogue text. It is located after the last boundary.
    */
    epilogue(epilogue: string): EmailDtoBuilder;
    /**
    * Gets or sets a preamble text. It is located before the first boundary and generally includes an explanatory note to non-MIME conformant readers.
    */
    preamble(preamble: string): EmailDtoBuilder;
}