LoadOptions

Inheritance: java.lang.Object

public abstract class LoadOptions

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

Constructors

ConstructorDescription
LoadOptions()

Methods

MethodDescription
equals(Object arg0)
getClass()
getMessageFormat()Represents the mail message format.It can be in eml,msg or mhtml format.
getPreferredTextEncoding()Gets or sets preferred encoding for message.
getPreserveEmbeddedMessageFormat()Gets or sets a value indicating whether it is necessary to preserve format of embedded message at loading.
getRemoveSignature()Gets or sets a value indicating whether signature will be removed while loading.
hashCode()
notify()
notifyAll()
setPreferredTextEncoding(Charset value)Gets or sets preferred encoding for message.
setPreserveEmbeddedMessageFormat(boolean value)Gets or sets a value indicating whether it is necessary to preserve format of embedded message at loading.
setRemoveSignature(boolean value)Gets or sets a value indicating whether signature will be removed while loading.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

LoadOptions()

public LoadOptions()

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getMessageFormat()

public final MessageFormat getMessageFormat()

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

Returns: MessageFormat

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.

Returns: java.nio.charset.Charset

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.

Returns: boolean

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 .

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setPreferredTextEncoding(Charset value)

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.

Parameters:

ParameterTypeDescription
valuejava.nio.charset.Charset

setPreserveEmbeddedMessageFormat(boolean value)

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.

Parameters:

ParameterTypeDescription
valueboolean

setRemoveSignature(boolean value)

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 .

Parameters:

ParameterTypeDescription
valueboolean

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int