com.aspose.email

Class EmlSaveOptions

java.lang.Object

com.aspose.email.SaveOptions

com.aspose.email.EmlSaveOptions

public class EmlSaveOptions
extends SaveOptions

Allows to specify additional options when saving MailMessage to Eml and Emlx format.

The following example shows how to load and Save an EML message Preserving the embedded message format.

[Java]

 MailMessage mailMessage = MailMessage.load("source.eml");
 // Save as eml with preserved embedded message format
 EmlSaveOptions emlSaveOptions = new EmlSaveOptions(MailMessageSaveType.getEmlFormat())
 emlSaveOptions.setPreserveEmbeddedMessageFormat(true);
 mailMessage.save("target.eml", emlSaveOptions);
 

Constructor Summary

Constructors

Constructor and Description
EmlSaveOptions(MailMessageSaveType saveType) Initializes a new instance of this class that can be used to save a MailMessage in the Eml and Emlx format.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBoundariesTemplate() Gets or sets the boundary template for the message. Default value is null.
boolean	getCheckBodyContentEncoding() Defines whether need check message body content encoding when saving.
int	getFileCompatibilityMode() Defines inner conversions,that are necessarily to be done when saving a message.
boolean	getPreserveEmbeddedMessageFormat() Gets or sets a value indicating whether it is necessary to preserve MSG format of embedded message at converting to MailMessage.
boolean	getPreserveSignedContent() Gets or sets a value indicating whether it is necessary to save signed message without changes of content to provide correctly structure of digital sign.
void	setBoundariesTemplate(String value) Gets or sets the boundary template for the message. Default value is null.
void	setCheckBodyContentEncoding(boolean value) Defines whether need check message body content encoding when saving.
void	setFileCompatibilityMode(int value) Defines inner conversions,that are necessarily to be done when saving a message.
void	setPreserveEmbeddedMessageFormat(boolean value) Gets or sets a value indicating whether it is necessary to preserve MSG format of embedded message at converting to MailMessage.
void	setPreserveSignedContent(boolean value) Gets or sets a value indicating whether it is necessary to save signed message without changes of content to provide correctly structure of digital sign.

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

EmlSaveOptions

public EmlSaveOptions(MailMessageSaveType saveType)

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

Method Detail

getFileCompatibilityMode

public final int getFileCompatibilityMode()

Defines inner conversions,that are necessarily to be done when saving a message. The default value is FileCompatibilityMode.None.

setFileCompatibilityMode

public final void setFileCompatibilityMode(int value)

Defines inner conversions,that are necessarily to be done when saving a message. The default value is FileCompatibilityMode.None.

getPreserveSignedContent

public final boolean getPreserveSignedContent()

Gets or sets a value indicating whether it is necessary to save signed message without changes of content to provide correctly structure of digital sign. By default the value is false.

The property is only meaningful for signed messages; it has no effect on unsigned messages. This property is intended for some complex signed messages with detached signature generated by other clients, whose implementation differences prevent Aspose.Email from exactly replicating their MIME content generation. Saving such messages without using PreserveSignedContent will cause the signature in the saved messages to fail. Some simple messages and messages with an attached signature can be saved correctly without using this property.

setPreserveSignedContent

public final void setPreserveSignedContent(boolean value)

Gets or sets a value indicating whether it is necessary to save signed message without changes of content to provide correctly structure of digital sign. By default the value is false.

The property is only meaningful for signed messages; it has no effect on unsigned messages. This property is intended for some complex signed messages with detached signature generated by other clients, whose implementation differences prevent Aspose.Email from exactly replicating their MIME content generation. Saving such messages without using PreserveSignedContent will cause the signature in the saved messages to fail. Some simple messages and messages with an attached signature can be saved correctly without using this property.

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)) 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)) will be changed to default System.Text.Encoding.UTF8(java.nio.charset.Charset#getUTF8).

getPreserveEmbeddedMessageFormat

public final boolean getPreserveEmbeddedMessageFormat()

Gets or sets a value indicating whether it is necessary to preserve MSG format of embedded message at converting to MailMessage. 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 MSG to EML and vice versa, embedded messages are also converted to the target format. Setting the property to true preserves the original format of embedded messages.

setPreserveEmbeddedMessageFormat

public final void setPreserveEmbeddedMessageFormat(boolean value)

Gets or sets a value indicating whether it is necessary to preserve MSG format of embedded message at converting to MailMessage. 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 MSG to EML and vice versa, embedded messages are also converted to the target format. Setting the property to true preserves the original format of embedded messages.

getBoundariesTemplate

public final String getBoundariesTemplate()

Gets or sets the boundary template for the message.
Default value is null.

The '{#}' wildcard is used for the boundary number placeholder.
The '{guid}' wildcard is used for the boundary GUID placeholder.

example: boundary--{#}-{guid}

setBoundariesTemplate

public final void setBoundariesTemplate(String value)

Gets or sets the boundary template for the message.
Default value is null.

The '{#}' wildcard is used for the boundary number placeholder.
The '{guid}' wildcard is used for the boundary GUID placeholder.

example: boundary--{#}-{guid}