UNPKG

@asposecloud/aspose-email-cloud

Version:
349 lines (348 loc) 14.2 kB
import * as model from "./index"; /** * Represents an Outlook Message format document. */ export declare class MapiMessageDto extends model.MapiMessageItemBaseDto { /** * Attribute type map */ static attributeTypeMap: Array<{ name: string; baseName: string; type: string; }>; /** * Returns attribute type map */ static getAttributeTypeMap(): { name: string; baseName: string; type: string; }[]; /** * Message text */ messageBody: string; /** * Date and time the message sender submitted a message. */ clientSubmitTime: Date; /** * Topic of the first message in a conversation thread. */ conversationTopic: string; /** * Date and time a message was delivered. */ deliveryTime: Date; /** * List of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;). */ displayBcc: string; /** * List of the display names of any carbon copy (CC) message recipients, separated by semicolons (;). */ displayCc: string; /** * Display name for the message. */ displayName: string; /** * Prefix of the display name. */ displayNamePrefix: string; /** * List of the display names of the primary (To) message recipients, separated by semicolons (;). */ displayTo: string; /** * Message flags. Items: Mapi message flags. Enum, available values: MsgFlagZero, MsgFlagRead, MsgFlagUnmodified, MsgFlagSubmit, MsgFlagUnsent, MsgFlagHasAttach, MsgFlagFromMe, MsgFlagAssociated, MsgFlagResend, MsgFlagNotifyRead, MsgFlagNotifyUnread, MsgFlagEverRead, MsgFlagOriginX400, MsgFlagOriginInternet, MsgFlagOriginMiscExt */ flags: Array<string>; /** * Transport message headers */ headers: { [key: string]: string; }; /** * Internet message id of the message. */ internetMessageId: string; /** * Represents outlook message format. Enum, available values: Ascii, Unicode */ messageFormat: string; /** * Normalized subject of the message. */ normalizedSubject: string; /** * Value indicating whether the read receipt is requested. */ readReceiptRequested: boolean; /** * Reply to names. */ replyTo: string; /** * Message sender's e-mail address type. */ senderAddressType: string; /** * Message sender's e-mail address. */ senderEmailAddress: string; /** * Message sender's display name. */ senderName: string; /** * Message sender's e-mail address. */ senderSmtpAddress: string; /** * Address type for the messaging user represented by the sender. */ sentRepresentingAddressType: string; /** * E-mail address for the messaging user represented by the sender. */ sentRepresentingEmailAddress: string; /** * Display name for the messaging user represented by the sender. */ sentRepresentingName: string; /** * E-mail address for the messaging user represented by the sender. */ sentRepresentingSmtpAddress: string; /** * Transport-specific message envelope information. */ transportMessageHeaders: string; /** * Represents an Outlook Message format document. * @param attachments Message item attachments. * @param billing Billing information associated with an item. * @param body Message text. * @param bodyHtml Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string. * @param bodyRtf RTF formatted message text. * @param bodyType The content type of message body. Enum, available values: PlainText, Html, Rtf * @param categories Contains keywords or categories for the message object. * @param companies Contains the names of the companies that are associated with an item. * @param itemId The item id, uses with a server. * @param messageClass Case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message. * @param mileage Contains the mileage information that is associated with an item. * @param recipients Recipients of the message. * @param sensitivity Contains values that indicate the message sensitivity. Enum, available values: None, Personal, Private, CompanyConfidential * @param subject Subject of the message. * @param subjectPrefix Subject prefix that typically indicates some action on a message, such as \"FW: \" for forwarding. * @param properties List of MAPI properties * @param messageBody Message text * @param clientSubmitTime Date and time the message sender submitted a message. * @param conversationTopic Topic of the first message in a conversation thread. * @param deliveryTime Date and time a message was delivered. * @param displayBcc List of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;). * @param displayCc List of the display names of any carbon copy (CC) message recipients, separated by semicolons (;). * @param displayName Display name for the message. * @param displayNamePrefix Prefix of the display name. * @param displayTo List of the display names of the primary (To) message recipients, separated by semicolons (;). * @param flags Message flags. * @param headers Transport message headers * @param internetMessageId Internet message id of the message. * @param messageFormat Represents outlook message format. Enum, available values: Ascii, Unicode * @param normalizedSubject Normalized subject of the message. * @param readReceiptRequested Value indicating whether the read receipt is requested. * @param replyTo Reply to names. * @param senderAddressType Message sender's e-mail address type. * @param senderEmailAddress Message sender's e-mail address. * @param senderName Message sender's display name. * @param senderSmtpAddress Message sender's e-mail address. * @param sentRepresentingAddressType Address type for the messaging user represented by the sender. * @param sentRepresentingEmailAddress E-mail address for the messaging user represented by the sender. * @param sentRepresentingName Display name for the messaging user represented by the sender. * @param sentRepresentingSmtpAddress E-mail address for the messaging user represented by the sender. * @param transportMessageHeaders Transport-specific message envelope information. */ constructor(attachments?: Array<model.MapiAttachmentDto>, billing?: string, body?: string, bodyHtml?: string, bodyRtf?: string, bodyType?: string, categories?: Array<string>, companies?: Array<string>, itemId?: string, messageClass?: string, mileage?: string, recipients?: Array<model.MapiRecipientDto>, sensitivity?: string, subject?: string, subjectPrefix?: string, properties?: Array<model.MapiPropertyDto>, messageBody?: string, clientSubmitTime?: Date, conversationTopic?: string, deliveryTime?: Date, displayBcc?: string, displayCc?: string, displayName?: string, displayNamePrefix?: string, displayTo?: string, flags?: Array<string>, headers?: { [key: string]: string; }, internetMessageId?: string, messageFormat?: string, normalizedSubject?: string, readReceiptRequested?: boolean, replyTo?: string, senderAddressType?: string, senderEmailAddress?: string, senderName?: string, senderSmtpAddress?: string, sentRepresentingAddressType?: string, sentRepresentingEmailAddress?: string, sentRepresentingName?: string, sentRepresentingSmtpAddress?: string, transportMessageHeaders?: string); } /** * MapiMessageDto model builder */ export declare class MapiMessageDtoBuilder { private readonly model; constructor(model: MapiMessageDto); /** * Build model. */ build(): MapiMessageDto; /** * Message item attachments. */ attachments(attachments: Array<model.MapiAttachmentDto>): MapiMessageDtoBuilder; /** * Billing information associated with an item. */ billing(billing: string): MapiMessageDtoBuilder; /** * Message text. */ body(body: string): MapiMessageDtoBuilder; /** * Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string. */ bodyHtml(bodyHtml: string): MapiMessageDtoBuilder; /** * RTF formatted message text. */ bodyRtf(bodyRtf: string): MapiMessageDtoBuilder; /** * The content type of message body. Enum, available values: PlainText, Html, Rtf */ bodyType(bodyType: string): MapiMessageDtoBuilder; /** * Contains keywords or categories for the message object. */ categories(categories: Array<string>): MapiMessageDtoBuilder; /** * Contains the names of the companies that are associated with an item. */ companies(companies: Array<string>): MapiMessageDtoBuilder; /** * The item id, uses with a server. */ itemId(itemId: string): MapiMessageDtoBuilder; /** * Case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message. */ messageClass(messageClass: string): MapiMessageDtoBuilder; /** * Contains the mileage information that is associated with an item. */ mileage(mileage: string): MapiMessageDtoBuilder; /** * Recipients of the message. */ recipients(recipients: Array<model.MapiRecipientDto>): MapiMessageDtoBuilder; /** * Contains values that indicate the message sensitivity. Enum, available values: None, Personal, Private, CompanyConfidential */ sensitivity(sensitivity: string): MapiMessageDtoBuilder; /** * Subject of the message. */ subject(subject: string): MapiMessageDtoBuilder; /** * Subject prefix that typically indicates some action on a message, such as \"FW: \" for forwarding. */ subjectPrefix(subjectPrefix: string): MapiMessageDtoBuilder; /** * List of MAPI properties */ properties(properties: Array<model.MapiPropertyDto>): MapiMessageDtoBuilder; /** * Message text */ messageBody(messageBody: string): MapiMessageDtoBuilder; /** * Date and time the message sender submitted a message. */ clientSubmitTime(clientSubmitTime: Date): MapiMessageDtoBuilder; /** * Topic of the first message in a conversation thread. */ conversationTopic(conversationTopic: string): MapiMessageDtoBuilder; /** * Date and time a message was delivered. */ deliveryTime(deliveryTime: Date): MapiMessageDtoBuilder; /** * List of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;). */ displayBcc(displayBcc: string): MapiMessageDtoBuilder; /** * List of the display names of any carbon copy (CC) message recipients, separated by semicolons (;). */ displayCc(displayCc: string): MapiMessageDtoBuilder; /** * Display name for the message. */ displayName(displayName: string): MapiMessageDtoBuilder; /** * Prefix of the display name. */ displayNamePrefix(displayNamePrefix: string): MapiMessageDtoBuilder; /** * List of the display names of the primary (To) message recipients, separated by semicolons (;). */ displayTo(displayTo: string): MapiMessageDtoBuilder; /** * Message flags. Items: Mapi message flags. Enum, available values: MsgFlagZero, MsgFlagRead, MsgFlagUnmodified, MsgFlagSubmit, MsgFlagUnsent, MsgFlagHasAttach, MsgFlagFromMe, MsgFlagAssociated, MsgFlagResend, MsgFlagNotifyRead, MsgFlagNotifyUnread, MsgFlagEverRead, MsgFlagOriginX400, MsgFlagOriginInternet, MsgFlagOriginMiscExt */ flags(flags: Array<string>): MapiMessageDtoBuilder; /** * Transport message headers */ headers(headers: { [key: string]: string; }): MapiMessageDtoBuilder; /** * Internet message id of the message. */ internetMessageId(internetMessageId: string): MapiMessageDtoBuilder; /** * Represents outlook message format. Enum, available values: Ascii, Unicode */ messageFormat(messageFormat: string): MapiMessageDtoBuilder; /** * Normalized subject of the message. */ normalizedSubject(normalizedSubject: string): MapiMessageDtoBuilder; /** * Value indicating whether the read receipt is requested. */ readReceiptRequested(readReceiptRequested: boolean): MapiMessageDtoBuilder; /** * Reply to names. */ replyTo(replyTo: string): MapiMessageDtoBuilder; /** * Message sender's e-mail address type. */ senderAddressType(senderAddressType: string): MapiMessageDtoBuilder; /** * Message sender's e-mail address. */ senderEmailAddress(senderEmailAddress: string): MapiMessageDtoBuilder; /** * Message sender's display name. */ senderName(senderName: string): MapiMessageDtoBuilder; /** * Message sender's e-mail address. */ senderSmtpAddress(senderSmtpAddress: string): MapiMessageDtoBuilder; /** * Address type for the messaging user represented by the sender. */ sentRepresentingAddressType(sentRepresentingAddressType: string): MapiMessageDtoBuilder; /** * E-mail address for the messaging user represented by the sender. */ sentRepresentingEmailAddress(sentRepresentingEmailAddress: string): MapiMessageDtoBuilder; /** * Display name for the messaging user represented by the sender. */ sentRepresentingName(sentRepresentingName: string): MapiMessageDtoBuilder; /** * E-mail address for the messaging user represented by the sender. */ sentRepresentingSmtpAddress(sentRepresentingSmtpAddress: string): MapiMessageDtoBuilder; /** * Transport-specific message envelope information. */ transportMessageHeaders(transportMessageHeaders: string): MapiMessageDtoBuilder; }