EmailLoadOptions
Inheritance: java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
All Implemented Interfaces: com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions, java.lang.Cloneable, java.io.Serializable
public final class EmailLoadOptions extends LoadOptions implements IDocumentsContainerLoadOptions, Cloneable, Serializable
Options for loading Email documents.
Constructors
| Constructor | Description |
|---|---|
| EmailLoadOptions() | Initializes new instance of EmailLoadOptions class. |
Methods
| Method | Description |
|---|---|
| getFormat() | |
| getDisplayHeader() | Option to display or hide the email header. |
| setDisplayHeader(boolean value) | Option to display or hide the email header. |
| getDisplayFromEmailAddress() | Option to display or hide “from” email address. |
| setDisplayFromEmailAddress(boolean value) | Option to display or hide “from” email address. |
| getDisplayToEmailAddress() | Option to display or hide “to” email address. |
| setDisplayToEmailAddress(boolean value) | Option to display or hide “to” email address. |
| getDisplayCcEmailAddress() | Option to display or hide “Cc” email address. |
| setDisplayCcEmailAddress(boolean value) | Option to display or hide “Cc” email address. |
| getDisplayBccEmailAddress() | Option to display or hide “Bcc” email address. |
| setDisplayBccEmailAddress(boolean value) | Option to display or hide “Bcc” email address. |
| getTimeZoneOffset() | Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. |
| getTimeZoneOffsetInternal() | |
| getResourceLoadingTimeout() | Timeout for loading external resources |
| setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout) | Timeout for loading external resources (setter) |
| setTimeZoneOffset(Double value) | Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. |
| deepClone() | Clones current instance. |
| getFieldTextMap() | Gets the mapping between email message and field text representation |
| setFieldTextMap(Map<EmailField,String> fieldTextMap) | Sets the mapping between email message and field text representation |
| isPreserveOriginalDate() | Defines whether need to keep original date header string in mail message when saving or not (Default value is true) |
| setPreserveOriginalDate(boolean preserveOriginalDate) | Defines whether need to keep original date header string in mail message when saving or not |
| isConvertOwner() | |
| setConvertOwner(boolean convertOwner) | |
| isConvertOwned() | |
| setConvertOwned(boolean convertOwned) | |
| getDepth() | |
| setDepth(int depth) | |
| isDisplayAttachments() | Gets option to display or hide attachments in the header. |
| setDisplayAttachments(boolean displayAttachments) | Sets option to display or hide attachments in the header. |
| isDisplaySubject() | Gets option to display or hide subject in the header. |
| setDisplaySubject(boolean displaySubject) | Sets option to display or hide subject in the header |
| isDisplaySent() | Gets option to display or hide sent date/time in the header. |
| setDisplaySent(boolean displaySent) | Sets option to display or hide sent date/time in the header. |
EmailLoadOptions()
public EmailLoadOptions()
Initializes new instance of EmailLoadOptions class.
getFormat()
public final EmailFileType getFormat()
Input document file type
Returns: EmailFileType
getDisplayHeader()
public final boolean getDisplayHeader()
Option to display or hide the email header. Default: true.
Returns: boolean
setDisplayHeader(boolean value)
public final void setDisplayHeader(boolean value)
Option to display or hide the email header. Default: true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getDisplayFromEmailAddress()
public final boolean getDisplayFromEmailAddress()
Option to display or hide “from” email address. Default: true.
Returns: boolean
setDisplayFromEmailAddress(boolean value)
public final void setDisplayFromEmailAddress(boolean value)
Option to display or hide “from” email address. Default: true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getDisplayToEmailAddress()
public final boolean getDisplayToEmailAddress()
Option to display or hide “to” email address. Default: true.
Returns: boolean
setDisplayToEmailAddress(boolean value)
public final void setDisplayToEmailAddress(boolean value)
Option to display or hide “to” email address. Default: true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getDisplayCcEmailAddress()
public final boolean getDisplayCcEmailAddress()
Option to display or hide “Cc” email address. Default: false.
Returns: boolean
setDisplayCcEmailAddress(boolean value)
public final void setDisplayCcEmailAddress(boolean value)
Option to display or hide “Cc” email address. Default: false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getDisplayBccEmailAddress()
public final boolean getDisplayBccEmailAddress()
Option to display or hide “Bcc” email address. Default: false.
Returns: boolean
setDisplayBccEmailAddress(boolean value)
public final void setDisplayBccEmailAddress(boolean value)
Option to display or hide “Bcc” email address. Default: false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getTimeZoneOffset()
public final Double 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: java.lang.Double
getTimeZoneOffsetInternal()
public System.TimeSpan getTimeZoneOffsetInternal()
Returns: com.aspose.ms.System.TimeSpan
getResourceLoadingTimeout()
public System.TimeSpan getResourceLoadingTimeout()
Timeout for loading external resources
Returns: com.aspose.ms.System.TimeSpan
setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout)
public void setResourceLoadingTimeout(System.TimeSpan resourceLoadingTimeout)
Timeout for loading external resources (setter)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| resourceLoadingTimeout | com.aspose.ms.System.TimeSpan |
setTimeZoneOffset(Double value)
public final void setTimeZoneOffset(Double value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Double |
deepClone()
public final Object deepClone()
Clones current instance.
Returns: java.lang.Object -
getFieldTextMap()
public Map<EmailField,String> getFieldTextMap()
Gets the mapping between email message and field text representation
Returns: java.util.Map<com.groupdocs.conversion.options.load.EmailField,java.lang.String> - mapping
setFieldTextMap(Map<EmailField,String> fieldTextMap)
public void setFieldTextMap(Map<EmailField,String> fieldTextMap)
Sets the mapping between email message and field text representation
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fieldTextMap | java.util.Map<com.groupdocs.conversion.options.load.EmailField,java.lang.String> | mapping |
isPreserveOriginalDate()
public boolean isPreserveOriginalDate()
Defines whether need to keep original date header string in mail message when saving or not (Default value is true)
Returns: boolean - preserve original date if true
setPreserveOriginalDate(boolean preserveOriginalDate)
public void setPreserveOriginalDate(boolean preserveOriginalDate)
Defines whether need to keep original date header string in mail message when saving or not
Parameters:
| Parameter | Type | Description |
|---|---|---|
| preserveOriginalDate | boolean | preserve original date |
isConvertOwner()
public boolean isConvertOwner()
Gets option to control whether the documents container itself must be converted
Returns: boolean
setConvertOwner(boolean convertOwner)
public void setConvertOwner(boolean convertOwner)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| convertOwner | boolean |
isConvertOwned()
public boolean isConvertOwned()
Option to control whether the owned documents in the documents container must be converted
Returns: boolean
setConvertOwned(boolean convertOwned)
public void setConvertOwned(boolean convertOwned)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| convertOwned | boolean |
getDepth()
public int getDepth()
Option to control how many levels in depth to perform conversion
Returns: int
setDepth(int depth)
public void setDepth(int depth)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| depth | int |
isDisplayAttachments()
public boolean isDisplayAttachments()
Gets option to display or hide attachments in the header. Default: true.
Returns: boolean
setDisplayAttachments(boolean displayAttachments)
public void setDisplayAttachments(boolean displayAttachments)
Sets option to display or hide attachments in the header.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| displayAttachments | boolean |
isDisplaySubject()
public boolean isDisplaySubject()
Gets option to display or hide subject in the header. Default: true.
Returns: boolean
setDisplaySubject(boolean displaySubject)
public void setDisplaySubject(boolean displaySubject)
Sets option to display or hide subject in the header
Parameters:
| Parameter | Type | Description |
|---|---|---|
| displaySubject | boolean |
isDisplaySent()
public boolean isDisplaySent()
Gets option to display or hide sent date/time in the header. Default: true.
Returns: boolean
setDisplaySent(boolean displaySent)
public void setDisplaySent(boolean displaySent)
Sets option to display or hide sent date/time in the header.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| displaySent | boolean |