SaveOptions

Inheritance: java.lang.Object

public abstract class SaveOptions

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

Methods

Method Description
getCustomProgressHandler() Represents method that usually supplied by calling side and handles progress events.
setCustomProgressHandler(ConversionProgressEventHandler value) Represents method that usually supplied by calling side and handles progress events.
getMailMessageSaveType() Represents the mail message save type.It can be in eml,msg(ASCII or Unicode),mhtml or html format.
setMailMessageSaveType(MailMessageSaveType value) Represents the mail message save type.It can be in eml,msg(ASCII or Unicode),mhtml or html format.
getDefaultEml() Gets options with default values for saving message to Eml format.
getDefaultMsg() Gets options with default values for saving message to Msg(ASCII) format.
getDefaultMsgUnicode() Gets options with default values for saving message to Msg(Unicode) format.
getDefaultMhtml() Gets options with default values for saving message to Mhtml format.
getDefaultHtml() Gets options with default values for saving message to Html format.
createSaveOptions(MailMessageSaveType saveType) Creates a save options object of a class suitable for the specified save type.

getCustomProgressHandler()

public final ConversionProgressEventHandler getCustomProgressHandler()

Represents method that usually supplied by calling side and handles progress events.

Returns: ConversionProgressEventHandler

setCustomProgressHandler(ConversionProgressEventHandler value)

public final void setCustomProgressHandler(ConversionProgressEventHandler value)

Represents method that usually supplied by calling side and handles progress events.

Parameters:

Parameter Type Description
value ConversionProgressEventHandler

getMailMessageSaveType()

public final MailMessageSaveType getMailMessageSaveType()

Represents the mail message save type.It can be in eml,msg(ASCII or Unicode),mhtml or html format. The default value is Eml.

Returns: MailMessageSaveType

setMailMessageSaveType(MailMessageSaveType value)

public final void setMailMessageSaveType(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.

Parameters:

Parameter Type Description
value MailMessageSaveType

getDefaultEml()

public static EmlSaveOptions getDefaultEml()

Gets options with default values for saving message to Eml format.

Returns: EmlSaveOptions

getDefaultMsg()

public static MsgSaveOptions getDefaultMsg()

Gets options with default values for saving message to Msg(ASCII) format.

Returns: MsgSaveOptions

getDefaultMsgUnicode()

public static MsgSaveOptions getDefaultMsgUnicode()

Gets options with default values for saving message to Msg(Unicode) format.

Returns: MsgSaveOptions

getDefaultMhtml()

public static MhtSaveOptions getDefaultMhtml()

Gets options with default values for saving message to Mhtml format.

Returns: MhtSaveOptions

getDefaultHtml()

public static HtmlSaveOptions getDefaultHtml()

Gets options with default values for saving message to Html format.

Returns: HtmlSaveOptions

createSaveOptions(MailMessageSaveType saveType)

public static SaveOptions createSaveOptions(MailMessageSaveType saveType)

Creates a save options object of a class suitable for the specified save type.

Parameters:

Parameter Type Description
saveType MailMessageSaveType The ``` MailMessageSaveTypesave type ```(#getMailMessageSaveType/#setMailMessageSaveType(MailMessageSaveType)) for which to create a save options object.

Returns: SaveOptions - An object of a class that derives from SaveOptions.