Aspose::Email::HeadersFormattingOptions Class Reference

Allows to specify headers formatting options when saving MailMessage to Mhtml or Html format. More...

Inherits Aspose::Email::SaveOptions.

Inherited by Aspose::Email::HtmlSaveOptions, and Aspose::Email::MhtSaveOptions.

Public Member Functions
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::MailMessageSaveType >	get_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::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
static const System::String	MhtExportCss

Protected Member Functions
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< EmlSaveOptions >	get_DefaultEml ()
	Gets options with default values for saving message to Eml format. More...
static System::SharedPtr< EmlSaveOptions >	get_DefaultEmlx ()
	Gets options with default values for saving message to Emlx format. More...
static System::SharedPtr< MsgSaveOptions >	get_DefaultMsg ()
	Gets options with default values for saving message to Msg(ASCII) format. More...
static System::SharedPtr< MsgSaveOptions >	get_DefaultMsgUnicode ()
	Gets options with default values for saving message to Msg(Unicode) format. More...
static System::SharedPtr< MsgSaveOptions >	get_DefaultOft ()
	Gets options with default values for saving message to Outlook template (Oft) format. More...
static System::SharedPtr< MhtSaveOptions >	get_DefaultMhtml ()
	Gets options with default values for saving message to Mhtml format. More...
static System::SharedPtr< HtmlSaveOptions >	get_DefaultHtml ()
	Gets options with default values for saving message to Html format. More...
static System::SharedPtr< SaveOptions >	CreateSaveOptions (System::SharedPtr< Aspose::Email::MailMessageSaveType > saveType)
	Creates a save options object of a class suitable for the specified save type. More...

Detailed Description

Allows to specify headers formatting options when saving MailMessage to Mhtml or Html format.

Constructor & Destructor Documentation

HeadersFormattingOptions()

Aspose::Email::HeadersFormattingOptions::HeadersFormattingOptions

(

)

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

~HeadersFormattingOptions()

virtual Aspose::Email::HeadersFormattingOptions::~HeadersFormattingOptions ( )

protectedvirtual

Member Function Documentation

get_AfterHeadersFormat()

System::String Aspose::Email::HeadersFormattingOptions::get_AfterHeadersFormat

(

)

After headers format.

The styles to be injected into resulting html body.

get_BeforeHeadersFormat()

System::String Aspose::Email::HeadersFormattingOptions::get_BeforeHeadersFormat

(

)

Before headers format.

The styles to be injected into resulting html body.

get_CssStyles()

System::String Aspose::Email::HeadersFormattingOptions::get_CssStyles

(

)

const

Gets the additional css styles for the formatter.

The styles to be injected into resulting html body.

get_DefaultHeaderFormat()

System::String Aspose::Email::HeadersFormattingOptions::get_DefaultHeaderFormat

(

)

Default header line format.

The styles to be injected into resulting html body.

get_DefaultPageHeaderFormat()

System::String Aspose::Email::HeadersFormattingOptions::get_DefaultPageHeaderFormat

(

)

Default page header format.

The styles to be injected into resulting html body.

get_ExtractHTMLBodyResourcesAsAttachments()

bool Aspose::Email::HeadersFormattingOptions::get_ExtractHTMLBodyResourcesAsAttachments

(

)

const

Defines whether extract HTML body resources as attachments or not. Default value is false.

get_FormatTemplates()

System::SharedPtr<System::Collections::Specialized::StringDictionary> Aspose::Email::HeadersFormattingOptions::get_FormatTemplates

(

)

const

Gets the format templates.

The format templates.

get_RenderedContactFields()

ContactFieldsSet Aspose::Email::HeadersFormattingOptions::get_RenderedContactFields

(

)

const

Defines groups of Contact fields which will be included in output mhtml. Default value is ContactFieldsSet.AllExisting.

get_RenderingHeaders()

System::SharedPtr<System::Collections::Generic::ListExt<System::String> > Aspose::Email::HeadersFormattingOptions::get_RenderingHeaders

(

)

const

Gets list of headers for rendering.

get_Timeout()

int32_t Aspose::Email::HeadersFormattingOptions::get_Timeout

(

)

const

Limits the time in milliseconds of formatting message while saving in Mht. Default value 3 sec.

OnResourceProcessing()

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

virtual

OnTimeoutReached()

void Aspose::Email::HeadersFormattingOptions::OnTimeoutReached

(

System::SharedPtr< MailMessage >

msg

)

set_AfterHeadersFormat()

void Aspose::Email::HeadersFormattingOptions::set_AfterHeadersFormat

(

System::String

value

)

After headers format.

The styles to be injected into resulting html body.

set_BeforeHeadersFormat()

void Aspose::Email::HeadersFormattingOptions::set_BeforeHeadersFormat

(

System::String

value

)

Before headers format.

The styles to be injected into resulting html body.

set_CssStyles()

void Aspose::Email::HeadersFormattingOptions::set_CssStyles

(

System::String

value

)

Sets the additional css styles for the formatter.

The styles to be injected into resulting html body.

set_DefaultHeaderFormat()

void Aspose::Email::HeadersFormattingOptions::set_DefaultHeaderFormat

(

System::String

value

)

Default header line format.

The styles to be injected into resulting html body.

set_DefaultPageHeaderFormat()

void Aspose::Email::HeadersFormattingOptions::set_DefaultPageHeaderFormat

(

System::String

value

)

Default page header format.

The styles to be injected into resulting html body.

set_ExtractHTMLBodyResourcesAsAttachments()

void Aspose::Email::HeadersFormattingOptions::set_ExtractHTMLBodyResourcesAsAttachments

(

bool

value

)

Defines whether extract HTML body resources as attachments or not. Default value is false.

set_RenderedContactFields()

void Aspose::Email::HeadersFormattingOptions::set_RenderedContactFields

(

ContactFieldsSet

value

)

Defines groups of Contact fields which will be included in output mhtml. Default value is ContactFieldsSet.AllExisting.

set_Timeout()

void Aspose::Email::HeadersFormattingOptions::set_Timeout

(

int32_t

value

)

Limits the time in milliseconds of formatting message while saving in Mht. Default value 3 sec.

Member Data Documentation

formatTemplates

System::SharedPtr<System::Collections::Specialized::StringDictionary> Aspose::Email::HeadersFormattingOptions::formatTemplates

MhtExportCss

const System::String Aspose::Email::HeadersFormattingOptions::MhtExportCss

static

renderingHeaders

System::SharedPtr<System::Collections::Generic::ListExt<System::String> > Aspose::Email::HeadersFormattingOptions::renderingHeaders

ResourceHtmlRendering

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

Provides customization of rendering resources in html.

TimeoutReached

System::EventHandler Aspose::Email::HeadersFormattingOptions::TimeoutReached

Raised if timed out while saving to Mhtml.