com.aspose.email

Class LoadOptions

java.lang.Object

com.aspose.email.LoadOptions

Direct Known Subclasses:

EmlLoadOptions, EmlxLoadOptions, HtmlLoadOptions, MhtmlLoadOptions, MsgLoadOptions, TnefLoadOptions

public abstract class LoadOptions
extends Object

This is an abstract base class for classes that allow the user to specify additional options when loading a MailMessage from a particular format.

Constructor Summary

Constructors

Constructor and Description
LoadOptions()

Method Summary

Methods

Modifier and Type	Method and Description
MessageFormat	getMessageFormat() Represents the mail message format.It can be in eml,msg or mhtml format.
Charset	getPreferredTextEncoding() Gets or sets preferred encoding for message.
boolean	getPreserveEmbeddedMessageFormat() Gets or sets a value indicating whether it is necessary to preserve format of embedded message at loading.
boolean	getRemoveSignature() Gets or sets a value indicating whether signature will be removed while loading.
void	setPreferredTextEncoding(Charset value) Gets or sets preferred encoding for message.
void	setPreserveEmbeddedMessageFormat(boolean value) Gets or sets a value indicating whether it is necessary to preserve format of embedded message at loading.
void	setRemoveSignature(boolean value) Gets or sets a value indicating whether signature will be removed while loading.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadOptions

public LoadOptions()

Method Detail

getPreferredTextEncoding

public final Charset getPreferredTextEncoding()

Gets or sets preferred encoding for message. Forcibly sets the preferred encoding for message subject and body. The default value is null.

setPreferredTextEncoding

public final void setPreferredTextEncoding(Charset value)

Gets or sets preferred encoding for message. Forcibly sets the preferred encoding for message subject and body. The default value is null.

getMessageFormat

public final MessageFormat getMessageFormat()

Represents the mail message format.It can be in eml,msg or mhtml format. The default value is Eml.

getPreserveEmbeddedMessageFormat

public final boolean getPreserveEmbeddedMessageFormat()

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

getRemoveSignature

public final boolean getRemoveSignature()

Gets or sets a value indicating whether signature will be removed while loading.

Value: true if will be removed; otherwise, false.

setRemoveSignature

public final void setRemoveSignature(boolean value)

Gets or sets a value indicating whether signature will be removed while loading.

Value: true if will be removed; otherwise, false.