EmailLoadOptions

Packages

java.lang.Object
- com.groupdocs.conversion.contracts.ValueObject
- - com.groupdocs.conversion.options.load.LoadOptions
  - - com.groupdocs.conversion.options.load.EmailLoadOptions

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<ValueObject>, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions, Serializable, Cloneable
```
public final class EmailLoadOptions
extends LoadOptions
implements com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions, Cloneable, Serializable
```
Options for loading Email documents.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

EmailLoadOptions()
Initializes new instance of EmailLoadOptions class.

Constructors
Constructor and Description
`EmailLoadOptions()` Initializes new instance of `EmailLoadOptions` class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`deepClone()` Clones current instance.
`int`	`getDepth()` Option to control how many levels in depth to perform conversion
`boolean`	`getDisplayBccEmailAddress()` Option to display or hide "Bcc" email address.
`boolean`	`getDisplayCcEmailAddress()` Option to display or hide "Cc" email address.
`boolean`	`getDisplayEmailAddress()` Option to display or hide email address.
`boolean`	`getDisplayFromEmailAddress()` Option to display or hide "from" email address.
`boolean`	`getDisplayHeader()` Option to display or hide the email header.
`boolean`	`getDisplayToEmailAddress()` Option to display or hide "to" email address.
`Map<EmailField,String>`	`getFieldTextMap()` Gets the mapping between email message and field text representation
`EmailFileType`	`getFormat()` Input document file type
`com.aspose.ms.System.TimeSpan`	`getResourceLoadingTimeout()` Timeout for loading external resources
`Double`	`getTimeZoneOffset()` Gets or sets the Coordinated Universal Time (UTC) offset for the message dates.
`com.aspose.ms.System.TimeSpan`	`getTimeZoneOffsetInternal()`
`boolean`	`isConvertOwned()` Option to control whether the owned documents in the documents container must be converted
`boolean`	`isConvertOwner()` Gets option to control whether the documents container itself must be converted
`boolean`	`isPreserveOriginalDate()` Defines whether need to keep original date header string in mail message when saving or not (Default value is true)
`void`	`setConvertOwned(boolean convertOwned)`
`void`	`setConvertOwner(boolean convertOwner)`
`void`	`setDepth(int depth)`
`void`	`setDisplayBccEmailAddress(boolean value)` Option to display or hide "Bcc" email address.
`void`	`setDisplayCcEmailAddress(boolean value)` Option to display or hide "Cc" email address.
`void`	`setDisplayEmailAddress(boolean value)` Option to display or hide email address.
`void`	`setDisplayFromEmailAddress(boolean value)` Option to display or hide "from" email address.
`void`	`setDisplayHeader(boolean value)` Option to display or hide the email header.
`void`	`setDisplayToEmailAddress(boolean value)` Option to display or hide "to" email address.
`void`	`setFieldTextMap(Map<EmailField,String> fieldTextMap)` Sets the mapping between email message and field text representation
`void`	`setPreserveOriginalDate(boolean preserveOriginalDate)` Defines whether need to keep original date header string in mail message when saving or not
`void`	`setResourceLoadingTimeout(com.aspose.ms.System.TimeSpan resourceLoadingTimeout)` Timeout for loading external resources (setter)
`void`	`setTimeZoneOffset(Double value)` Gets or sets the Coordinated Universal Time (UTC) offset for the message dates.

Methods inherited from class com.groupdocs.conversion.options.load.LoadOptions
setFormat

Methods inherited from class com.groupdocs.conversion.contracts.ValueObject
equals, equals, hashCode, op_Equality, op_Inequality

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EmailLoadOptions
```
public EmailLoadOptions()
```
    Initializes new instance of EmailLoadOptions class.
- Method Detail
  - getFormat
```
public final EmailFileType getFormat()
```
    Description copied from class: LoadOptions
    
    Input document file type
    
    Overrides:
    
    getFormat in class LoadOptions
  - getDisplayHeader
```
public final boolean getDisplayHeader()
```
    Option to display or hide the email header. Default: true.
  - setDisplayHeader
```
public final void setDisplayHeader(boolean value)
```
    Option to display or hide the email header. Default: true.
  - getDisplayFromEmailAddress
```
public final boolean getDisplayFromEmailAddress()
```
    Option to display or hide "from" email address. Default: true.
  - setDisplayFromEmailAddress
```
public final void setDisplayFromEmailAddress(boolean value)
```
    Option to display or hide "from" email address. Default: true.
  - getDisplayEmailAddress
```
public final boolean getDisplayEmailAddress()
```
    Option to display or hide email address. Default: true.
  - setDisplayEmailAddress
```
public final void setDisplayEmailAddress(boolean value)
```
    Option to display or hide email address. Default: true.
  - getDisplayToEmailAddress
```
public final boolean getDisplayToEmailAddress()
```
    Option to display or hide "to" email address. Default: true.
  - setDisplayToEmailAddress
```
public final void setDisplayToEmailAddress(boolean value)
```
    Option to display or hide "to" email address. Default: true.
  - getDisplayCcEmailAddress
```
public final boolean getDisplayCcEmailAddress()
```
    Option to display or hide "Cc" email address. Default: false.
  - setDisplayCcEmailAddress
```
public final void setDisplayCcEmailAddress(boolean value)
```
    Option to display or hide "Cc" email address. Default: false.
  - getDisplayBccEmailAddress
```
public final boolean getDisplayBccEmailAddress()
```
    Option to display or hide "Bcc" email address. Default: false.
  - setDisplayBccEmailAddress
```
public final void setDisplayBccEmailAddress(boolean value)
```
    Option to display or hide "Bcc" email address. Default: false.
  - 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.
  - getTimeZoneOffsetInternal
```
public com.aspose.ms.System.TimeSpan getTimeZoneOffsetInternal()
```
  - getResourceLoadingTimeout
```
public com.aspose.ms.System.TimeSpan getResourceLoadingTimeout()
```
    Timeout for loading external resources
  - setResourceLoadingTimeout
```
public void setResourceLoadingTimeout(com.aspose.ms.System.TimeSpan resourceLoadingTimeout)
```
    Timeout for loading external resources (setter)
  - setTimeZoneOffset
```
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.
  - deepClone
```
public final Object deepClone()
```
    Clones current instance.
    
    Returns:
  - getFieldTextMap
```
public Map<EmailField,String> getFieldTextMap()
```
    Gets the mapping between email message and field text representation
    
    Returns:
    
    mapping
  - setFieldTextMap
```
public void setFieldTextMap(Map<EmailField,String> fieldTextMap)
```
    Sets the mapping between email message and field text representation
    
    Parameters:
    
    fieldTextMap - 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:
    
    preserve original date if true
  - setPreserveOriginalDate
```
public void setPreserveOriginalDate(boolean preserveOriginalDate)
```
    Defines whether need to keep original date header string in mail message when saving or not
    
    Parameters:
    
    preserveOriginalDate - preserve original date
  - isConvertOwner
```
public boolean isConvertOwner()
```
    Description copied from interface: com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Gets option to control whether the documents container itself must be converted
    
    Specified by:
    
    isConvertOwner in interface com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Returns:
    
    If this property is true the documents container will be the first converted document
  - setConvertOwner
```
public void setConvertOwner(boolean convertOwner)
```
  - isConvertOwned
```
public boolean isConvertOwned()
```
    Description copied from interface: com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Option to control whether the owned documents in the documents container must be converted
    
    Specified by:
    
    isConvertOwned in interface com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Returns:
    
    true if the owned documents in the documents container must be converted
  - setConvertOwned
```
public void setConvertOwned(boolean convertOwned)
```
  - getDepth
```
public int getDepth()
```
    Description copied from interface: com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Option to control how many levels in depth to perform conversion
    
    Specified by:
    
    getDepth in interface com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
    
    Returns:
    
    depth levels count
  - setDepth
```
public void setDepth(int depth)
```

Packages

com.groupdocs.conversion.options.load

Classes

Class EmailLoadOptions

Constructor Summary

Method Summary

Methods inherited from class com.groupdocs.conversion.options.load.LoadOptions

Methods inherited from class com.groupdocs.conversion.contracts.ValueObject

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getFormat

getDisplayHeader

setDisplayHeader

getDisplayFromEmailAddress

setDisplayFromEmailAddress

getDisplayEmailAddress

setDisplayEmailAddress

getDisplayToEmailAddress

setDisplayToEmailAddress

getDisplayCcEmailAddress

setDisplayCcEmailAddress

getDisplayBccEmailAddress

setDisplayBccEmailAddress

getTimeZoneOffset

getTimeZoneOffsetInternal

getResourceLoadingTimeout

setResourceLoadingTimeout

setTimeZoneOffset

deepClone

getFieldTextMap

setFieldTextMap

isPreserveOriginalDate

setPreserveOriginalDate

isConvertOwner

setConvertOwner

isConvertOwned

setConvertOwned

getDepth

setDepth