MapiConversionOptions

Inheritance: java.lang.Object

public class MapiConversionOptions

This class allows the user to specify additional options when converting from MailMessage to MapiMessage.

Constructors

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

Methods

Method	Description
equals(Object arg0)
getASCIIFormat()	Returns MapiConversionOptions with OutlookMessageFormat is ASCII(PreserveSignature is False, UseBodyCompression is False).
getClass()
getCustomProgressHandler()
getForcedRtfBodyForAppointment()	Gets or sets a value indicating whether it is necessary to use forced RTF body for an appointment.
getFormat()	Represents outlook message format.
getPreserveEmbeddedMessageFormat()	Gets or sets a value indicating whether it is necessary to preserve EML format of embedded message at converting to MapiMessage.
getPreserveEmptyDates()	Gets or sets a value indicating whether it is necessary to keep empty dates when converting a message.
getPreserveOriginalAddresses()	Gets or sets a value indicating whether it is necessary to keep original value of mail addresses (without validation).
getPreserveOriginalDates()	Gets or sets a value indicating whether it is necessary to generate new saving and modification dates when converting a message.
getPreserveSignature()	Set to true, if signature is to be preserved.
getRemoveSignature()	Gets or sets a value indicating whether signature will be removed while converting.
getUnicodeFormat()	Returns MapiConversionOptions with OutlookMessageFormat is Unicode(PreserveSignature is False, UseBodyCompression is False).
getUseBodyCompression()	Set to true, if need RTF body compression.
hashCode()
notify()
notifyAll()
setCustomProgressHandler(ConversionProgressEventHandler value)
setForcedRtfBodyForAppointment(boolean value)	Gets or sets a value indicating whether it is necessary to use forced RTF body for an appointment.
setFormat(int value)	Represents outlook message format.
setPreserveEmbeddedMessageFormat(boolean value)	Gets or sets a value indicating whether it is necessary to preserve EML format of embedded message at converting to MapiMessage.
setPreserveEmptyDates(boolean value)	Gets or sets a value indicating whether it is necessary to keep empty dates when converting a message.
setPreserveOriginalAddresses(boolean value)	Gets or sets a value indicating whether it is necessary to keep original value of mail addresses (without validation).
setPreserveOriginalDates(boolean value)	Gets or sets a value indicating whether it is necessary to generate new saving and modification dates when converting a message.
setPreserveSignature(boolean value)	Set to true, if signature is to be preserved.
setRemoveSignature(boolean value)	Gets or sets a value indicating whether signature will be removed while converting.
setUseBodyCompression(boolean value)	Set to true, if need RTF body compression.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

MapiConversionOptions()

public MapiConversionOptions()

Initializes a new instance of the MapiConversionOptions class.

MapiConversionOptions(int format)

public MapiConversionOptions(int format)

Initializes a new instance of the MapiConversionOptions class with specified OutlookMessageFormat.

Parameters:

Parameter	Type	Description
format	int	Format of MapiMessage OutlookMessageFormat.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getASCIIFormat()

public static MapiConversionOptions getASCIIFormat()

Returns MapiConversionOptions with OutlookMessageFormat is ASCII(PreserveSignature is False, UseBodyCompression is False).

Returns: MapiConversionOptions

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCustomProgressHandler()

public final ConversionProgressEventHandler getCustomProgressHandler()

Returns: ConversionProgressEventHandler

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.

Returns: boolean

getFormat()

public final int getFormat()

Represents outlook message format.

Returns: int

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.

Returns: boolean

getPreserveEmptyDates()

public final boolean getPreserveEmptyDates()

Gets or sets a value indicating whether it is necessary to keep empty dates when converting a message.

Returns: boolean

getPreserveOriginalAddresses()

public final boolean getPreserveOriginalAddresses()

Gets or sets a value indicating whether it is necessary to keep original value of mail addresses (without validation).

Returns: boolean

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.

Returns: boolean

getPreserveSignature()

public final boolean getPreserveSignature()

Set to true, if signature is to be preserved.

Returns: boolean

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 .

Returns: boolean

getUnicodeFormat()

public static MapiConversionOptions getUnicodeFormat()

Returns MapiConversionOptions with OutlookMessageFormat is Unicode(PreserveSignature is False, UseBodyCompression is False).

Returns: MapiConversionOptions

getUseBodyCompression()

public final boolean getUseBodyCompression()

Set to true, if need RTF body compression.

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setCustomProgressHandler(ConversionProgressEventHandler value)

public final void setCustomProgressHandler(ConversionProgressEventHandler value)

Parameters:

Parameter	Type	Description
value	ConversionProgressEventHandler

setForcedRtfBodyForAppointment(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setFormat(int value)

public final void setFormat(int value)

Represents outlook message format.

Parameters:

Parameter	Type	Description
value	int

setPreserveEmbeddedMessageFormat(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setPreserveEmptyDates(boolean value)

public final void setPreserveEmptyDates(boolean value)

Gets or sets a value indicating whether it is necessary to keep empty dates when converting a message.

Parameters:

Parameter	Type	Description
value	boolean

setPreserveOriginalAddresses(boolean value)

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).

Parameters:

Parameter	Type	Description
value	boolean

setPreserveOriginalDates(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setPreserveSignature(boolean value)

public final void setPreserveSignature(boolean value)

Set to true, if signature is to be preserved.

Parameters:

Parameter	Type	Description
value	boolean

setRemoveSignature(boolean value)

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 .

Parameters:

Parameter	Type	Description
value	boolean

setUseBodyCompression(boolean value)

public final void setUseBodyCompression(boolean value)

Set to true, if need RTF body compression.

Parameters:

Parameter	Type	Description
value	boolean

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int