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
 If true then resources will be saved in folder htmlFileName.files in the same folder that html file and the relative path to resources will be added in html content , otherwise absolute path from ResourceHtmlRenderingEventArgs.PathToResourceFile property will be used for saving resources and adding to html. It make sense if ResourceRenderingMode is ResourceRenderingMode.SaveToFile. Default value is false. More...
 
void set_UseRelativePathToResources (bool value)
 If true then resources will be saved in folder htmlFileName.files in the same folder that html file and the relative path to resources will be added in html content , otherwise absolute path from ResourceHtmlRenderingEventArgs.PathToResourceFile property will be used for saving resources and adding to html. It make sense if ResourceRenderingMode is ResourceRenderingMode.SaveToFile. Default value is false. More...
 
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...
 
virtual void OnResourceProcessing (System::SharedPtr< AttachmentBase > sender, System::SharedPtr< ResourceHtmlRenderingEventArgs > e)
 
- Public Member Functions inherited from Aspose::Email::HeadersFormattingOptions
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...
 
 HeadersFormattingOptions ()
 Initializes a new instance of this class that can be used to save a MailMessage in the Mhtml format. More...
 
- 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...
 

Public Attributes

System::EventHandler< System::SharedPtr< ResourceHtmlRenderingEventArgs > > ResourceHtmlRendering
 Provides customization of rendering resources in html. More...
 
- Public Attributes inherited from Aspose::Email::HeadersFormattingOptions
System::SharedPtr< System::Collections::Specialized::StringDictionary > formatTemplates
 
System::SharedPtr< System::Collections::Generic::ListExt< System::String > > renderingHeaders
 

Friends

class Aspose::Email::MailMessage
 

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...
 
- Static Public Attributes inherited from Aspose::Email::HeadersFormattingOptions
static const System::String MhtExportCss
 
- Protected Member Functions inherited from Aspose::Email::SaveOptions
 SaveOptions ()
 Hides the class constructor. More...
 

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.

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

If true then resources will be saved in folder htmlFileName.files in the same folder that html file and the relative path to resources will be added in html content , otherwise absolute path from ResourceHtmlRenderingEventArgs.PathToResourceFile property will be used for saving resources and adding to html. It make sense if ResourceRenderingMode is ResourceRenderingMode.SaveToFile. Default value is false.

◆ OnResourceProcessing()

virtual void Aspose::Email::HtmlSaveOptions::OnResourceProcessing ( System::SharedPtr< AttachmentBase sender,
System::SharedPtr< ResourceHtmlRenderingEventArgs e 
)
virtual

◆ 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)

If true then resources will be saved in folder htmlFileName.files in the same folder that html file and the relative path to resources will be added in html content , otherwise absolute path from ResourceHtmlRenderingEventArgs.PathToResourceFile property will be used for saving resources and adding to html. It make sense if ResourceRenderingMode is ResourceRenderingMode.SaveToFile. Default value is false.

Friends And Related Function Documentation

◆ Aspose::Email::MailMessage

friend class Aspose::Email::MailMessage
friend

Member Data Documentation

◆ ResourceHtmlRendering

System::EventHandler<System::SharedPtr<ResourceHtmlRenderingEventArgs> > Aspose::Email::HtmlSaveOptions::ResourceHtmlRendering

Provides customization of rendering resources in html.