Represents the base class for all MapiMessageItem classes and keeps common collections of mapi properties, attachments, recipients. More...

Inherits Aspose::Email::Mapi::MapiPropertyContainer, Aspose::Email::Mapi::IMapiMessageItem, and IDisposable.

Inherited by Aspose::Email::Mapi::MapiCalendar, Aspose::Email::Mapi::MapiContact, Aspose::Email::Mapi::MapiDistributionList, Aspose::Email::Mapi::MapiJournal, Aspose::Email::Mapi::MapiMessage, Aspose::Email::Mapi::MapiNote, and Aspose::Email::Mapi::MapiTask.

Public Member Functions

virtual System::String get_ItemId ()
 The item id, uses with a server More...
 
virtual void set_ItemId (System::String value)
 The item id, uses with a server More...
 
System::SharedPtr< MapiAttachmentCollectionget_Attachments ()
 Gets the attachments in the message. More...
 
void set_Attachments (System::SharedPtr< MapiAttachmentCollection > value)
 Gets the attachments in the message. More...
 
System::SharedPtr< MapiPropertyStreamget_PropertyStream ()
 Gets the property stream. More...
 
System::SharedPtr< MapiPropertyCollectionget_NamedProperties ()
 Gets the named properties of message. More...
 
System::SharedPtr< MapiRecipientCollectionget_Recipients ()
 Gets the recipients of the message. More...
 
void set_Recipients (System::SharedPtr< MapiRecipientCollection > value)
 Gets the recipients of the message. More...
 
System::SharedPtr< MapiPropertyCollectionget_SubStorages ()
 Gets the sub storages. More...
 
System::SharedPtr< MapiNamedPropertyMappingStorageget_NamedPropertyMapping ()
 Gets the named property mapping. More...
 
System::String get_SubjectPrefix ()
 Gets a subject prefix that typically indicates some action on a message, such as "FW: " for forwarding. More...
 
BodyContentType get_BodyType ()
 Gets the type of the body. More...
 
System::String get_BodyRtf ()
 Gets the RTF formatted message text. More...
 
void set_BodyRtf (System::String value)
 Sets the RTF formatted message text. More...
 
System::String get_BodyHtml ()
 Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string. More...
 
System::ArrayPtr< System::String > get_Companies ()
 Contains the names of the companies that are associated with an item. More...
 
void set_Companies (System::ArrayPtr< System::String > value)
 Contains the names of the companies that are associated with an item. More...
 
System::ArrayPtr< System::String > get_Categories ()
 Contains keywords or categories for the message object. More...
 
void set_Categories (System::ArrayPtr< System::String > value)
 Contains keywords or categories for the message object. More...
 
System::String get_Mileage ()
 Contains the mileage information that is associated with an item. More...
 
void set_Mileage (System::String value)
 Contains the mileage information that is associated with an item. More...
 
System::String get_Billing ()
 Contains the billing information associated with an item. More...
 
void set_Billing (System::String value)
 Contains the billing information associated with an item. More...
 
Aspose::Email::Storage::Pst::MapiSensitivity get_Sensitivity ()
 Gets the Sensitivity. More...
 
void set_Sensitivity (Aspose::Email::Storage::Pst::MapiSensitivity value)
 Gets the Sensitivity. More...
 
System::String get_MessageClass () override
 Gets 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. More...
 
void set_MessageClass (System::String value)
 Gets 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. More...
 
System::String get_Body () override
 Gets the message text. More...
 
void set_Body (System::String value) override
 Gets the message text. More...
 
System::String get_Subject () override
 Gets the subject of the message. More...
 
void set_Subject (System::String value) override
 Sets the subject of the message. More...
 
System::SharedPtr< MapiPropertyGetProperty (System::SharedPtr< PropertyDescriptor > pd) override
 Gets MAPI property by property descriptor. More...
 
bool TryGetNamedProperty (System::SharedPtr< MapiProperty > mapiProperty, System::SharedPtr< MapiNamedProperty > &mapiNamedProperty) override
 If MapiNamedPropertyMappingStorage is available, initializes and returns MapiNamedProperty, otherwise null. More...
 
void SetProperty (System::SharedPtr< PropertyDescriptor > pd, System::SharedPtr< System::Object > value) override
 Sets MAPI property. More...
 
void SetStringNamedProperty (System::String value, MapiNamedPropertyId nameId, System::Guid psetId)
 
void SetsIMapiMessageItemMembers (System::String messageClass, System::String body, System::String subject)
 Sets MessageClass,Body and Subject. More...
 
void Dispose () override
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
virtual System::SharedPtr< MapiMessageConvertToMapiMessage ()
 Convert item to MapiMessage. Set MessageClass, Subject, Mileage and Billing. More...
 
void SetNamedPropertyMapping (System::SharedPtr< MapiNamedPropertyMappingStorage > value)
 Sets the named property mapping. More...
 
int64_t GetTagFromNamedProperty (MapiNamedPropertyId propertyId)
 Gets the tag from named property. More...
 
int64_t GetTagFromNamedProperty (System::String name)
 Gets the tag from named property. More...
 
void AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, int64_t nameId, System::Guid guid)
 Adds the named property. More...
 
void AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, int64_t nameId, System::Guid guid, System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object >>> mvEntries)
 Adds the named property. More...
 
void AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::String nameId, System::Guid guid)
 Adds the named property. More...
 
void AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::String nameId, System::Guid guid, System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object >>> mvEntries)
 Adds the named property. More...
 
int64_t AddNamedPropertyToEmbeddedMsg (System::SharedPtr< MapiMessage > msg, MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::SharedPtr< System::Object > nameId, System::Guid guid)
 Adds the named property to embedded message. More...
 
void SetBodyRtf (System::String content, bool compression)
 Gets or sets the RTF formatted message text. More...
 
virtual void SetBodyContent (System::String content, BodyContentType contentType)
 Sets the content of the body. More...
 
virtual void SetBodyContent (System::String content, BodyContentType contentType, bool compression)
 Sets the content of the body. More...
 
void SetMessageFlags (MapiMessageFlags flags)
 Sets the message flags. More...
 
void RemoveProperty (int64_t tag)
 Provides correctly removing property from all collections. More...
 
void UpdateHasAttach ()
 Updates the PR_HASATTACH property value. More...
 
void UpdateDisplayNames (MapiRecipientType recipientType)
 Updates the display names. More...
 
void AddNamedProperty (System::DateTime value, int64_t nameId, System::Guid guid)
 Adds the named datetime property. More...
 
void AddNamedProperty (System::DateTime value, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named datetime property. More...
 
void AddNamedProperty (bool value, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named bool property. More...
 
void AddNamedProperty (bool value, int64_t nameId, System::Guid guid)
 Adds the named bool property. More...
 
void AddNamedPropertyLong (int64_t value, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named long property. More...
 
void AddNamedPropertyLong (int64_t value, int64_t nameId, System::Guid guid)
 Adds the named long property. More...
 
void AddNamedProperty (System::String value, OutlookMessageFormat format, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named string property. More...
 
void AddNamedProperty (System::String value, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named string property. More...
 
void AddNamedProperty (System::String value, OutlookMessageFormat format, int64_t nameId, System::Guid guid)
 Adds the named string property. More...
 
void AddNamedProperty (System::ArrayPtr< uint8_t > value, int64_t nameId, System::Guid guid)
 Adds the named binary property. More...
 
void AddNamedProperty (System::ArrayPtr< uint8_t > value, MapiNamedPropertyId nameId, System::Guid guid)
 Adds the named binary property. More...
 
- Public Member Functions inherited from Aspose::Email::Mapi::MapiPropertyContainer
virtual System::SharedPtr< MapiPropertyCollectionget_Properties ()
 Gets the collection of properties. More...
 
virtual int32_t get_CodePage ()
 Gets the code page. More...
 
System::SharedPtr< System::Text::Encoding > get_CurrentEncoding ()
 
 MapiPropertyContainer ()
 Initializes a new instance of the MapiPropertyContainer class. More...
 
 MapiPropertyContainer (System::SharedPtr< MapiPropertyCollection > properties)
 Initializes a new instance of the MapiPropertyContainer class. More...
 
System::SharedPtr< MapiPropertyCollectionGetSubStorages ()
 
System::String TryGetPropertyString (int64_t tag, int32_t codepage)
 Try to get a property data as string with specified tag and code page. More...
 
System::ArrayPtr< uint8_t > TryGetPropertyData (int64_t tag)
 Try to get the property data with specified tag key. More...
 
System::String TryGetPropertyString (int64_t tag)
 Try to get a property data as string with specified tag. More...
 
System::String GetPropertyString (int64_t tag, int32_t codepage)
 Gets the string value of the property specified by tag. More...
 
System::String GetPropertyString (int64_t tag)
 Gets the string value of the property specified by tag. More...
 
System::ArrayPtr< uint8_t > GetPropertyBytes (int64_t tag)
 Gets the string value of the property specified by tag. More...
 
virtual void SetProperty (System::SharedPtr< MapiProperty > value)
 Sets the property. More...
 
System::Nullable< int32_t > GetPropertyInt32 (int64_t tag)
 Gets the int32 value of the property specified by tag. More...
 
System::Nullable< int64_t > GetPropertyLong (int64_t tag)
 Gets the value of the property specified by tag as Long (int64) type. More...
 
System::Nullable< int16_t > GetPropertyShort (int64_t tag)
 Gets the value of the property specified by tag as Short type. More...
 
System::Nullable< bool > GetPropertyBoolean (int64_t tag)
 Gets the value of the property specified by tag as Boolean type. More...
 
System::Nullable< System::DateTime > GetPropertyDateTime (int64_t key)
 Gets the value of the property specified by tag as DateTime type. More...
 
bool IsStoreUnicodeOk ()
 Determines if string properties are Unicode encoded or not. More...
 
bool TryGetPropertyString (int64_t tag, System::String &value, int32_t codepage)
 Gets the value of the specified property as String type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyString (int64_t tag, System::String &value)
 Gets the value of the specified property as String type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyDateTime (int64_t tag, System::DateTime &value)
 Gets the value of the specified property as DateTime type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyLong (int64_t tag, int64_t &value)
 Gets the value of the specified property as Long type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyInt32 (int64_t tag, int32_t &value)
 Gets the value of the specified property as Int32 type. A return value indicates whether the operation succeeded. More...
 
virtual System::SharedPtr< Nodes::IMapiNode > CreateMapiNode (System::String key)
 Creates the mapi node. More...
 
void SetProperty (int64_t tag, System::ArrayPtr< uint8_t > data)
 Set the property. More...
 
void SetProperty (int64_t tag, System::String value, OutlookMessageFormat format)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value, bool isUnicode)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value, System::SharedPtr< System::Text::Encoding > nonUnicodeEncoding)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value)
 Set the string property with CurrentEncoding More...
 
void SetProperty (int64_t tag, System::DateTime dateTime)
 Set the datetime property. More...
 
void SetPropertyLong (int64_t tag, int64_t value)
 Set the long property. More...
 

Static Public Member Functions

static void SetPriority (System::SharedPtr< MapiMessageItemBase > message, MailPriority priority)
 Sets MailPriority value for MapiMessageItemBase See more PidTagPriority mapi property: https://msdn.microsoft.com/en-us/library/ee159473(v=exchg.80).aspx See more PidTagImportance mapi property: https://msdn.microsoft.com/en-us/library/ee237166(v=exchg.80).aspx More...
 

Public Attributes

System::SharedPtr< MapiNamedPropertyMappingStoragenamedPropertyMappingStorage
 The named property mapping storage. More...
 
- Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
int32_t codePage
 The code page. More...
 
System::SharedPtr< MapiPropertyCollectionpropertyDictionary
 The property dictionary. More...
 

Protected Member Functions

 MapiMessageItemBase ()
 Initializes a new instance of the MapiMessageItemBase class. More...
 
 MapiMessageItemBase (System::SharedPtr< MapiPropertyCollection > properties)
 Initializes a new instance of the MapiMessageItemBase class. More...
 
void CheckIsDisposed ()
 Checks if the object is disposed and raised exception in this case. More...
 
void InitNamedPropertyMappingStorage ()
 Inits the named property mapping storage. More...
 
virtual ~MapiMessageItemBase ()
 

Protected Attributes

System::SharedPtr< MapiAttachmentCollectionattachments
 The collection of attachments. More...
 
System::SharedPtr< MapiRecipientCollectionrecipients
 The collection of recipients. More...
 

Friends

class Aspose::Email::Clients::Exchange::WebService::ContactEwsConverter
 
class Aspose::Email::Tools::ContactConverter
 
class Aspose::Email::Clients::Exchange::WebService::EwsConverterUtils
 
class Aspose::Email::Clients::Exchange::WebService::NoteEwsConverter
 
class Aspose::Email::Clients::Exchange::WebService::TaskEwsConverter
 
class Aspose::Email::Clients::Exchange::Dav::ExchangeClient
 
class Aspose::Email::Clients::Exchange::WebService::ExchangeCalendarSharingInvitationBuilder
 
class Aspose::Email::Clients::Exchange::WebService::EWSClient2007
 
class Aspose::Email::Mapi::MapiTask
 
class Aspose::Email::Clients::Graph::V1::Commands::SendMessageCommand
 
class Aspose::Email::Clients::Graph::V1::Commands::UpdateMessageCommand
 
class Aspose::Email::Clients::Graph::GraphClientV1
 
class Aspose::Email::Clients::Graph::V1::Model::TLMailMessage
 
class Aspose::Email::Mapi::FollowUpManager
 
class Aspose::Email::Mapi::MailMessageInterpretor
 
class Aspose::Email::Mapi::ClearSignedMailMessageInterpretor
 
class Aspose::Email::Mapi::MapiMessageItemInterpretor
 
class Aspose::Email::Mapi::OpaqueSignedMailMessageInterpretor
 
class Aspose::Email::Mapi::MapiAttachment
 
class Aspose::Email::Mapi::MapiAttachmentCollection
 
class Aspose::Email::Mapi::MapiCalendar
 
class Aspose::Email::Mapi::MapiCalendarAttendees
 
class Aspose::Email::Mapi::MapiCalendarEventRecurrence
 
class Aspose::Email::Mapi::MapiCalendarExceptionInfo
 
class Aspose::Email::Mapi::MapiCalendarRecurrencePatternFactory
 
class Aspose::Email::Mapi::MapiContact
 
class Aspose::Email::Mapi::MapiContactElectronicAddressPropertySet
 
class Aspose::Email::Mapi::MapiContactEventPropertySet
 
class Aspose::Email::Mapi::MapiContactNamePropertySet
 
class Aspose::Email::Mapi::MapiContactOtherPropertySet
 
class Aspose::Email::Mapi::MapiContactPersonalInfoPropertySet
 
class Aspose::Email::Mapi::MapiContactPhoto
 
class Aspose::Email::Mapi::MapiContactPhysicalAddressPropertySet
 
class Aspose::Email::Mapi::MapiDistributionList
 
class Aspose::Email::Mapi::MapiJournal
 
class Aspose::Email::Mapi::MapiMessage
 
class Aspose::Email::Mapi::MapiMessagePropertyStream
 
class Aspose::Email::Mapi::MapiMessageReader
 
class Aspose::Email::Mapi::MapiNote
 
class Aspose::Email::Mapi::MapiRecipient
 
class Aspose::Email::Mapi::MapiRecipientCollection
 
class Aspose::Email::Mapi::MapiTaskUsers
 
class Aspose::Email::Mapi::Nodes::NamedPropertyMappingDirectory
 
class Aspose::Email::Mapi::OutlookUtil
 
class Aspose::Email::Storage::Olm::MapiMessageIterator
 
class Aspose::Email::Storage::Olm::OlmStorage
 
class Aspose::Email::Storage::Pst::FolderInfo
 
class Aspose::Email::Storage::Pst::Ltp::LtpDoer
 
class Aspose::Email::Storage::Pst::PstDoer
 
class Aspose::Email::Storage::Pst::PstUtil
 
class Aspose::Email::Tnef::TnefAttachment
 
class Aspose::Email::Tnef::TnefMessageProperty
 
class Aspose::Email::Tools::MessageConverter
 
class Aspose::Email::Tools::ForwardMessageBuilder
 
class Aspose::Email::Tools::ResponseMessageBuilder
 
class Aspose::Email::Tools::ReplyMessageBuilder
 

Additional Inherited Members

- Static Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
static const int32_t DefaultCodePage
 

Detailed Description

Represents the base class for all MapiMessageItem classes and keeps common collections of mapi properties, attachments, recipients.

Constructor & Destructor Documentation

◆ MapiMessageItemBase() [1/2]

Aspose::Email::Mapi::MapiMessageItemBase::MapiMessageItemBase ( )
protected

Initializes a new instance of the MapiMessageItemBase class.

◆ MapiMessageItemBase() [2/2]

Aspose::Email::Mapi::MapiMessageItemBase::MapiMessageItemBase ( System::SharedPtr< MapiPropertyCollection properties)
protected

Initializes a new instance of the MapiMessageItemBase class.

Parameters
propertiesMapiPropertyCollection

◆ ~MapiMessageItemBase()

virtual Aspose::Email::Mapi::MapiMessageItemBase::~MapiMessageItemBase ( )
protectedvirtual

Member Function Documentation

◆ AddNamedProperty() [1/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( bool  value,
int64_t  nameId,
System::Guid  guid 
)

Adds the named bool property.

Parameters
valueThe value.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedProperty() [2/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( bool  value,
MapiNamedPropertyId  nameId,
System::Guid  guid 
)

Adds the named bool property.

Parameters
valueThe value.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedProperty() [3/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( MapiPropertyType  type,
System::ArrayPtr< uint8_t >  data,
int64_t  nameId,
System::Guid  guid 
)

Adds the named property.

Parameters
typeThe data type.
dataThe property data.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedProperty() [4/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( MapiPropertyType  type,
System::ArrayPtr< uint8_t >  data,
int64_t  nameId,
System::Guid  guid,
System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object >>>  mvEntries 
)

Adds the named property.

Parameters
typeThe data type.
dataThe property data.
nameIdThe name id.
guidThe property GUID.
mvEntriesMultiple values.

◆ AddNamedProperty() [5/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( MapiPropertyType  type,
System::ArrayPtr< uint8_t >  data,
System::String  nameId,
System::Guid  guid 
)

Adds the named property.

Parameters
typeThe data type.
dataThe property data.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedProperty() [6/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( MapiPropertyType  type,
System::ArrayPtr< uint8_t >  data,
System::String  nameId,
System::Guid  guid,
System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object >>>  mvEntries 
)

Adds the named property.

Parameters
typeThe data type.
dataThe property data.
nameIdThe name id.
guidThe property GUID.
mvEntriesMultiple values.

◆ AddNamedProperty() [7/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( System::ArrayPtr< uint8_t >  value,
int64_t  nameId,
System::Guid  guid 
)

Adds the named binary property.

Parameters
valueThe value.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedProperty() [8/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( System::ArrayPtr< uint8_t >  value,
MapiNamedPropertyId  nameId,
System::Guid  guid 
)

Adds the named binary property.

Parameters
valueThe value.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedProperty() [9/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( System::DateTime  value,
int64_t  nameId,
System::Guid  guid 
)

Adds the named datetime property.

Parameters
valueThe value.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedProperty() [10/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( System::DateTime  value,
MapiNamedPropertyId  nameId,
System::Guid  guid 
)

Adds the named datetime property.

Parameters
valueThe value.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedProperty() [11/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( System::String  value,
MapiNamedPropertyId  nameId,
System::Guid  guid 
)

Adds the named string property.

Parameters
valueThe value.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedProperty() [12/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( System::String  value,
OutlookMessageFormat  format,
int64_t  nameId,
System::Guid  guid 
)

Adds the named string property.

Parameters
valueThe value.
formatThe encoding format.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedProperty() [13/13]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedProperty ( System::String  value,
OutlookMessageFormat  format,
MapiNamedPropertyId  nameId,
System::Guid  guid 
)

Adds the named string property.

Parameters
valueThe value.
formatThe encoding format.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedPropertyLong() [1/2]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedPropertyLong ( int64_t  value,
int64_t  nameId,
System::Guid  guid 
)

Adds the named long property.

Parameters
valueThe value.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedPropertyLong() [2/2]

void Aspose::Email::Mapi::MapiMessageItemBase::AddNamedPropertyLong ( int64_t  value,
MapiNamedPropertyId  nameId,
System::Guid  guid 
)

Adds the named long property.

Parameters
valueThe value.
nameIdThe name id.
guidThe property GUID.

◆ AddNamedPropertyToEmbeddedMsg()

int64_t Aspose::Email::Mapi::MapiMessageItemBase::AddNamedPropertyToEmbeddedMsg ( System::SharedPtr< MapiMessage msg,
MapiPropertyType  type,
System::ArrayPtr< uint8_t >  data,
System::SharedPtr< System::Object >  nameId,
System::Guid  guid 
)

Adds the named property to embedded message.

Parameters
msgThe embedded message.
typeThe property type.
dataThe property data.
nameIdThe name id.
guidThe property GUID.
Returns

◆ CheckIsDisposed()

void Aspose::Email::Mapi::MapiMessageItemBase::CheckIsDisposed ( )
protected

Checks if the object is disposed and raised exception in this case.

◆ ConvertToMapiMessage()

virtual System::SharedPtr<MapiMessage> Aspose::Email::Mapi::MapiMessageItemBase::ConvertToMapiMessage ( )
virtual

◆ Dispose()

void Aspose::Email::Mapi::MapiMessageItemBase::Dispose ( )
override

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

◆ get_Attachments()

System::SharedPtr<MapiAttachmentCollection> Aspose::Email::Mapi::MapiMessageItemBase::get_Attachments ( )

Gets the attachments in the message.

The attachment collection.

◆ get_Billing()

System::String Aspose::Email::Mapi::MapiMessageItemBase::get_Billing ( )

Contains the billing information associated with an item.

◆ get_Body()

System::String Aspose::Email::Mapi::MapiMessageItemBase::get_Body ( )
overridevirtual

Gets the message text.

The string that represents message body.

Implements Aspose::Email::Mapi::IMapiMessageItem.

◆ get_BodyHtml()

System::String Aspose::Email::Mapi::MapiMessageItemBase::get_BodyHtml ( )

Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string.

◆ get_BodyRtf()

System::String Aspose::Email::Mapi::MapiMessageItemBase::get_BodyRtf ( )

Gets the RTF formatted message text.

When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated. A string value being set must have RTF format. Thus, if it is necessary to set a value in HTML format, the value must be first to encoded within RTF, according to RTF Extensions Specification. To set the content of the body message in HTML or Plain Text formats quickly, please, use SetBodyContent method. When setting a null value or empty string, the values of BodyRtf and Body properties are set null.

The string that represents message body rtf.

◆ get_BodyType()

BodyContentType Aspose::Email::Mapi::MapiMessageItemBase::get_BodyType ( )

Gets the type of the body.

The type of the body.

◆ get_Categories()

System::ArrayPtr<System::String> Aspose::Email::Mapi::MapiMessageItemBase::get_Categories ( )

Contains keywords or categories for the message object.

◆ get_Companies()

System::ArrayPtr<System::String> Aspose::Email::Mapi::MapiMessageItemBase::get_Companies ( )

Contains the names of the companies that are associated with an item.

◆ get_ItemId()

virtual System::String Aspose::Email::Mapi::MapiMessageItemBase::get_ItemId ( )
virtual

The item id, uses with a server

Reimplemented in Aspose::Email::Mapi::MapiContact.

◆ get_MessageClass()

System::String Aspose::Email::Mapi::MapiMessageItemBase::get_MessageClass ( )
overridevirtual

Gets 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.

The string that represents message class.

Implements Aspose::Email::Mapi::IMapiMessageItem.

◆ get_Mileage()

System::String Aspose::Email::Mapi::MapiMessageItemBase::get_Mileage ( )

Contains the mileage information that is associated with an item.

◆ get_NamedProperties()

System::SharedPtr<MapiPropertyCollection> Aspose::Email::Mapi::MapiMessageItemBase::get_NamedProperties ( )

Gets the named properties of message.

The collection of named properties.

◆ get_NamedPropertyMapping()

System::SharedPtr<MapiNamedPropertyMappingStorage> Aspose::Email::Mapi::MapiMessageItemBase::get_NamedPropertyMapping ( )

Gets the named property mapping.

The named property mapping.

◆ get_PropertyStream()

System::SharedPtr<MapiPropertyStream> Aspose::Email::Mapi::MapiMessageItemBase::get_PropertyStream ( )

Gets the property stream.

The property stream.

◆ get_Recipients()

System::SharedPtr<MapiRecipientCollection> Aspose::Email::Mapi::MapiMessageItemBase::get_Recipients ( )

Gets the recipients of the message.

The collection of recipients.

◆ get_Sensitivity()

Aspose::Email::Storage::Pst::MapiSensitivity Aspose::Email::Mapi::MapiMessageItemBase::get_Sensitivity ( )

Gets the Sensitivity.

The sensitivity.

◆ get_Subject()

System::String Aspose::Email::Mapi::MapiMessageItemBase::get_Subject ( )
overridevirtual

Gets the subject of the message.

When setting a value, the values of SubjectPrefix(PR_SUBJECT_PREFIX) and NormalizedSubject(PR_NORMALIZED_SUBJECT) properties are updated as well. If Subject has no prefix, the value of SubjectPrefix property is set null. When setting a null value or empty string, the values of Subject, SubjectPrefix, NormalizedSubject properties are set null.

The string that represents message subject.

Implements Aspose::Email::Mapi::IMapiMessageItem.

◆ get_SubjectPrefix()

System::String Aspose::Email::Mapi::MapiMessageItemBase::get_SubjectPrefix ( )

Gets a subject prefix that typically indicates some action on a message, such as "FW: " for forwarding.

The string that represents subject prefix.

◆ get_SubStorages()

System::SharedPtr<MapiPropertyCollection> Aspose::Email::Mapi::MapiMessageItemBase::get_SubStorages ( )

Gets the sub storages.

The sub storages.

◆ GetProperty()

System::SharedPtr<MapiProperty> Aspose::Email::Mapi::MapiMessageItemBase::GetProperty ( System::SharedPtr< PropertyDescriptor pd)
overridevirtual

Gets MAPI property by property descriptor.

Parameters
pdProperty descriptor for looked property
Returns
Mapi property if it is found, otherwise null.

Reimplemented from Aspose::Email::Mapi::MapiPropertyContainer.

◆ GetTagFromNamedProperty() [1/2]

int64_t Aspose::Email::Mapi::MapiMessageItemBase::GetTagFromNamedProperty ( MapiNamedPropertyId  propertyId)

Gets the tag from named property.

Parameters
propertyIdThe property id.
Returns
The property tag value.

◆ GetTagFromNamedProperty() [2/2]

int64_t Aspose::Email::Mapi::MapiMessageItemBase::GetTagFromNamedProperty ( System::String  name)

Gets the tag from named property.

Parameters
nameThe property name
Returns
The property tag value.
Exceptions
ArgumentExceptionname is null or empty

◆ InitNamedPropertyMappingStorage()

void Aspose::Email::Mapi::MapiMessageItemBase::InitNamedPropertyMappingStorage ( )
protected

Inits the named property mapping storage.

◆ RemoveProperty()

void Aspose::Email::Mapi::MapiMessageItemBase::RemoveProperty ( int64_t  tag)

Provides correctly removing property from all collections.

Parameters
tagThe tag of MapiProperty.

◆ set_Attachments()

void Aspose::Email::Mapi::MapiMessageItemBase::set_Attachments ( System::SharedPtr< MapiAttachmentCollection value)

Gets the attachments in the message.

The attachment collection.

◆ set_Billing()

void Aspose::Email::Mapi::MapiMessageItemBase::set_Billing ( System::String  value)

Contains the billing information associated with an item.

◆ set_Body()

void Aspose::Email::Mapi::MapiMessageItemBase::set_Body ( System::String  value)
overridevirtual

Gets the message text.

The string that represents message body.

Implements Aspose::Email::Mapi::IMapiMessageItem.

◆ set_BodyRtf()

void Aspose::Email::Mapi::MapiMessageItemBase::set_BodyRtf ( System::String  value)

Sets the RTF formatted message text.

When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated. A string value being set must have RTF format. Thus, if it is necessary to set a value in HTML format, the value must be first to encoded within RTF, according to RTF Extensions Specification. To set the content of the body message in HTML or Plain Text formats quickly, please, use SetBodyContent method. When setting a null value or empty string, the values of BodyRtf and Body properties are set null.

The string that represents message body rtf.

◆ set_Categories()

void Aspose::Email::Mapi::MapiMessageItemBase::set_Categories ( System::ArrayPtr< System::String >  value)

Contains keywords or categories for the message object.

◆ set_Companies()

void Aspose::Email::Mapi::MapiMessageItemBase::set_Companies ( System::ArrayPtr< System::String >  value)

Contains the names of the companies that are associated with an item.

◆ set_ItemId()

virtual void Aspose::Email::Mapi::MapiMessageItemBase::set_ItemId ( System::String  value)
virtual

The item id, uses with a server

Reimplemented in Aspose::Email::Mapi::MapiContact.

◆ set_MessageClass()

void Aspose::Email::Mapi::MapiMessageItemBase::set_MessageClass ( System::String  value)

Gets 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.

The string that represents message class.

◆ set_Mileage()

void Aspose::Email::Mapi::MapiMessageItemBase::set_Mileage ( System::String  value)

Contains the mileage information that is associated with an item.

◆ set_Recipients()

void Aspose::Email::Mapi::MapiMessageItemBase::set_Recipients ( System::SharedPtr< MapiRecipientCollection value)

Gets the recipients of the message.

The collection of recipients.

◆ set_Sensitivity()

void Aspose::Email::Mapi::MapiMessageItemBase::set_Sensitivity ( Aspose::Email::Storage::Pst::MapiSensitivity  value)

Gets the Sensitivity.

The sensitivity.

◆ set_Subject()

void Aspose::Email::Mapi::MapiMessageItemBase::set_Subject ( System::String  value)
overridevirtual

Sets the subject of the message.

When setting a value, the values of SubjectPrefix(PR_SUBJECT_PREFIX) and NormalizedSubject(PR_NORMALIZED_SUBJECT) properties are updated as well. If Subject has no prefix, the value of SubjectPrefix property is set null. When setting a null value or empty string, the values of Subject, SubjectPrefix, NormalizedSubject properties are set null.

The string that represents message subject.

Implements Aspose::Email::Mapi::IMapiMessageItem.

◆ SetBodyContent() [1/2]

virtual void Aspose::Email::Mapi::MapiMessageItemBase::SetBodyContent ( System::String  content,
BodyContentType  contentType 
)
virtual

Sets the content of the body.

It is provided for setting of the content of the body message in RTF, HTML or Plain Text formats. When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated as well. Note, after the value in HTML format is set, BodyRtf property returns the value which is encoded within RTF.

Parameters
contentThe content.
contentTypeType of the content.
Exceptions
ArgumentNullExceptionthrows if the specified content string is null or empty.

Reimplemented in Aspose::Email::Mapi::MapiContact.

◆ SetBodyContent() [2/2]

virtual void Aspose::Email::Mapi::MapiMessageItemBase::SetBodyContent ( System::String  content,
BodyContentType  contentType,
bool  compression 
)
virtual

Sets the content of the body.

It is provided for setting of the content of the body message in RTF, HTML or Plain Text formats. When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated as well. Note, after the value in HTML format is set, BodyRtf property returns the value which is encoded within RTF.

Parameters
contentThe content.
contentTypeType of the content.
compressionSpecify that the content should be compressed.
Exceptions
ArgumentNullExceptionthrows if the specified content string is null or empty.

◆ SetBodyRtf()

void Aspose::Email::Mapi::MapiMessageItemBase::SetBodyRtf ( System::String  content,
bool  compression 
)

Gets or sets the RTF formatted message text.

When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated. A string value being set must have RTF format. Thus, if it is necessary to set a value in HTML format, the value must be first to encoded within RTF, according to RTF Extensions Specification. To set the content of the body message in HTML or Plain Text formats quickly, please, use SetBodyContent method. When setting a null value or empty string, the values of BodyRtf and Body properties are set null.

Parameters
contentThe content.
compressionSpecify that the content should be compressed.

◆ SetMessageFlags()

void Aspose::Email::Mapi::MapiMessageItemBase::SetMessageFlags ( MapiMessageFlags  flags)

Sets the message flags.

Parameters
flagsThe message flags.

◆ SetNamedPropertyMapping()

void Aspose::Email::Mapi::MapiMessageItemBase::SetNamedPropertyMapping ( System::SharedPtr< MapiNamedPropertyMappingStorage value)

Sets the named property mapping.

Parameters
valueThe MapiNamedPropertyMappingStorage.

◆ SetPriority()

static void Aspose::Email::Mapi::MapiMessageItemBase::SetPriority ( System::SharedPtr< MapiMessageItemBase message,
MailPriority  priority 
)
static

Sets MailPriority value for MapiMessageItemBase See more PidTagPriority mapi property: https://msdn.microsoft.com/en-us/library/ee159473(v=exchg.80).aspx See more PidTagImportance mapi property: https://msdn.microsoft.com/en-us/library/ee237166(v=exchg.80).aspx

Parameters
messageMapi object
priorityMail priority

◆ SetProperty()

void Aspose::Email::Mapi::MapiMessageItemBase::SetProperty ( System::SharedPtr< PropertyDescriptor pd,
System::SharedPtr< System::Object >  value 
)
overridevirtual

Sets MAPI property.

Parameters
pdThe property descriptor.
valueThe property data.

Reimplemented from Aspose::Email::Mapi::MapiPropertyContainer.

◆ SetsIMapiMessageItemMembers()

void Aspose::Email::Mapi::MapiMessageItemBase::SetsIMapiMessageItemMembers ( System::String  messageClass,
System::String  body,
System::String  subject 
)

Sets MessageClass,Body and Subject.

Parameters
messageClass
body
subject

◆ SetStringNamedProperty()

void Aspose::Email::Mapi::MapiMessageItemBase::SetStringNamedProperty ( System::String  value,
MapiNamedPropertyId  nameId,
System::Guid  psetId 
)

◆ TryGetNamedProperty()

bool Aspose::Email::Mapi::MapiMessageItemBase::TryGetNamedProperty ( System::SharedPtr< MapiProperty mapiProperty,
System::SharedPtr< MapiNamedProperty > &  mapiNamedProperty 
)
overridevirtual

If MapiNamedPropertyMappingStorage is available, initializes and returns MapiNamedProperty, otherwise null.

Parameters
mapiProperty
mapiNamedProperty
Returns

Reimplemented from Aspose::Email::Mapi::MapiPropertyContainer.

◆ UpdateDisplayNames()

void Aspose::Email::Mapi::MapiMessageItemBase::UpdateDisplayNames ( MapiRecipientType  recipientType)

Updates the display names.

Parameters
recipientTypeThe recipient Type.

◆ UpdateHasAttach()

void Aspose::Email::Mapi::MapiMessageItemBase::UpdateHasAttach ( )

Updates the PR_HASATTACH property value.

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Exchange::Dav::ExchangeClient

◆ Aspose::Email::Clients::Exchange::WebService::ContactEwsConverter

friend class Aspose::Email::Clients::Exchange::WebService::ContactEwsConverter
friend

◆ Aspose::Email::Clients::Exchange::WebService::EWSClient2007

friend class Aspose::Email::Clients::Exchange::WebService::EWSClient2007
friend

◆ Aspose::Email::Clients::Exchange::WebService::EwsConverterUtils

friend class Aspose::Email::Clients::Exchange::WebService::EwsConverterUtils
friend

◆ Aspose::Email::Clients::Exchange::WebService::ExchangeCalendarSharingInvitationBuilder

friend class Aspose::Email::Clients::Exchange::WebService::ExchangeCalendarSharingInvitationBuilder
friend

◆ Aspose::Email::Clients::Exchange::WebService::NoteEwsConverter

friend class Aspose::Email::Clients::Exchange::WebService::NoteEwsConverter
friend

◆ Aspose::Email::Clients::Exchange::WebService::TaskEwsConverter

friend class Aspose::Email::Clients::Exchange::WebService::TaskEwsConverter
friend

◆ Aspose::Email::Clients::Graph::GraphClientV1

friend class Aspose::Email::Clients::Graph::GraphClientV1
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::SendMessageCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::SendMessageCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::UpdateMessageCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::UpdateMessageCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Model::TLMailMessage

friend class Aspose::Email::Clients::Graph::V1::Model::TLMailMessage
friend

◆ Aspose::Email::Mapi::ClearSignedMailMessageInterpretor

friend class Aspose::Email::Mapi::ClearSignedMailMessageInterpretor
friend

◆ Aspose::Email::Mapi::FollowUpManager

◆ Aspose::Email::Mapi::MailMessageInterpretor

friend class Aspose::Email::Mapi::MailMessageInterpretor
friend

◆ Aspose::Email::Mapi::MapiAttachment

◆ Aspose::Email::Mapi::MapiAttachmentCollection

◆ Aspose::Email::Mapi::MapiCalendar

friend class Aspose::Email::Mapi::MapiCalendar
friend

◆ Aspose::Email::Mapi::MapiCalendarAttendees

◆ Aspose::Email::Mapi::MapiCalendarEventRecurrence

◆ Aspose::Email::Mapi::MapiCalendarExceptionInfo

◆ Aspose::Email::Mapi::MapiCalendarRecurrencePatternFactory

◆ Aspose::Email::Mapi::MapiContact

friend class Aspose::Email::Mapi::MapiContact
friend

◆ Aspose::Email::Mapi::MapiContactElectronicAddressPropertySet

◆ Aspose::Email::Mapi::MapiContactEventPropertySet

◆ Aspose::Email::Mapi::MapiContactNamePropertySet

◆ Aspose::Email::Mapi::MapiContactOtherPropertySet

◆ Aspose::Email::Mapi::MapiContactPersonalInfoPropertySet

◆ Aspose::Email::Mapi::MapiContactPhoto

◆ Aspose::Email::Mapi::MapiContactPhysicalAddressPropertySet

◆ Aspose::Email::Mapi::MapiDistributionList

◆ Aspose::Email::Mapi::MapiJournal

friend class Aspose::Email::Mapi::MapiJournal
friend

◆ Aspose::Email::Mapi::MapiMessage

friend class Aspose::Email::Mapi::MapiMessage
friend

◆ Aspose::Email::Mapi::MapiMessageItemInterpretor

friend class Aspose::Email::Mapi::MapiMessageItemInterpretor
friend

◆ Aspose::Email::Mapi::MapiMessagePropertyStream

◆ Aspose::Email::Mapi::MapiMessageReader

◆ Aspose::Email::Mapi::MapiNote

friend class Aspose::Email::Mapi::MapiNote
friend

◆ Aspose::Email::Mapi::MapiRecipient

◆ Aspose::Email::Mapi::MapiRecipientCollection

◆ Aspose::Email::Mapi::MapiTask

friend class Aspose::Email::Mapi::MapiTask
friend

◆ Aspose::Email::Mapi::MapiTaskUsers

◆ Aspose::Email::Mapi::Nodes::NamedPropertyMappingDirectory

friend class Aspose::Email::Mapi::Nodes::NamedPropertyMappingDirectory
friend

◆ Aspose::Email::Mapi::OpaqueSignedMailMessageInterpretor

friend class Aspose::Email::Mapi::OpaqueSignedMailMessageInterpretor
friend

◆ Aspose::Email::Mapi::OutlookUtil

friend class Aspose::Email::Mapi::OutlookUtil
friend

◆ Aspose::Email::Storage::Olm::MapiMessageIterator

friend class Aspose::Email::Storage::Olm::MapiMessageIterator
friend

◆ Aspose::Email::Storage::Olm::OlmStorage

◆ Aspose::Email::Storage::Pst::FolderInfo

◆ Aspose::Email::Storage::Pst::Ltp::LtpDoer

friend class Aspose::Email::Storage::Pst::Ltp::LtpDoer
friend

◆ Aspose::Email::Storage::Pst::PstDoer

friend class Aspose::Email::Storage::Pst::PstDoer
friend

◆ Aspose::Email::Storage::Pst::PstUtil

friend class Aspose::Email::Storage::Pst::PstUtil
friend

◆ Aspose::Email::Tnef::TnefAttachment

friend class Aspose::Email::Tnef::TnefAttachment
friend

◆ Aspose::Email::Tnef::TnefMessageProperty

friend class Aspose::Email::Tnef::TnefMessageProperty
friend

◆ Aspose::Email::Tools::ContactConverter

friend class Aspose::Email::Tools::ContactConverter
friend

◆ Aspose::Email::Tools::ForwardMessageBuilder

◆ Aspose::Email::Tools::MessageConverter

friend class Aspose::Email::Tools::MessageConverter
friend

◆ Aspose::Email::Tools::ReplyMessageBuilder

◆ Aspose::Email::Tools::ResponseMessageBuilder

Member Data Documentation

◆ attachments

System::SharedPtr<MapiAttachmentCollection> Aspose::Email::Mapi::MapiMessageItemBase::attachments
protected

The collection of attachments.

◆ namedPropertyMappingStorage

System::SharedPtr<MapiNamedPropertyMappingStorage> Aspose::Email::Mapi::MapiMessageItemBase::namedPropertyMappingStorage

The named property mapping storage.

◆ recipients

System::SharedPtr<MapiRecipientCollection> Aspose::Email::Mapi::MapiMessageItemBase::recipients
protected

The collection of recipients.