public abstract class SaveOptions extends Object
This is an abstract base class for classes that allow the user to specify additional options when saving a MailMessage into a particular format.
Modifier | Constructor and Description |
---|---|
protected |
SaveOptions()
Hides the class constructor.
|
Modifier and Type | Method and Description |
---|---|
static SaveOptions |
createSaveOptions(MailMessageSaveType saveType)
Creates a save options object of a class suitable for the specified save type.
|
ConversionProgressEventHandler |
getCustomProgressHandler()
Represents method that usually supplied by calling side and handles progress events.
|
static EmlSaveOptions |
getDefaultEml()
Gets options with default values for saving message to Eml format.
|
static HtmlSaveOptions |
getDefaultHtml()
Gets options with default values for saving message to Html format.
|
static MhtSaveOptions |
getDefaultMhtml()
Gets options with default values for saving message to Mhtml format.
|
static MsgSaveOptions |
getDefaultMsg()
Gets options with default values for saving message to Msg(ASCII) format.
|
static MsgSaveOptions |
getDefaultMsgUnicode()
Gets options with default values for saving message to Msg(Unicode) format.
|
MailMessageSaveType |
getMailMessageSaveType()
Represents the mail message save type.It can be in eml,msg(ASCII or Unicode),mhtml or html format.
|
void |
setCustomProgressHandler(ConversionProgressEventHandler value)
Represents method that usually supplied by calling side and handles progress events.
|
void |
setMailMessageSaveType(MailMessageSaveType value)
Represents the mail message save type.It can be in eml,msg(ASCII or Unicode),mhtml or html format.
|
public final ConversionProgressEventHandler getCustomProgressHandler()
Represents method that usually supplied by calling side and handles progress events.
public final void setCustomProgressHandler(ConversionProgressEventHandler value)
Represents method that usually supplied by calling side and handles progress events.
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.
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.
public static EmlSaveOptions getDefaultEml()
Gets options with default values for saving message to Eml format.
public static MsgSaveOptions getDefaultMsg()
Gets options with default values for saving message to Msg(ASCII) format.
public static MsgSaveOptions getDefaultMsgUnicode()
Gets options with default values for saving message to Msg(Unicode) format.
public static MhtSaveOptions getDefaultMhtml()
Gets options with default values for saving message to Mhtml format.
public static HtmlSaveOptions getDefaultHtml()
Gets options with default values for saving message to Html format.
public static SaveOptions createSaveOptions(MailMessageSaveType saveType)
Creates a save options object of a class suitable for the specified save type.
saveType
- The MailMessageSaveTypesave type
(getMailMessageSaveType()
/setMailMessageSaveType(MailMessageSaveType)
) for which to create a save options object.SaveOptions
.