Aspose::Email::Mapi::MapiConversionOptions Class Reference

This class allows the user to specify additional options when converting from MailMessage to MapiMessage. More...

Inherits Object.

Public Member Functions

ConversionProgressEventHandler get_CustomProgressHandler () const
 
void set_CustomProgressHandler (ConversionProgressEventHandler value)
 
OutlookMessageFormat get_Format () const
 Represents outlook message format. More...
 
void set_Format (OutlookMessageFormat value)
 Represents outlook message format. More...
 
bool get_PreserveSignature () const
 Set to true, if signature is to be preserved. More...
 
void set_PreserveSignature (bool value)
 Set to true, if signature is to be preserved. More...
 
bool get_RemoveSignature () const
 Gets a value indicating whether signature will be removed while converting. More...
 
void set_RemoveSignature (bool value)
 Sets a value indicating whether signature will be removed while converting. More...
 
bool get_UseBodyCompression () const
 Set to true, if need RTF body compression. More...
 
void set_UseBodyCompression (bool value)
 Set to true, if need RTF body compression. More...
 
bool get_PreserveOriginalDates () const
 Gets a value indicating whether it is necessary to generate new saving and modification dates when converting a message. More...
 
void set_PreserveOriginalDates (bool value)
 Sets a value indicating whether it is necessary to generate new saving and modification dates when converting a message. More...
 
bool get_PreserveEmptyDates () const
 Gets a value indicating whether it is necessary to generate new saving and modification dates when converting a message. More...
 
void set_PreserveEmptyDates (bool value)
 Sets a value indicating whether it is necessary to generate new saving and modification dates when converting a message. More...
 
bool get_PreserveOriginalAddresses () const
 Gets a value indicating whether it is necessary to keep original value of mail addresses (without validation). More...
 
void set_PreserveOriginalAddresses (bool value)
 Sets a value indicating whether it is necessary to keep original value of mail addresses (without validation). More...
 
bool get_PreserveEmbeddedMessageFormat () const
 Gets a value indicating whether it is necessary to preserve EML format of embedded message at converting to MapiMessage. By default the value is false. More...
 
void set_PreserveEmbeddedMessageFormat (bool value)
 Sets a value indicating whether it is necessary to preserve EML format of embedded message at converting to MapiMessage. By default the value is false. More...
 
bool get_ForcedRtfBodyForAppointment () const
 Gets a value indicating whether it is necessary to use forced RTF body for an appointment. Default value is true. More...
 
void set_ForcedRtfBodyForAppointment (bool value)
 Sets a value indicating whether it is necessary to use forced RTF body for an appointment. Default value is true. More...
 
System::SharedPtr< ProgressEventHandlerInfoget_ProgressInfo () const
 
void set_ProgressInfo (System::SharedPtr< ProgressEventHandlerInfo > value)
 
 MapiConversionOptions ()
 Initializes a new instance of the MapiConversionOptions class. More...
 
 MapiConversionOptions (OutlookMessageFormat format)
 Initializes a new instance of the MapiConversionOptions class with specified OutlookMessageFormat. More...
 
System::SharedPtr< MapiConversionOptionsClone ()
 

Static Public Member Functions

static System::SharedPtr< MapiConversionOptionsget_ASCIIFormat ()
 Returns MapiConversionOptions with OutlookMessageFormat is ASCII(PreserveSignature is False, UseBodyCompression is False). More...
 
static System::SharedPtr< MapiConversionOptionsget_UnicodeFormat ()
 Returns MapiConversionOptions with OutlookMessageFormat is Unicode(PreserveSignature is False, UseBodyCompression is False). More...
 

Friends

class Aspose::Email::MailMessage
 
class Aspose::Email::Mapi::MapiMessage
 

Detailed Description

This class allows the user to specify additional options when converting from MailMessage to MapiMessage.

Constructor & Destructor Documentation

◆ MapiConversionOptions() [1/2]

Aspose::Email::Mapi::MapiConversionOptions::MapiConversionOptions ( )

Initializes a new instance of the MapiConversionOptions class.

◆ MapiConversionOptions() [2/2]

Aspose::Email::Mapi::MapiConversionOptions::MapiConversionOptions ( OutlookMessageFormat  format)

Initializes a new instance of the MapiConversionOptions class with specified OutlookMessageFormat.

Parameters
formatFormat of MapiMessage OutlookMessageFormat.

Member Function Documentation

◆ Clone()

System::SharedPtr<MapiConversionOptions> Aspose::Email::Mapi::MapiConversionOptions::Clone ( )

◆ get_ASCIIFormat()

static System::SharedPtr<MapiConversionOptions> Aspose::Email::Mapi::MapiConversionOptions::get_ASCIIFormat ( )
static

Returns MapiConversionOptions with OutlookMessageFormat is ASCII(PreserveSignature is False, UseBodyCompression is False).

◆ get_CustomProgressHandler()

ConversionProgressEventHandler Aspose::Email::Mapi::MapiConversionOptions::get_CustomProgressHandler ( ) const

◆ get_ForcedRtfBodyForAppointment()

bool Aspose::Email::Mapi::MapiConversionOptions::get_ForcedRtfBodyForAppointment ( ) const

Gets a value indicating whether it is necessary to use forced RTF body for an appointment. Default value is true.

◆ get_Format()

OutlookMessageFormat Aspose::Email::Mapi::MapiConversionOptions::get_Format ( ) const

Represents outlook message format.

◆ get_PreserveEmbeddedMessageFormat()

bool Aspose::Email::Mapi::MapiConversionOptions::get_PreserveEmbeddedMessageFormat ( ) const

Gets a value indicating whether it is necessary to preserve EML format of embedded message at converting to MapiMessage. By default the value is false.

Generally, embedded messages have the same format (EML or MSG) as the underlying message. By default, when converting from EML to MSG and vice versa, embedded messages are also converted to the target format. Setting the property to true preserves the original format of embedded messages.

◆ get_PreserveEmptyDates()

bool Aspose::Email::Mapi::MapiConversionOptions::get_PreserveEmptyDates ( ) const

Gets a value indicating whether it is necessary to generate new saving and modification dates when converting a message.

◆ get_PreserveOriginalAddresses()

bool Aspose::Email::Mapi::MapiConversionOptions::get_PreserveOriginalAddresses ( ) const

Gets a value indicating whether it is necessary to keep original value of mail addresses (without validation).

◆ get_PreserveOriginalDates()

bool Aspose::Email::Mapi::MapiConversionOptions::get_PreserveOriginalDates ( ) const

Gets a value indicating whether it is necessary to generate new saving and modification dates when converting a message.

◆ get_PreserveSignature()

bool Aspose::Email::Mapi::MapiConversionOptions::get_PreserveSignature ( ) const

Set to true, if signature is to be preserved.

Deprecated:
Now the signature is preserved by default.This property is obsolete, not used in code and will be removed soon. To remove signature use MapiConversionOptions.RemoveSignature instead.

◆ get_ProgressInfo()

System::SharedPtr<ProgressEventHandlerInfo> Aspose::Email::Mapi::MapiConversionOptions::get_ProgressInfo ( ) const

◆ get_RemoveSignature()

bool Aspose::Email::Mapi::MapiConversionOptions::get_RemoveSignature ( ) const

Gets a value indicating whether signature will be removed while converting.

true if will be removed; otherwise, false.

◆ get_UnicodeFormat()

static System::SharedPtr<MapiConversionOptions> Aspose::Email::Mapi::MapiConversionOptions::get_UnicodeFormat ( )
static

Returns MapiConversionOptions with OutlookMessageFormat is Unicode(PreserveSignature is False, UseBodyCompression is False).

◆ get_UseBodyCompression()

bool Aspose::Email::Mapi::MapiConversionOptions::get_UseBodyCompression ( ) const

Set to true, if need RTF body compression.

◆ set_CustomProgressHandler()

void Aspose::Email::Mapi::MapiConversionOptions::set_CustomProgressHandler ( ConversionProgressEventHandler  value)

◆ set_ForcedRtfBodyForAppointment()

void Aspose::Email::Mapi::MapiConversionOptions::set_ForcedRtfBodyForAppointment ( bool  value)

Sets a value indicating whether it is necessary to use forced RTF body for an appointment. Default value is true.

◆ set_Format()

void Aspose::Email::Mapi::MapiConversionOptions::set_Format ( OutlookMessageFormat  value)

Represents outlook message format.

◆ set_PreserveEmbeddedMessageFormat()

void Aspose::Email::Mapi::MapiConversionOptions::set_PreserveEmbeddedMessageFormat ( bool  value)

Sets a value indicating whether it is necessary to preserve EML format of embedded message at converting to MapiMessage. By default the value is false.

Generally, embedded messages have the same format (EML or MSG) as the underlying message. By default, when converting from EML to MSG and vice versa, embedded messages are also converted to the target format. Setting the property to true preserves the original format of embedded messages.

◆ set_PreserveEmptyDates()

void Aspose::Email::Mapi::MapiConversionOptions::set_PreserveEmptyDates ( bool  value)

Sets a value indicating whether it is necessary to generate new saving and modification dates when converting a message.

◆ set_PreserveOriginalAddresses()

void Aspose::Email::Mapi::MapiConversionOptions::set_PreserveOriginalAddresses ( bool  value)

Sets a value indicating whether it is necessary to keep original value of mail addresses (without validation).

◆ set_PreserveOriginalDates()

void Aspose::Email::Mapi::MapiConversionOptions::set_PreserveOriginalDates ( bool  value)

Sets a value indicating whether it is necessary to generate new saving and modification dates when converting a message.

◆ set_PreserveSignature()

void Aspose::Email::Mapi::MapiConversionOptions::set_PreserveSignature ( bool  value)

Set to true, if signature is to be preserved.

Deprecated:
Now the signature is preserved by default.This property is obsolete, not used in code and will be removed soon. To remove signature use MapiConversionOptions.RemoveSignature instead.

◆ set_ProgressInfo()

void Aspose::Email::Mapi::MapiConversionOptions::set_ProgressInfo ( System::SharedPtr< ProgressEventHandlerInfo value)

◆ set_RemoveSignature()

void Aspose::Email::Mapi::MapiConversionOptions::set_RemoveSignature ( bool  value)

Sets a value indicating whether signature will be removed while converting.

true if will be removed; otherwise, false.

◆ set_UseBodyCompression()

void Aspose::Email::Mapi::MapiConversionOptions::set_UseBodyCompression ( bool  value)

Set to true, if need RTF body compression.

Friends And Related Function Documentation

◆ Aspose::Email::MailMessage

friend class Aspose::Email::MailMessage
friend

◆ Aspose::Email::Mapi::MapiMessage

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