Aspose::Email::LoadOptions Class Reference

This is an abstract base class for classes that allow the user to specify additional options when loading a MailMessage from a particular format. More...

Inherits Object.

Inherited by Aspose::Email::EmlLoadOptions, Aspose::Email::EmlxLoadOptions, Aspose::Email::HtmlLoadOptions, Aspose::Email::MhtmlLoadOptions, Aspose::Email::MsgLoadOptions, and Aspose::Email::TnefLoadOptions.

Public Member Functions

System::SharedPtr< System::Text::Encoding > get_PreferredTextEncoding () const
 Gets preferred encoding for message. Forcibly sets the preferred encoding for message subject and body. The default value is null. More...
 
void set_PreferredTextEncoding (System::SharedPtr< System::Text::Encoding > value)
 Sets preferred encoding for message. Forcibly sets the preferred encoding for message subject and body. The default value is null. More...
 
System::SharedPtr< Aspose::Email::MessageFormatget_MessageFormat () const
 Represents the mail message format.It can be in eml,msg or mhtml format. The default value is Eml. More...
 
bool get_PreserveEmbeddedMessageFormat () const
 Gets a value indicating whether it is necessary to preserve format of embedded message at loading. By default the value is false. More...
 
void set_PreserveEmbeddedMessageFormat (bool value)
 Sets a value indicating whether it is necessary to preserve format of embedded message at loading. By default the value is false. More...
 
bool get_RemoveSignature () const
 Gets a value indicating whether signature will be removed while loading. More...
 
void set_RemoveSignature (bool value)
 Sets a value indicating whether signature will be removed while loading. More...
 
System::SharedPtr< Aspose::Email::VentureLicense > get_VentureLicense () const
 This is part of the venture licensing pattern. This value will be set by VentureLicenser if the venture passes us a LoadOptions object. More...
 
void set_VentureLicense (System::SharedPtr< Aspose::Email::VentureLicense > value)
 This is part of the venture licensing pattern. This value will be set by VentureLicenser if the venture passes us a LoadOptions object. More...
 
 LoadOptions ()
 

Public Attributes

bool IncreaseCredit
 
System::SharedPtr< System::Text::Encoding > preferredTextEncoding
 
System::SharedPtr< Aspose::Email::MessageFormatmessageFormat
 

Friends

class Aspose::Email::MailMessage
 
class Aspose::Email::EmlLoadOptions
 
class Aspose::Email::EmlxLoadOptions
 
class Aspose::Email::HtmlLoadOptions
 
class Aspose::Email::Mapi::MapiMessage
 
class Aspose::Email::MhtmlLoadOptions
 
class Aspose::Email::MsgLoadOptions
 
class Aspose::Email::Storage::Olm::MapiMessageIterator
 
class Aspose::Email::Storage::Olm::OlmStorage
 
class Aspose::Email::TnefLoadOptions
 

Detailed Description

This is an abstract base class for classes that allow the user to specify additional options when loading a MailMessage from a particular format.

Constructor & Destructor Documentation

◆ LoadOptions()

Aspose::Email::LoadOptions::LoadOptions ( )

Member Function Documentation

◆ get_MessageFormat()

System::SharedPtr<Aspose::Email::MessageFormat> Aspose::Email::LoadOptions::get_MessageFormat ( ) const

Represents the mail message format.It can be in eml,msg or mhtml format. The default value is Eml.

◆ get_PreferredTextEncoding()

System::SharedPtr<System::Text::Encoding> Aspose::Email::LoadOptions::get_PreferredTextEncoding ( ) const

Gets preferred encoding for message. Forcibly sets the preferred encoding for message subject and body. The default value is null.

◆ get_PreserveEmbeddedMessageFormat()

bool Aspose::Email::LoadOptions::get_PreserveEmbeddedMessageFormat ( ) const

Gets a value indicating whether it is necessary to preserve format of embedded message at loading. 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_RemoveSignature()

bool Aspose::Email::LoadOptions::get_RemoveSignature ( ) const

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

true if will be removed; otherwise, false.

◆ get_VentureLicense()

System::SharedPtr<Aspose::Email::VentureLicense> Aspose::Email::LoadOptions::get_VentureLicense ( ) const

This is part of the venture licensing pattern. This value will be set by VentureLicenser if the venture passes us a LoadOptions object.

◆ set_PreferredTextEncoding()

void Aspose::Email::LoadOptions::set_PreferredTextEncoding ( System::SharedPtr< System::Text::Encoding >  value)

Sets preferred encoding for message. Forcibly sets the preferred encoding for message subject and body. The default value is null.

◆ set_PreserveEmbeddedMessageFormat()

void Aspose::Email::LoadOptions::set_PreserveEmbeddedMessageFormat ( bool  value)

Sets a value indicating whether it is necessary to preserve format of embedded message at loading. 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_RemoveSignature()

void Aspose::Email::LoadOptions::set_RemoveSignature ( bool  value)

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

true if will be removed; otherwise, false.

◆ set_VentureLicense()

void Aspose::Email::LoadOptions::set_VentureLicense ( System::SharedPtr< Aspose::Email::VentureLicense >  value)

This is part of the venture licensing pattern. This value will be set by VentureLicenser if the venture passes us a LoadOptions object.

Friends And Related Function Documentation

◆ Aspose::Email::EmlLoadOptions

friend class Aspose::Email::EmlLoadOptions
friend

◆ Aspose::Email::EmlxLoadOptions

friend class Aspose::Email::EmlxLoadOptions
friend

◆ Aspose::Email::HtmlLoadOptions

friend class Aspose::Email::HtmlLoadOptions
friend

◆ Aspose::Email::MailMessage

friend class Aspose::Email::MailMessage
friend

◆ Aspose::Email::Mapi::MapiMessage

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

◆ Aspose::Email::MhtmlLoadOptions

friend class Aspose::Email::MhtmlLoadOptions
friend

◆ Aspose::Email::MsgLoadOptions

friend class Aspose::Email::MsgLoadOptions
friend

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

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

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

◆ Aspose::Email::TnefLoadOptions

friend class Aspose::Email::TnefLoadOptions
friend

Member Data Documentation

◆ IncreaseCredit

bool Aspose::Email::LoadOptions::IncreaseCredit

◆ messageFormat

System::SharedPtr<Aspose::Email::MessageFormat> Aspose::Email::LoadOptions::messageFormat

◆ preferredTextEncoding

System::SharedPtr<System::Text::Encoding> Aspose::Email::LoadOptions::preferredTextEncoding