Package com.groupdocs.cloud.conversion.model

Class EmailLoadOptions

java.lang.Object

com.groupdocs.cloud.conversion.model.LoadOptions

com.groupdocs.cloud.conversion.model.EmailLoadOptions

Direct Known Subclasses:

EmlLoadOptions, EmlxLoadOptions, MhtLoadOptions, MsgLoadOptions, OstLoadOptions, PstLoadOptions

public class EmailLoadOptions
extends LoadOptions

Options for loading Email documents

Constructor Summary

Constructors

Constructor	Description
EmailLoadOptions()

Method Summary

Modifier and Type	Method	Description
EmailLoadOptions	addFieldLabelsItem(FieldLabel fieldLabelsItem)
EmailLoadOptions	defaultFont(String defaultFont)
EmailLoadOptions	displayAttachments(Boolean displayAttachments)
EmailLoadOptions	displayBccEmailAddress(Boolean displayBccEmailAddress)
EmailLoadOptions	displayCcEmailAddress(Boolean displayCcEmailAddress)
EmailLoadOptions	displayEmailAddresses(Boolean displayEmailAddresses)
EmailLoadOptions	displayFromEmailAddress(Boolean displayFromEmailAddress)
EmailLoadOptions	displayHeader(Boolean displayHeader)
EmailLoadOptions	displaySent(Boolean displaySent)
EmailLoadOptions	displaySubject(Boolean displaySubject)
EmailLoadOptions	displayToEmailAddress(Boolean displayToEmailAddress)
boolean	equals(Object o)
EmailLoadOptions	fieldLabels(List<FieldLabel> fieldLabels)
EmailLoadOptions	fontSubstitutes(Map<String,String> fontSubstitutes)
String	getDefaultFont()	Default font for Email document.
Boolean	getDisplayAttachments()	Option to display or hide attachments in the header.
Boolean	getDisplayBccEmailAddress()	Option to display or hide \"Bcc\" email address.
Boolean	getDisplayCcEmailAddress()	Option to display or hide \"Cc\" email address.
Boolean	getDisplayEmailAddresses()	Get displayEmailAddresses
Boolean	getDisplayFromEmailAddress()	Option to display or hide \"from\" email address.
Boolean	getDisplayHeader()	Option to display or hide the email header.
Boolean	getDisplaySent()	Option to display or hide sent date/time in the header.
Boolean	getDisplaySubject()	Option to display or hide subject in the header.
Boolean	getDisplayToEmailAddress()	Option to display or hide \"to\" email address.
List<FieldLabel>	getFieldLabels()	The mapping between email message field and field text representation
Map<String,String>	getFontSubstitutes()	List of font substitutes.
Boolean	getPreserveOriginalDate()	Defines whether need to keep original date header string in mail message when saving or not (Default value is true)
String	getTimeZoneOffset()	Gets or sets the Coordinated Universal Time (UTC) offset for the message dates.
int	hashCode()
EmailLoadOptions	preserveOriginalDate(Boolean preserveOriginalDate)
EmailLoadOptions	putFontSubstitutesItem(String key, String fontSubstitutesItem)
void	setDefaultFont(String defaultFont)
void	setDisplayAttachments(Boolean displayAttachments)
void	setDisplayBccEmailAddress(Boolean displayBccEmailAddress)
void	setDisplayCcEmailAddress(Boolean displayCcEmailAddress)
void	setDisplayEmailAddresses(Boolean displayEmailAddresses)
void	setDisplayFromEmailAddress(Boolean displayFromEmailAddress)
void	setDisplayHeader(Boolean displayHeader)
void	setDisplaySent(Boolean displaySent)
void	setDisplaySubject(Boolean displaySubject)
void	setDisplayToEmailAddress(Boolean displayToEmailAddress)
void	setFieldLabels(List<FieldLabel> fieldLabels)
void	setFontSubstitutes(Map<String,String> fontSubstitutes)
void	setPreserveOriginalDate(Boolean preserveOriginalDate)
void	setTimeZoneOffset(String timeZoneOffset)
EmailLoadOptions	timeZoneOffset(String timeZoneOffset)
String	toString()

Methods inherited from class com.groupdocs.cloud.conversion.model.LoadOptions

format, getFormat, setFormat

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EmailLoadOptions

public EmailLoadOptions()

Method Detail

preserveOriginalDate

public EmailLoadOptions preserveOriginalDate(Boolean preserveOriginalDate)

getPreserveOriginalDate

public Boolean getPreserveOriginalDate()

Defines whether need to keep original date header string in mail message when saving or not (Default value is true)

Returns:

preserveOriginalDate

setPreserveOriginalDate

public void setPreserveOriginalDate(Boolean preserveOriginalDate)

fieldLabels

public EmailLoadOptions fieldLabels(List<FieldLabel> fieldLabels)

addFieldLabelsItem

public EmailLoadOptions addFieldLabelsItem(FieldLabel fieldLabelsItem)

getFieldLabels

public List<FieldLabel> getFieldLabels()

The mapping between email message field and field text representation

Returns:

fieldLabels

setFieldLabels

public void setFieldLabels(List<FieldLabel> fieldLabels)

timeZoneOffset

public EmailLoadOptions timeZoneOffset(String timeZoneOffset)

getTimeZoneOffset

public String getTimeZoneOffset()

Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the localtime and UTC.

Returns:

timeZoneOffset

setTimeZoneOffset

public void setTimeZoneOffset(String timeZoneOffset)

displaySent

public EmailLoadOptions displaySent(Boolean displaySent)

getDisplaySent

public Boolean getDisplaySent()

Option to display or hide sent date/time in the header. Default: true.

Returns:

displaySent

setDisplaySent

public void setDisplaySent(Boolean displaySent)

displaySubject

public EmailLoadOptions displaySubject(Boolean displaySubject)

getDisplaySubject

public Boolean getDisplaySubject()

Option to display or hide subject in the header. Default: true.

Returns:

displaySubject

setDisplaySubject

public void setDisplaySubject(Boolean displaySubject)

displayAttachments

public EmailLoadOptions displayAttachments(Boolean displayAttachments)

getDisplayAttachments

public Boolean getDisplayAttachments()

Option to display or hide attachments in the header. Default: true.

Returns:

displayAttachments

setDisplayAttachments

public void setDisplayAttachments(Boolean displayAttachments)

displayEmailAddresses

public EmailLoadOptions displayEmailAddresses(Boolean displayEmailAddresses)

getDisplayEmailAddresses

public Boolean getDisplayEmailAddresses()

Get displayEmailAddresses

Returns:

displayEmailAddresses

setDisplayEmailAddresses

public void setDisplayEmailAddresses(Boolean displayEmailAddresses)

displayBccEmailAddress

public EmailLoadOptions displayBccEmailAddress(Boolean displayBccEmailAddress)

getDisplayBccEmailAddress

public Boolean getDisplayBccEmailAddress()

Option to display or hide \"Bcc\" email address. Default: false

Returns:

displayBccEmailAddress

setDisplayBccEmailAddress

public void setDisplayBccEmailAddress(Boolean displayBccEmailAddress)

displayCcEmailAddress

public EmailLoadOptions displayCcEmailAddress(Boolean displayCcEmailAddress)

getDisplayCcEmailAddress

public Boolean getDisplayCcEmailAddress()

Option to display or hide \"Cc\" email address. Default: false

Returns:

displayCcEmailAddress

setDisplayCcEmailAddress

public void setDisplayCcEmailAddress(Boolean displayCcEmailAddress)

displayToEmailAddress

public EmailLoadOptions displayToEmailAddress(Boolean displayToEmailAddress)

getDisplayToEmailAddress

public Boolean getDisplayToEmailAddress()

Option to display or hide \"to\" email address. Default: true

Returns:

displayToEmailAddress

setDisplayToEmailAddress

public void setDisplayToEmailAddress(Boolean displayToEmailAddress)

displayFromEmailAddress

public EmailLoadOptions displayFromEmailAddress(Boolean displayFromEmailAddress)

getDisplayFromEmailAddress

public Boolean getDisplayFromEmailAddress()

Option to display or hide \"from\" email address. Default: true

Returns:

displayFromEmailAddress

setDisplayFromEmailAddress

public void setDisplayFromEmailAddress(Boolean displayFromEmailAddress)

displayHeader

public EmailLoadOptions displayHeader(Boolean displayHeader)

getDisplayHeader

public Boolean getDisplayHeader()

Option to display or hide the email header. Default: true

Returns:

displayHeader

setDisplayHeader

public void setDisplayHeader(Boolean displayHeader)

defaultFont

public EmailLoadOptions defaultFont(String defaultFont)

getDefaultFont

public String getDefaultFont()

Default font for Email document. The following font will be used if a font is missing.

Returns:

defaultFont

setDefaultFont

public void setDefaultFont(String defaultFont)

fontSubstitutes

public EmailLoadOptions fontSubstitutes(Map<String,String> fontSubstitutes)

putFontSubstitutesItem

public EmailLoadOptions putFontSubstitutesItem(String key,
                                               String fontSubstitutesItem)

getFontSubstitutes

public Map<String,String> getFontSubstitutes()

List of font substitutes.

Returns:

fontSubstitutes

setFontSubstitutes

public void setFontSubstitutes(Map<String,String> fontSubstitutes)

equals

public boolean equals(Object o)

Overrides:

equals in class LoadOptions

hashCode

public int hashCode()

Overrides:

hashCode in class LoadOptions

toString

public String toString()

Overrides:

toString in class LoadOptions