MapiConversionOptions (Aspose.Email for Java 24.9 API Documentation)

java.lang.Object
- com.aspose.email.MapiConversionOptions

```
public class MapiConversionOptions
extends Object
```
This class allows the user to specify additional options when converting from MailMessage to MapiMessage.

Constructor Summary

Constructors
Constructor and Description
`MapiConversionOptions()` Initializes a new instance of the `MapiConversionOptions` class.
`MapiConversionOptions(int format)` Initializes a new instance of the `MapiConversionOptions` class with specified OutlookMessageFormat.

Method Summary

Methods
Modifier and Type	Method and Description
`static MapiConversionOptions`	`getASCIIFormat()` Returns MapiConversionOptions with OutlookMessageFormat is ASCII(PreserveSignature is False, UseBodyCompression is False).
`ConversionProgressEventHandler`	`getCustomProgressHandler()`
`boolean`	`getForcedRtfBodyForAppointment()` Gets or sets a value indicating whether it is necessary to use forced RTF body for an appointment.
`int`	`getFormat()` Represents outlook message format.
`boolean`	`getPreserveEmbeddedMessageFormat()` Gets or sets a value indicating whether it is necessary to preserve EML format of embedded message at converting to MapiMessage.
`boolean`	`getPreserveEmptyDates()` Gets or sets a value indicating whether it is necessary to keep empty dates when converting a message.
`boolean`	`getPreserveOriginalAddresses()` Gets or sets a value indicating whether it is necessary to keep original value of mail addresses (without validation).
`boolean`	`getPreserveOriginalDates()` Gets or sets a value indicating whether it is necessary to generate new saving and modification dates when converting a message.
`boolean`	`getPreserveSignature()` Deprecated. Now the signature is preserved by default.This property is obsolete, not used in code and will be removed soon. To remove signature use MapiConversionOptions.RemoveSignature instead.
`boolean`	`getRemoveSignature()` Gets or sets a value indicating whether signature will be removed while converting.
`static MapiConversionOptions`	`getUnicodeFormat()` Returns MapiConversionOptions with OutlookMessageFormat is Unicode(PreserveSignature is False, UseBodyCompression is False).
`boolean`	`getUseBodyCompression()` Set to true, if need RTF body compression.
`void`	`setCustomProgressHandler(ConversionProgressEventHandler value)`
`void`	`setForcedRtfBodyForAppointment(boolean value)` Gets or sets a value indicating whether it is necessary to use forced RTF body for an appointment.
`void`	`setFormat(int value)` Represents outlook message format.
`void`	`setPreserveEmbeddedMessageFormat(boolean value)` Gets or sets a value indicating whether it is necessary to preserve EML format of embedded message at converting to MapiMessage.
`void`	`setPreserveEmptyDates(boolean value)` Gets or sets a value indicating whether it is necessary to keep empty dates when converting a message.
`void`	`setPreserveOriginalAddresses(boolean value)` Gets or sets a value indicating whether it is necessary to keep original value of mail addresses (without validation).
`void`	`setPreserveOriginalDates(boolean value)` Gets or sets a value indicating whether it is necessary to generate new saving and modification dates when converting a message.
`void`	`setPreserveSignature(boolean value)` Deprecated. Now the signature is preserved by default.This property is obsolete, not used in code and will be removed soon. To remove signature use MapiConversionOptions.RemoveSignature instead.
`void`	`setRemoveSignature(boolean value)` Gets or sets a value indicating whether signature will be removed while converting.
`void`	`setUseBodyCompression(boolean value)` Set to true, if need RTF body compression.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MapiConversionOptions
```
public MapiConversionOptions()
```
    Initializes a new instance of the MapiConversionOptions class.
  - MapiConversionOptions
```
public MapiConversionOptions(int format)
```
    Initializes a new instance of the MapiConversionOptions class with specified OutlookMessageFormat.
    
    Parameters:
    format - Format of MapiMessage OutlookMessageFormat.
- Method Detail
  - getCustomProgressHandler
```
public final ConversionProgressEventHandler getCustomProgressHandler()
```
  - setCustomProgressHandler
```
public final void setCustomProgressHandler(ConversionProgressEventHandler value)
```
  - getFormat
```
public final int getFormat()
```
    Represents outlook message format.
  - setFormat
```
public final void setFormat(int value)
```
    Represents outlook message format.
  - getPreserveSignature
```
@Deprecated
public final boolean getPreserveSignature()
```
    Deprecated. Now the signature is preserved by default.This property is obsolete, not used in code and will be removed soon. To remove signature use MapiConversionOptions.RemoveSignature instead.
    
    Set to true, if signature is to be preserved.
  - setPreserveSignature
```
@Deprecated
public final void setPreserveSignature(boolean value)
```
    Deprecated. Now the signature is preserved by default.This property is obsolete, not used in code and will be removed soon. To remove signature use MapiConversionOptions.RemoveSignature instead.
    
    Set to true, if signature is to be preserved.
  - getRemoveSignature
```
public final boolean getRemoveSignature()
```
    Gets or sets a value indicating whether signature will be removed while converting.
    Value: true if will be removed; otherwise, false.
  - setRemoveSignature
```
public final void setRemoveSignature(boolean value)
```
    Gets or sets a value indicating whether signature will be removed while converting.
    Value: true if will be removed; otherwise, false.
  - getUseBodyCompression
```
public final boolean getUseBodyCompression()
```
    Set to true, if need RTF body compression.
  - setUseBodyCompression
```
public final void setUseBodyCompression(boolean value)
```
    Set to true, if need RTF body compression.
  - getPreserveOriginalDates
```
public final boolean getPreserveOriginalDates()
```
    Gets or sets a value indicating whether it is necessary to generate new saving and modification dates when converting a message.
  - setPreserveOriginalDates
```
public final void setPreserveOriginalDates(boolean value)
```
    Gets or sets a value indicating whether it is necessary to generate new saving and modification dates when converting a message.
  - getPreserveEmptyDates
```
public final boolean getPreserveEmptyDates()
```
    Gets or sets a value indicating whether it is necessary to keep empty dates when converting a message.
  - setPreserveEmptyDates
```
public final void setPreserveEmptyDates(boolean value)
```
    Gets or sets a value indicating whether it is necessary to keep empty dates when converting a message.
  - getPreserveOriginalAddresses
```
public final boolean getPreserveOriginalAddresses()
```
    Gets or sets a value indicating whether it is necessary to keep original value of mail addresses (without validation).
  - setPreserveOriginalAddresses
```
public final void setPreserveOriginalAddresses(boolean value)
```
    Gets or sets a value indicating whether it is necessary to keep original value of mail addresses (without validation).
  - getPreserveEmbeddedMessageFormat
```
public final boolean getPreserveEmbeddedMessageFormat()
```
    Gets or sets a value indicating whether it is necessary to preserve EML format of embedded message at converting to MapiMessage. By default the value is false.
    Generally, embedded messages have the same format (EML or MSG) as the underlying message. By default, when converting from EML to MSG and vice versa, embedded messages are also converted to the target format. Setting the property to true preserves the original format of embedded messages.
  - setPreserveEmbeddedMessageFormat
```
public final void setPreserveEmbeddedMessageFormat(boolean value)
```
    Gets or sets a value indicating whether it is necessary to preserve EML format of embedded message at converting to MapiMessage. By default the value is false.
    Generally, embedded messages have the same format (EML or MSG) as the underlying message. By default, when converting from EML to MSG and vice versa, embedded messages are also converted to the target format. Setting the property to true preserves the original format of embedded messages.
  - getASCIIFormat
```
public static MapiConversionOptions getASCIIFormat()
```
    Returns MapiConversionOptions with OutlookMessageFormat is ASCII(PreserveSignature is False, UseBodyCompression is False).
  - getUnicodeFormat
```
public static MapiConversionOptions getUnicodeFormat()
```
    Returns MapiConversionOptions with OutlookMessageFormat is Unicode(PreserveSignature is False, UseBodyCompression is False).
  - getForcedRtfBodyForAppointment
```
public final boolean getForcedRtfBodyForAppointment()
```
    Gets or sets a value indicating whether it is necessary to use forced RTF body for an appointment. Default value is true.
  - setForcedRtfBodyForAppointment
```
public final void setForcedRtfBodyForAppointment(boolean value)
```
    Gets or sets a value indicating whether it is necessary to use forced RTF body for an appointment. Default value is true.

Class MapiConversionOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapiConversionOptions

MapiConversionOptions

Method Detail

getCustomProgressHandler

setCustomProgressHandler

getFormat

setFormat

getPreserveSignature

setPreserveSignature

getRemoveSignature

setRemoveSignature

getUseBodyCompression

setUseBodyCompression

getPreserveOriginalDates

setPreserveOriginalDates

getPreserveEmptyDates

setPreserveEmptyDates

getPreserveOriginalAddresses

setPreserveOriginalAddresses

getPreserveEmbeddedMessageFormat

setPreserveEmbeddedMessageFormat

getASCIIFormat

getUnicodeFormat

getForcedRtfBodyForAppointment

setForcedRtfBodyForAppointment