Aspose::Email::HtmlSaveOptions Class Reference

Allows to specify additional options when saving MailMessage to Html format. More...

Inherits Aspose::Email::HeadersFormattingOptions.

Public Member Functions

Aspose::Email::HtmlFormatOptions get_HtmlFormatOptions () const
 Gets additional options when saving in HTML format. Default value is HtmlFormatOptions.None. More...
 
void set_HtmlFormatOptions (Aspose::Email::HtmlFormatOptions value)
 Sets additional options when saving in HTML format. Default value is HtmlFormatOptions.None. More...
 
bool get_CheckBodyContentEncoding () const
 Defines whether need check message body content encoding when saving. By default the value is false. More...
 
void set_CheckBodyContentEncoding (bool value)
 Defines whether need check message body content encoding when saving. By default the value is false. More...
 
Aspose::Email::ResourceRenderingMode get_ResourceRenderingMode () const
 Provides set various modes of rendering resources in html. Default value EmbedIntoHtml. More...
 
void set_ResourceRenderingMode (Aspose::Email::ResourceRenderingMode value)
 Provides set various modes of rendering resources in html. Default value EmbedIntoHtml. More...
 
bool get_UseRelativePathToResources () const
 
void set_UseRelativePathToResources (bool value)
 
System::String get_PathToHtmlFile () const
 
void set_PathToHtmlFile (System::String value)
 
 HtmlSaveOptions ()
 Initializes a new instance of this class that can be used to save a MailMessage in the Html format. More...
 
- Public Member Functions inherited from Aspose::Email::HeadersFormattingOptions
int32_t get_Timeout () const
 Limits the time in milliseconds of formatting message while saving in Mht. Default value 3 sec. More...
 
void set_Timeout (int32_t value)
 Limits the time in milliseconds of formatting message while saving in Mht. Default value 3 sec. More...
 
ContactFieldsSet get_RenderedContactFields () const
 Defines groups of Contact fields which will be included in output mhtml. Default value is ContactFieldsSet.AllExisting. More...
 
void set_RenderedContactFields (ContactFieldsSet value)
 Defines groups of Contact fields which will be included in output mhtml. Default value is ContactFieldsSet.AllExisting. More...
 
System::String get_CssStyles () const
 Gets the additional css styles for the formatter. More...
 
void set_CssStyles (System::String value)
 Sets the additional css styles for the formatter. More...
 
System::String get_DefaultPageHeaderFormat ()
 Default page header format. More...
 
void set_DefaultPageHeaderFormat (System::String value)
 Default page header format. More...
 
System::String get_DefaultHeaderFormat ()
 Default header line format. More...
 
void set_DefaultHeaderFormat (System::String value)
 Default header line format. More...
 
System::String get_BeforeHeadersFormat ()
 Before headers format. More...
 
void set_BeforeHeadersFormat (System::String value)
 Before headers format. More...
 
System::String get_AfterHeadersFormat ()
 After headers format. More...
 
void set_AfterHeadersFormat (System::String value)
 After headers format. More...
 
System::SharedPtr< System::Collections::Specialized::StringDictionary > get_FormatTemplates () const
 Gets the format templates. More...
 
System::SharedPtr< System::Collections::Generic::ListExt< System::String > > get_RenderingHeaders () const
 Gets list of headers for rendering. More...
 
bool get_ExtractHTMLBodyResourcesAsAttachments () const
 Defines whether extract HTML body resources as attachments or not. Default value is false. More...
 
void set_ExtractHTMLBodyResourcesAsAttachments (bool value)
 Defines whether extract HTML body resources as attachments or not. Default value is false. More...
 
 HeadersFormattingOptions ()
 Initializes a new instance of this class that can be used to save a MailMessage in the Mhtml format. More...
 
void OnTimeoutReached (System::SharedPtr< MailMessage > msg)
 
virtual void OnResourceProcessing (System::SharedPtr< AttachmentBase > sender, System::SharedPtr< ResourceHtmlRenderingEventArgs > e)
 
- Public Member Functions inherited from Aspose::Email::SaveOptions
ConversionProgressEventHandler get_CustomProgressHandler () const
 Represents method that usually supplied by calling side and handles progress events. More...
 
void set_CustomProgressHandler (ConversionProgressEventHandler value)
 Represents method that usually supplied by calling side and handles progress events. More...
 
System::SharedPtr< Aspose::Email::MailMessageSaveTypeget_MailMessageSaveType () const
 Represents the mail message save type.It can be in eml,msg(ASCII or Unicode),mhtml or html format. The default value is Eml. More...
 
void set_MailMessageSaveType (System::SharedPtr< Aspose::Email::MailMessageSaveType > value)
 Represents the mail message save type.It can be in eml,msg(ASCII or Unicode),mhtml or html format. The default value is Eml. More...
 

Protected Member Functions

virtual ~HtmlSaveOptions ()
 
- Protected Member Functions inherited from Aspose::Email::HeadersFormattingOptions
virtual ~HeadersFormattingOptions ()
 
- Protected Member Functions inherited from Aspose::Email::SaveOptions
 SaveOptions ()
 Hides the class constructor. More...
 
virtual ~SaveOptions ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Aspose::Email::SaveOptions
static System::SharedPtr< EmlSaveOptionsget_DefaultEml ()
 Gets options with default values for saving message to Eml format. More...
 
static System::SharedPtr< EmlSaveOptionsget_DefaultEmlx ()
 Gets options with default values for saving message to Emlx format. More...
 
static System::SharedPtr< MsgSaveOptionsget_DefaultMsg ()
 Gets options with default values for saving message to Msg(ASCII) format. More...
 
static System::SharedPtr< MsgSaveOptionsget_DefaultMsgUnicode ()
 Gets options with default values for saving message to Msg(Unicode) format. More...
 
static System::SharedPtr< MsgSaveOptionsget_DefaultOft ()
 Gets options with default values for saving message to Outlook template (Oft) format. More...
 
static System::SharedPtr< MhtSaveOptionsget_DefaultMhtml ()
 Gets options with default values for saving message to Mhtml format. More...
 
static System::SharedPtr< HtmlSaveOptionsget_DefaultHtml ()
 Gets options with default values for saving message to Html format. More...
 
static System::SharedPtr< SaveOptionsCreateSaveOptions (System::SharedPtr< Aspose::Email::MailMessageSaveType > saveType)
 Creates a save options object of a class suitable for the specified save type. More...
 
- Public Attributes inherited from Aspose::Email::HeadersFormattingOptions
System::SharedPtr< System::Collections::Specialized::StringDictionary > formatTemplates
 
System::SharedPtr< System::Collections::Generic::ListExt< System::String > > renderingHeaders
 
System::EventHandler TimeoutReached
 Raised if timed out while saving to Mhtml. More...
 
System::EventHandler< System::SharedPtr< Aspose::Email::ResourceHtmlRenderingEventArgs > > ResourceHtmlRendering
 Provides customization of rendering resources in html. More...
 
- Static Public Attributes inherited from Aspose::Email::HeadersFormattingOptions
static const System::String MhtExportCss
 

Detailed Description

Allows to specify additional options when saving MailMessage to Html format.

Constructor & Destructor Documentation

◆ HtmlSaveOptions()

Aspose::Email::HtmlSaveOptions::HtmlSaveOptions ( )

Initializes a new instance of this class that can be used to save a MailMessage in the Html format.

◆ ~HtmlSaveOptions()

virtual Aspose::Email::HtmlSaveOptions::~HtmlSaveOptions ( )
protectedvirtual

Member Function Documentation

◆ get_CheckBodyContentEncoding()

bool Aspose::Email::HtmlSaveOptions::get_CheckBodyContentEncoding ( ) const

Defines whether need check message body content encoding when saving. By default the value is false.

If true, it will be check whether the MailMessage::HtmlBody content encoding matches to the encoding specified by the MailMessage::BodyEncoding property. If the HtmlBody content encoding doesn't match BodyEncoding property, the MailMessage::BodyEncoding and MailMessage::PreferredTextEncoding properties will be changed to default System::Text::Encoding::UTF8.

◆ get_HtmlFormatOptions()

Aspose::Email::HtmlFormatOptions Aspose::Email::HtmlSaveOptions::get_HtmlFormatOptions ( ) const

Gets additional options when saving in HTML format. Default value is HtmlFormatOptions.None.

◆ get_PathToHtmlFile()

System::String Aspose::Email::HtmlSaveOptions::get_PathToHtmlFile ( ) const

◆ get_ResourceRenderingMode()

Aspose::Email::ResourceRenderingMode Aspose::Email::HtmlSaveOptions::get_ResourceRenderingMode ( ) const

Provides set various modes of rendering resources in html. Default value EmbedIntoHtml.

◆ get_UseRelativePathToResources()

bool Aspose::Email::HtmlSaveOptions::get_UseRelativePathToResources ( ) const

Default value is false.

◆ set_CheckBodyContentEncoding()

void Aspose::Email::HtmlSaveOptions::set_CheckBodyContentEncoding ( bool  value)

Defines whether need check message body content encoding when saving. By default the value is false.

If true, it will be check whether the MailMessage::HtmlBody content encoding matches to the encoding specified by the MailMessage::BodyEncoding property. If the HtmlBody content encoding doesn't match BodyEncoding property, the MailMessage::BodyEncoding and MailMessage::PreferredTextEncoding properties will be changed to default System::Text::Encoding::UTF8.

◆ set_HtmlFormatOptions()

void Aspose::Email::HtmlSaveOptions::set_HtmlFormatOptions ( Aspose::Email::HtmlFormatOptions  value)

Sets additional options when saving in HTML format. Default value is HtmlFormatOptions.None.

◆ set_PathToHtmlFile()

void Aspose::Email::HtmlSaveOptions::set_PathToHtmlFile ( System::String  value)

◆ set_ResourceRenderingMode()

void Aspose::Email::HtmlSaveOptions::set_ResourceRenderingMode ( Aspose::Email::ResourceRenderingMode  value)

Provides set various modes of rendering resources in html. Default value EmbedIntoHtml.

◆ set_UseRelativePathToResources()

void Aspose::Email::HtmlSaveOptions::set_UseRelativePathToResources ( bool  value)

Default value is false.