MapiMessage

MapiMessage class

Represents an Outlook Message format document that can be parsed.

The MapiMessage type exposes the following members:

Constructors

NameDescription
MapiMessage()Initializes a new instance of the MapiMessage class.
MapiMessage(format)Initializes a new instance of the MapiMessage class
MapiMessage(from_address, to, subject, body, format)Initializes a new instance of the MapiMessage class
MapiMessage(from_address, to, subject, body)Initializes a new instance of the MapiMessage class

Properties

NameDescription
properties
code_page
item_idThe item id, uses with a server
attachmentsGets the attachments in the message.
property_streamGets the property stream.
named_propertiesGets the named properties of message.
recipientsGets the recipients of the message.
sub_storagesGets the sub storages.
named_property_mappingGets the named property mapping.
subject_prefixGets a subject prefix that typically indicates some action on a message, such as “FW: " for forwarding.
body_typeGets the type of the body.
body_rtfGets or sets the RTF formatted message text.
body_htmlGets the body_rtf of the message converted to HTML, if present, otherwise an empty string.
companiesContains the names of the companies that are associated with an item.
categoriesContains keywords or categories for the message object.
mileageContains the mileage information that is associated with an item.
billingContains the billing information associated with an item.
sensitivityGets the Sensitivity.
message_classGets a 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.
supported_typeGets the supported item type.
bodyGets the message text.
subjectGets or sets the subject of the message.
is_signedGets a value indicating whether the message is signed.
is_encryptedGets a value indicating whether the message is encrypted.
reply_toGets or sets the reply to names.
normalized_subjectGets normalized subject of the message.
display_toGets a list of the display names of the primary (To) message recipients, separated by semicolons (;).
display_name_prefixGets a prefix of the display name.
display_nameGets the display name for the message.
display_ccGets a list of the display names of any carbon copy (CC) message recipients, separated by semicolons (;).
display_bccGets a list of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;).
sender_email_addressGets or sets the message sender’s e-mail address.
sender_smtp_addressGets or sets the message sender’s e-mail address.
sender_address_typeGets the message sender’s e-mail address type.
sender_nameGets or sets the message sender’s display name.
transport_message_headersGets the transport-specific message envelope information.
internet_message_idGets the message id of the message.
conversation_topicGets the topic of the first message in a conversation thread.
sent_representing_email_addressGets or sets the e-mail address for the messaging user represented by the sender.
sent_representing_smtp_addressGets or sets the e-mail address for the messaging user represented by the sender.
sent_representing_address_typeGets the address type for the messaging user represented by the sender.
sent_representing_nameGets or sets the display name for the messaging user represented by the sender.
client_submit_timeGets or sets the date and time
the message sender submitted a message.
delivery_timeGets or sets the date and time
a message was delivered.
headersGets the transport message headers
flagsGets the message flags.
read_receipt_requestedGets or sets a value indicating whether the read receipt is requested.
message_formatGets the outlook message format.
is_templateDetermines whether the message is Outlook template (.oft).

Methods

NameDescription
set_property(pd, value)
set_property(value)
try_get_property_string(tag, codepage)
try_get_property_string(tag)
try_get_property_string(tag, value, codepage)
try_get_property_string(tag, value)
get_property_string(tag, codepage)
get_property_string(tag)
set_body_content(content, content_type)
set_body_content(content, content_type, compression)
decrypt()
decrypt(certificate)
load(file_name)
load(stream)
load(stream, options)
load(file_name, options)
from_mail_message(file_name)
from_mail_message(stream)
from_mail_message(message)
from_mail_message(message, options)
load_from_tnef(stream)
load_from_tnef(file_name)
is_msg_format(file_name)
is_msg_format(stream)
add_custom_property(property, string_name_id)
add_custom_property(type, data, string_name_id)
save(file_name, options)
save(stream, options)
save(file_name)
save(stream)
save_as_tnef(stream)
save_as_tnef(file_name)
save_as_template(file_name)
save_as_template(stream)
get_property(pd)
try_get_property_data(tag)
get_property_bytes(tag)
get_property_int32(tag)
get_property_long(tag)
get_property_short(tag)
get_property_boolean(tag)
get_property_date_time(key)
is_store_unicode_ok()
try_get_property_date_time(tag, value)
try_get_property_long(tag, value)
try_get_property_int32(tag, value)
set_body_rtf(content, compression)
set_message_flags(flags)
remove_property(tag)
remove_signature()
check_signature()
from_properties(properties)
remove_attachments(path)
destroy_attachments(path)
set_string_property_value(tag, value)
get_custom_properties()
to_mapi_message_item()
to_mail_message(options)
check_bounced()
clone()

See Also