com.aspose.email

Class MhtSaveOptions

java.lang.Object

com.aspose.email.SaveOptions

com.aspose.email.HeadersFormattingOptions

com.aspose.email.MhtSaveOptions

public class MhtSaveOptions
extends HeadersFormattingOptions

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

The following example shows how to save MailMessage as MHTML.

[Java]

 MailMessage eml = MailMessage.load("Message.eml");
 eml.save("target.mthml", SaveOptions.getDefaultMhtml());
 

Constructor Summary

Constructors

Constructor and Description
MhtSaveOptions() Initializes a new instance of this class that can be used to save a MailMessage in the Mhtml format.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getCheckBodyContentEncoding() Defines whether need check message body content encoding when saving.
int	getMhtFormatOptions() Defines additional options when saving in MHTML format.
boolean	getPreserveOriginalBoundaries() Defines whether need keep original boundaries in mail message when saving or not.
boolean	getPreserveOriginalDate() Defines whether need keep original date in mail message when saving or not.
boolean	getSaveAllHeaders() Defines whether need to save all headers in output mhtml or not.
boolean	getSaveAttachments() Gets or sets a value indicating whether to save attachments.
List<String>	getSavedHeaders() Gets list of headers which will be present in saved mhtml content.
boolean	getSkipInlineImages() Defines whether skip references on images at saving in mhtml or not.
int	getTimeout() Limits the time in milliseconds of formatting message while saving in Mht.
TimeoutReachedHandler	getTimeoutReachedHandler() Raised if timed out while saving to Mhtml.
void	setCheckBodyContentEncoding(boolean value) Defines whether need check message body content encoding when saving.
void	setMhtFormatOptions(int value) Defines additional options when saving in MHTML format.
void	setPreserveOriginalBoundaries(boolean value) Defines whether need keep original boundaries in mail message when saving or not.
void	setPreserveOriginalDate(boolean value) Defines whether need keep original date in mail message when saving or not.
void	setSaveAllHeaders(boolean value) Defines whether need to save all headers in output mhtml or not.
void	setSaveAttachments(boolean value) Gets or sets a value indicating whether to save attachments.
void	setSkipInlineImages(boolean value) Defines whether skip references on images at saving in mhtml or not.
void	setTimeout(int value) Limits the time in milliseconds of formatting message while saving in Mht.
void	setTimeoutReachedHandler(TimeoutReachedHandler value) Raised if timed out while saving to Mhtml.

Methods inherited from class com.aspose.email.HeadersFormattingOptions

getAfterHeadersFormat, getBeforeHeadersFormat, getCssStyles, getDefaultHeaderFormat, getDefaultPageHeaderFormat, getFormatTemplates, getRenderedContactFields, getRenderingHeaders, setAfterHeadersFormat, setBeforeHeadersFormat, setCssStyles, setDefaultHeaderFormat, setDefaultPageHeaderFormat, setRenderedContactFields

Methods inherited from class com.aspose.email.SaveOptions

createSaveOptions, getCustomProgressHandler, getDefaultEml, getDefaultEmlx, getDefaultHtml, getDefaultMhtml, getDefaultMsg, getDefaultMsgUnicode, getDefaultOft, getMailMessageSaveType, setCustomProgressHandler, setMailMessageSaveType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MhtSaveOptions

public MhtSaveOptions()

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

Method Detail

getTimeoutReachedHandler

public final TimeoutReachedHandler getTimeoutReachedHandler()

Raised if timed out while saving to Mhtml.

setTimeoutReachedHandler

public final void setTimeoutReachedHandler(TimeoutReachedHandler value)

Raised if timed out while saving to Mhtml.

getTimeout

public final int getTimeout()

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

setTimeout

public final void setTimeout(int value)

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

getMhtFormatOptions

public final int getMhtFormatOptions()

Defines additional options when saving in MHTML format. Default value is MhtFormatOptions.WriteHeader | MhtFormatOptions.WriteOutlineAttachments.

setMhtFormatOptions

public final void setMhtFormatOptions(int value)

Defines additional options when saving in MHTML format. Default value is MhtFormatOptions.WriteHeader | MhtFormatOptions.WriteOutlineAttachments.

getPreserveOriginalBoundaries

public final boolean getPreserveOriginalBoundaries()

Defines whether need keep original boundaries in mail message when saving or not.

setPreserveOriginalBoundaries

public final void setPreserveOriginalBoundaries(boolean value)

Defines whether need keep original boundaries in mail message when saving or not.

getCheckBodyContentEncoding

public final boolean getCheckBodyContentEncoding()

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(MailMessage.getHtmlBody()/MailMessage.setHtmlBody(String)) content encoding matches to the encoding specified by the MailMessage.BodyEncoding(MailMessage.getBodyEncoding()/MailMessage#setBodyEncoding(Encoding)) property. If the HtmlBody content encoding doesn't match BodyEncoding property, the MailMessage.BodyEncoding(MailMessage.getBodyEncoding()/MailMessage#setBodyEncoding(Encoding)) and MailMessage.PreferredTextEncoding(MailMessage.getPreferredTextEncoding()/MailMessage#setPreferredTextEncoding(Encoding)) properties will be changed to default System.Text.Encoding.UTF8(java.nio.charset.Charset#getUTF8).

setCheckBodyContentEncoding

public final void setCheckBodyContentEncoding(boolean 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(MailMessage.getHtmlBody()/MailMessage.setHtmlBody(String)) content encoding matches to the encoding specified by the MailMessage.BodyEncoding(MailMessage.getBodyEncoding()/MailMessage#setBodyEncoding(Encoding)) property. If the HtmlBody content encoding doesn't match BodyEncoding property, the MailMessage.BodyEncoding(MailMessage.getBodyEncoding()/MailMessage#setBodyEncoding(Encoding)) and MailMessage.PreferredTextEncoding(MailMessage.getPreferredTextEncoding()/MailMessage#setPreferredTextEncoding(Encoding)) properties will be changed to default System.Text.Encoding.UTF8(java.nio.charset.Charset#getUTF8).

getSaveAttachments

public final boolean getSaveAttachments()

Gets or sets a value indicating whether to save attachments.

Value: true if attachments should be saved; otherwise, false.

setSaveAttachments

public final void setSaveAttachments(boolean value)

Gets or sets a value indicating whether to save attachments.

Value: true if attachments should be saved; otherwise, false.

getPreserveOriginalDate

public final boolean getPreserveOriginalDate()

Defines whether need keep original date in mail message when saving or not. Default value is true.

setPreserveOriginalDate

public final void setPreserveOriginalDate(boolean value)

Defines whether need keep original date in mail message when saving or not. Default value is true.

getSkipInlineImages

public final boolean getSkipInlineImages()

Defines whether skip references on images at saving in mhtml or not. Default value is false.

setSkipInlineImages

public final void setSkipInlineImages(boolean value)

Defines whether skip references on images at saving in mhtml or not. Default value is false.

getSaveAllHeaders

public final boolean getSaveAllHeaders()

Defines whether need to save all headers in output mhtml or not. Default value is false.

setSaveAllHeaders

public final void setSaveAllHeaders(boolean value)

Defines whether need to save all headers in output mhtml or not. Default value is false.

getSavedHeaders

public final List<String> getSavedHeaders()

Gets list of headers which will be present in saved mhtml content. Default value is empty list.