MapiCalendar

Inheritance: java.lang.Object, com.aspose.email.MapiPropertyContainer, com.aspose.email.MapiMessageItemBase

public final class MapiCalendar extends MapiMessageItemBase

Represents a MAPI calendar item.

This class serves as a wrapper for MapiMessage to simplify the process of handling calendar information from MAPI properties. It provides a more intuitive interface for accessing and manipulating calendar data within the MAPI message.

Example:

// The following example demonstrates how to get a [MapiCalendar](../../com.aspose.email/mapicalendar) object from a [MapiMessage](../../com.aspose.email/mapimessage).

 MapiMessage msg = MapiMessage.load("calendar.msg");

 // Check if the loaded message is a supported calendar type
 if (msg.getSupportedType() == MapiItemType.Calendar) {
     // Convert the MAPI message to a MapiCalendar object
     MapiCalendar mapiCalendar = (MapiCalendar) msg.toMapiMessageItem();

     // Display some calendar info
     System.out.println(mapiCalendar.getSubject());
     System.out.println(mapiCalendar.getStartDate());
 }

Constructors

Constructor	Description
MapiCalendar()	Initializes a new instance of the MapiCalendar class
MapiCalendar(String location, String summary, String description, Date startDate, Date endDate)	Initializes a new instance of the MapiCalendar class.
MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, String organizer, MapiRecipientCollection attendees)	Initializes a new instance of the MapiCalendar class.
MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, MapiElectronicAddress organizer, MapiRecipientCollection attendees)	Initializes a new instance of the MapiCalendar class.

Methods

Method	Description
close()
createMapiNode(String key)	Creates the mapi node.
dispose()	Releases all resources.
equals(Object arg0)
getAppointmentCounterProposal()	Gets or sets a value indicating whether a Meeting Response object is a counter proposal.
getAttachments()	Gets the attachments in the message.
getAttendees()	Gets or sets the attendees
getBilling()	Contains the billing information associated with an item.
getBody()	Gets the message text.
getBodyHtml()	Gets the BodyRtf (#getBodyRtf.getBodyRtf/#setBodyRtf(String).setBodyRtf(String)) of the message converted to HTML, if present, otherwise an empty string.
getBodyRtf()	Gets or sets the RTF formatted message text.
getBodyType()	Gets the type of the body.
getBusyStatus()	Gets or sets the busy status
getCategories()	Contains keywords or categories for the message object.
getClass()
getClientIntent()	Gets or sets the actions the user has taken on this Meeting object.
getCodePage()	Gets the code page.
getCompanies()	Contains the names of the companies that are associated with an item.
getEndDate()	Gets or sets the end date and time of the event.
getEndDateTimeZone()	Gets or sets time zone information that indicates the time zone of the EndDate property
getItemId()	The item id, uses with a server
getKeyWords()	Gets or sets the categories of the calendar object
getLocation()	Gets or sets the location of the event
getMessageClass()	Gets a case-sensitive string that identifies the sender-defined message class, such as IPM.Note.
getMileage()	Contains the mileage information that is associated with an item.
getNamedProperties()	Gets the named properties of message.
getNamedPropertyMapping()	Gets the named property mapping.
getOrganizer()	Gets or sets the organizer.
getProperties()	Gets the collection of properties.
getProperty(PropertyDescriptor pd)	Gets MAPI property by property descriptor.
getPropertyBoolean(long tag)	Gets the value of the property specified by tag as Boolean type.
getPropertyBytes(long tag)	Gets the string value of the property specified by tag.
getPropertyDateTime(long key)	Gets the value of the property specified by tag as DateTime type.
getPropertyInt32(long tag)	Gets the int32 value of the property specified by tag.
getPropertyLong(long tag)	Gets the value of the property specified by tag as Long (int64) type.
getPropertyShort(long tag)	Gets the value of the property specified by tag as Short type.
getPropertyStream()	Gets the property stream.
getPropertyString(long tag)	Gets the string value of the property specified by tag.
getPropertyString(long tag, int codepage)	Gets the string value of the property specified by tag.
getRecipients()	Gets the recipients of the message.
getRecurrence()	Gets or sets the recurrence properties
getReminderDelta()	Gets or sets the interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object
getReminderFileParameter()	Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
getReminderSet()	Gets or sets a value indicating whether a reminder is set on the object
getSensitivity()	Gets the Sensitivity.
getSequence()	Gets or sets the sequence number
getStartDate()	Gets or sets the start date and time of the event.
getStartDateTimeZone()	Gets or sets time zone information that indicates the time zone of the StartDate property
getSubStorages()	Gets the sub storages.
getSubject()	Gets or sets the subject of the message.
getSubjectPrefix()	Gets a subject prefix that typically indicates some action on a message, such as “FW: " for forwarding.
getSupportedType()	Gets the supported item type.
getUid()	Gets the unique identifier
getUnderlyingMessage()	Retrieves the underlying MapiMessage object.
hashCode()
isAllDay()	Gets or sets a value indicating whether the event is an all-day event
isStoreUnicodeOk()	Determines if string properties are Unicode encoded or not.
notify()
notifyAll()
removeProperty(long tag)	Provides correctly removing property from all collections.
save(OutputStream stream)	Saves calendar object to the file with iCalendar format using te default save options
save(OutputStream stream, MapiCalendarSaveOptions saveOptions)	Saves calendar to the stream with specified save options
save(OutputStream stream, int saveFormat)	Saves calendar object to the stream with specified format using te default save options
save(String filePath)	Saves calendar object to the file with iCalendar format using te default save options
save(String filePath, MapiCalendarSaveOptions saveOptions)	Saves calendar object to the file with specified format using te default save options
save(String filePath, int saveFormat)	Saves calendar object to the file with specified format using te default save options
setAllDay(boolean value)	Gets or sets a value indicating whether the event is an all-day event
setAppointmentCounterProposal(boolean value)	Gets or sets a value indicating whether a Meeting Response object is a counter proposal.
setAttendees(MapiCalendarAttendees value)	Gets or sets the attendees
setBilling(String value)	Contains the billing information associated with an item.
setBody(String value)	Gets the message text.
setBodyContent(String content, int contentType)	Sets the content of the body.
setBodyContent(String content, int contentType, boolean compression)	Sets the content of the body.
setBodyRtf(String value)	Gets or sets the RTF formatted message text.
setBodyRtf(String value, boolean compression)	Gets or sets the RTF formatted message text.
setBusyStatus(int value)	Gets or sets the busy status
setCategories(String[] value)	Contains keywords or categories for the message object.
setClientIntent(int value)	Gets or sets the actions the user has taken on this Meeting object.
setCompanies(String[] value)	Contains the names of the companies that are associated with an item.
setEndDate(Date value)	Gets or sets the end date and time of the event.
setEndDateTimeZone(MapiCalendarTimeZone value)	Gets or sets time zone information that indicates the time zone of the EndDate property
setKeyWords(String value)	Gets or sets the categories of the calendar object
setLocation(String value)	Gets or sets the location of the event
setMessageClass(String value)	Gets a case-sensitive string that identifies the sender-defined message class, such as IPM.Note.
setMessageFlags(long flags)	Sets the message flags.
setMileage(String value)	Contains the mileage information that is associated with an item.
setNamedPropertyMapping(MapiNamedPropertyMappingStorage value)	Sets the named property mapping.
setOrganizer(MapiElectronicAddress value)	Gets or sets the organizer.
setProperty(MapiProperty value)	Sets the property.
setProperty(PropertyDescriptor pd, Object value)	Sets MAPI property.
setRecipients(MapiRecipientCollection value)	Gets the recipients of the message.
setRecurrence(MapiCalendarEventRecurrence value)	Gets or sets the recurrence properties
setReminderDelta(int value)	Gets or sets the interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object
setReminderFileParameter(String value)	Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.
setReminderSet(boolean value)	Gets or sets a value indicating whether a reminder is set on the object
setSensitivity(int value)	Gets the Sensitivity.
setSequence(int value)	Gets or sets the sequence number
setStartDate(Date value)	Gets or sets the start date and time of the event.
setStartDateTimeZone(MapiCalendarTimeZone value)	Gets or sets time zone information that indicates the time zone of the StartDate property
setSubject(String value)	Gets or sets the subject of the message.
setUid(String value)	Gets the unique identifier
toString()
tryGetPropertyData(long tag)	Try to get the property data with specified tag key.
tryGetPropertyDateTime(long tag, Date[] value)	Gets the value of the specified property as DateTime type.
tryGetPropertyInt32(long tag, int[] value)	Gets the value of the specified property as Int32 type.
tryGetPropertyLong(long tag, long[] value)	Gets the value of the specified property as Long type.
tryGetPropertyString(long tag)	Try to get a property data as string with specified tag.
tryGetPropertyString(long tag, int codepage)	Try to get a property data as string with specified tag and code page.
tryGetPropertyString(long tag, String[] value)	Gets the value of the specified property as String type.
tryGetPropertyString(long tag, String[] value, int codepage)	Gets the value of the specified property as String type.
wait()
wait(long arg0)
wait(long arg0, int arg1)

MapiCalendar()

public MapiCalendar()

Initializes a new instance of the MapiCalendar class

MapiCalendar(String location, String summary, String description, Date startDate, Date endDate)

public MapiCalendar(String location, String summary, String description, Date startDate, Date endDate)

Initializes a new instance of the MapiCalendar class.

Parameters:

Parameter	Type	Description
location	java.lang.String	The appointment location.
summary	java.lang.String	The appointment summary.
description	java.lang.String	The appointment description.
startDate	java.util.Date	The start date.
endDate	java.util.Date	The end date.

MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, String organizer, MapiRecipientCollection attendees)

public MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, String organizer, MapiRecipientCollection attendees)

Initializes a new instance of the MapiCalendar class.

Parameters:

Parameter	Type	Description
location	java.lang.String	The meeting location.
summary	java.lang.String	The meeting summary.
description	java.lang.String	The meeting description.
startDate	java.util.Date	The start date.
endDate	java.util.Date	The end date.
organizer	java.lang.String	The meeting organizer address.
attendees	MapiRecipientCollection	The meeting attendees.

MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, MapiElectronicAddress organizer, MapiRecipientCollection attendees)

public MapiCalendar(String location, String summary, String description, Date startDate, Date endDate, MapiElectronicAddress organizer, MapiRecipientCollection attendees)

Initializes a new instance of the MapiCalendar class.

Parameters:

Parameter	Type	Description
location	java.lang.String	The meeting location.
summary	java.lang.String	The meeting summary.
description	java.lang.String	The meeting description.
startDate	java.util.Date	The start date.
endDate	java.util.Date	The end date.
organizer	MapiElectronicAddress	The meeting organizer.
attendees	MapiRecipientCollection	The meeting attendees.

close()

public void close()

createMapiNode(String key)

public IMapiNode createMapiNode(String key)

Creates the mapi node.

Parameters:

Parameter	Type	Description
key	java.lang.String	The node key.

Returns: com.aspose.email.IMapiNode - The IMapiNode interface.

dispose()

public void dispose()

Releases all resources.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getAppointmentCounterProposal()

public final boolean getAppointmentCounterProposal()

Gets or sets a value indicating whether a Meeting Response object is a counter proposal.

Returns: boolean

getAttachments()

public final MapiAttachmentCollection getAttachments()

Gets the attachments in the message.

Value: The attachment collection.

Returns: MapiAttachmentCollection

getAttendees()

public final MapiCalendarAttendees getAttendees()

Gets or sets the attendees

Returns: MapiCalendarAttendees

getBilling()

public final String getBilling()

Contains the billing information associated with an item.

Returns: java.lang.String

getBody()

public String getBody()

Gets the message text.

Value: The string that represents message body.

Returns: java.lang.String

getBodyHtml()

public final String getBodyHtml()

Gets the BodyRtf (#getBodyRtf.getBodyRtf/#setBodyRtf(String).setBodyRtf(String)) of the message converted to HTML, if present, otherwise an empty string.

Returns: java.lang.String

getBodyRtf()

public final String getBodyRtf()

Gets or sets the RTF formatted message text.

Value: The string that represents message body rtf.

When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated. A string value being set must have RTF format. Thus, if it is necessary to set a value in HTML format, the value must be first to encoded within RTF, according to RTF Extensions Specification. To set the content of the body message in HTML or Plain Text formats quickly, please, use SetBodyContent method. When setting a null value or empty string, the values of BodyRtf and Body properties are set null.

Returns: java.lang.String

getBodyType()

public final int getBodyType()

Gets the type of the body.

Value: The type of the body.

Returns: int

getBusyStatus()

public final int getBusyStatus()

Gets or sets the busy status

Returns: int

getCategories()

public final String[] getCategories()

Contains keywords or categories for the message object.

Returns: java.lang.String[]

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getClientIntent()

public final int getClientIntent()

Gets or sets the actions the user has taken on this Meeting object.

Returns: int

getCodePage()

public int getCodePage()

Gets the code page.

Value: The code page.

Returns: int

getCompanies()

public final String[] getCompanies()

Contains the names of the companies that are associated with an item.

Returns: java.lang.String[]

getEndDate()

public final Date getEndDate()

Gets or sets the end date and time of the event. If the date is not set, default value for java.util.Date is returned.

Returns: java.util.Date

getEndDateTimeZone()

public final MapiCalendarTimeZone getEndDateTimeZone()

Gets or sets time zone information that indicates the time zone of the EndDate property

Returns: MapiCalendarTimeZone

getItemId()

public String getItemId()

The item id, uses with a server

Returns: java.lang.String

getKeyWords()

public final String getKeyWords()

Gets or sets the categories of the calendar object

Returns: java.lang.String

getLocation()

public final String getLocation()

Gets or sets the location of the event

Returns: java.lang.String

getMessageClass()

public final String getMessageClass()

Gets a case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message.

Value: The string that represents message class.

Returns: java.lang.String

getMileage()

public final String getMileage()

Contains the mileage information that is associated with an item.

Returns: java.lang.String

getNamedProperties()

public final MapiPropertyCollection getNamedProperties()

Gets the named properties of message.

Value: The collection of named properties.

Returns: MapiPropertyCollection

getNamedPropertyMapping()

public final MapiNamedPropertyMappingStorage getNamedPropertyMapping()

Gets the named property mapping.

Value: The named property mapping.

Returns: MapiNamedPropertyMappingStorage

getOrganizer()

public final MapiElectronicAddress getOrganizer()

Gets or sets the organizer.

Returns: MapiElectronicAddress

getProperties()

public MapiPropertyCollection getProperties()

Gets the collection of properties.

Value: The properties.

Returns: MapiPropertyCollection

getProperty(PropertyDescriptor pd)

public MapiProperty getProperty(PropertyDescriptor pd)

Gets MAPI property by property descriptor.

Parameters:

Parameter	Type	Description
pd	PropertyDescriptor	Property descriptor for looked property

Returns: MapiProperty - Mapi property if it is found, otherwise null.

getPropertyBoolean(long tag)

public final Boolean getPropertyBoolean(long tag)

Gets the value of the property specified by tag as Boolean type.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.

Returns: java.lang.Boolean - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyBytes(long tag)

public final byte[] getPropertyBytes(long tag)

Gets the string value of the property specified by tag.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.

Returns: byte[] - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyDateTime(long key)

public final Date getPropertyDateTime(long key)

Gets the value of the property specified by tag as DateTime type.

Parameters:

Parameter	Type	Description
key	long	The MAPI property tag.

Returns: java.util.Date - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyInt32(long tag)

public final Integer getPropertyInt32(long tag)

Gets the int32 value of the property specified by tag.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.

Returns: java.lang.Integer - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyLong(long tag)

public final Long getPropertyLong(long tag)

Gets the value of the property specified by tag as Long (int64) type.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.

Returns: java.lang.Long - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyShort(long tag)

public final Short getPropertyShort(long tag)

Gets the value of the property specified by tag as Short type.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.

Returns: java.lang.Short - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyStream()

public final MapiPropertyStream getPropertyStream()

Gets the property stream.

Value: The property stream.

Returns: MapiPropertyStream

getPropertyString(long tag)

public final String getPropertyString(long tag)

Gets the string value of the property specified by tag.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.

Returns: java.lang.String - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyString(long tag, int codepage)

public final String getPropertyString(long tag, int codepage)

Gets the string value of the property specified by tag.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.
codepage	int	The specified codepage used to get string value.

Returns: java.lang.String - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getRecipients()

public final MapiRecipientCollection getRecipients()

Gets the recipients of the message.

Value: The collection of recipients.

Returns: MapiRecipientCollection

getRecurrence()

public final MapiCalendarEventRecurrence getRecurrence()

Gets or sets the recurrence properties

Returns: MapiCalendarEventRecurrence

getReminderDelta()

public final int getReminderDelta()

Gets or sets the interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object

Returns: int

getReminderFileParameter()

public final String getReminderFileParameter()

Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.

Returns: java.lang.String

getReminderSet()

public final boolean getReminderSet()

Gets or sets a value indicating whether a reminder is set on the object

Returns: boolean

getSensitivity()

public final int getSensitivity()

Gets the Sensitivity.

Value: The sensitivity.

Returns: int

getSequence()

public final int getSequence()

Gets or sets the sequence number

Returns: int

getStartDate()

public final Date getStartDate()

Gets or sets the start date and time of the event. If the date is not set, default value for java.util.Date is returned.

Returns: java.util.Date

getStartDateTimeZone()

public final MapiCalendarTimeZone getStartDateTimeZone()

Gets or sets time zone information that indicates the time zone of the StartDate property

Returns: MapiCalendarTimeZone

getSubStorages()

public final MapiPropertyCollection getSubStorages()

Gets the sub storages.

Value: The sub storages.

Returns: MapiPropertyCollection

getSubject()

public final String getSubject()

Gets or sets the subject of the message.

Value: The string that represents message subject.

When setting a value, the values of SubjectPrefix(PR_SUBJECT_PREFIX) and NormalizedSubject(PR_NORMALIZED_SUBJECT) properties are updated as well. If Subject has no prefix, the value of SubjectPrefix property is set null. When setting a null value or empty string, the values of Subject, SubjectPrefix, NormalizedSubject properties are set null.

Returns: java.lang.String

getSubjectPrefix()

public final String getSubjectPrefix()

Gets a subject prefix that typically indicates some action on a message, such as “FW: " for forwarding.

Value: The string that represents subject prefix.

Returns: java.lang.String

getSupportedType()

public final int getSupportedType()

Gets the supported item type.

Value: The MapiItemType.

Returns: int

getUid()

public final String getUid()

Gets the unique identifier

Returns: java.lang.String

getUnderlyingMessage()

public final MapiMessage getUnderlyingMessage()

Retrieves the underlying MapiMessage object.

Returns: MapiMessage - The MapiMessage object.

Retrieves the underlying MAPI message from a MapiCalendar object and prints out its message class.


 // Retrieve the underlying MAPI message from the MapiCalendar object
 MapiMessage msg = mapiCalendar.getUnderlyingMessage();

 // Print out the message class of the MAPI message
 // Will output "IPM.Appointment"
 System.out.println(msg.getMessageClass());

hashCode()

public native int hashCode()

Returns: int

isAllDay()

public final boolean isAllDay()

Gets or sets a value indicating whether the event is an all-day event

Returns: boolean

isStoreUnicodeOk()

public final boolean isStoreUnicodeOk()

Determines if string properties are Unicode encoded or not.

Returns: boolean - True, if string properties are Unicode encoded.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

removeProperty(long tag)

public final void removeProperty(long tag)

Provides correctly removing property from all collections.

Parameters:

Parameter	Type	Description
tag	long	The tag of MapiProperty.

save(OutputStream stream)

public final void save(OutputStream stream)

Saves calendar object to the file with iCalendar format using te default save options

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	A stream to save to

save(OutputStream stream, MapiCalendarSaveOptions saveOptions)

public final void save(OutputStream stream, MapiCalendarSaveOptions saveOptions)

Saves calendar to the stream with specified save options

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	A stream to save to
saveOptions	MapiCalendarSaveOptions	A save options

save(OutputStream stream, int saveFormat)

public final void save(OutputStream stream, int saveFormat)

Saves calendar object to the stream with specified format using te default save options

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	A stream to save to
saveFormat	int	A save format

save(String filePath)

public final void save(String filePath)

Saves calendar object to the file with iCalendar format using te default save options

Parameters:

Parameter	Type	Description
filePath	java.lang.String	A file path

save(String filePath, MapiCalendarSaveOptions saveOptions)

public final void save(String filePath, MapiCalendarSaveOptions saveOptions)

Saves calendar object to the file with specified format using te default save options

Parameters:

Parameter	Type	Description
filePath	java.lang.String	A file path
saveOptions	MapiCalendarSaveOptions	A save options

save(String filePath, int saveFormat)

public final void save(String filePath, int saveFormat)

Saves calendar object to the file with specified format using te default save options

Parameters:

Parameter	Type	Description
filePath	java.lang.String	A file path
saveFormat	int	A save format

setAllDay(boolean value)

public final void setAllDay(boolean value)

Gets or sets a value indicating whether the event is an all-day event

Parameters:

Parameter	Type	Description
value	boolean

setAppointmentCounterProposal(boolean value)

public final void setAppointmentCounterProposal(boolean value)

Gets or sets a value indicating whether a Meeting Response object is a counter proposal.

Parameters:

Parameter	Type	Description
value	boolean

setAttendees(MapiCalendarAttendees value)

public final void setAttendees(MapiCalendarAttendees value)

Gets or sets the attendees

Parameters:

Parameter	Type	Description
value	MapiCalendarAttendees

setBilling(String value)

public final void setBilling(String value)

Contains the billing information associated with an item.

Parameters:

Parameter	Type	Description
value	java.lang.String

setBody(String value)

public void setBody(String value)

Gets the message text.

Value: The string that represents message body.

Parameters:

Parameter	Type	Description
value	java.lang.String

setBodyContent(String content, int contentType)

public void setBodyContent(String content, int contentType)

Sets the content of the body.

Parameters:

Parameter	Type	Description
content	java.lang.String	The content.
contentType	int	Type of the content.

It is provided for setting of the content of the body message in RTF, HTML or Plain Text formats. When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated as well. Note, after the value in HTML format is set, BodyRtf property returns the value which is encoded within RTF. |

setBodyContent(String content, int contentType, boolean compression)

public void setBodyContent(String content, int contentType, boolean compression)

Sets the content of the body.

Parameters:

Parameter	Type	Description
content	java.lang.String	The content.
contentType	int	Type of the content.
compression	boolean	Specify that the content should be compressed.

setBodyRtf(String value)

public final void setBodyRtf(String value)

Gets or sets the RTF formatted message text.

Value: The string that represents message body rtf.

Parameters:

Parameter	Type	Description
value	java.lang.String

setBodyRtf(String value, boolean compression)

public final void setBodyRtf(String value, boolean compression)

Gets or sets the RTF formatted message text.

Value: The string that represents message body rtf.

Parameters:

Parameter	Type	Description
value	java.lang.String
compression	boolean	Specify that the content should be compressed.

setBusyStatus(int value)

public final void setBusyStatus(int value)

Gets or sets the busy status

Parameters:

Parameter	Type	Description
value	int

setCategories(String[] value)

public final void setCategories(String[] value)

Contains keywords or categories for the message object.

Parameters:

Parameter	Type	Description
value	java.lang.String[]

setClientIntent(int value)

public final void setClientIntent(int value)

Gets or sets the actions the user has taken on this Meeting object.

Parameters:

Parameter	Type	Description
value	int

setCompanies(String[] value)

public final void setCompanies(String[] value)

Contains the names of the companies that are associated with an item.

Parameters:

Parameter	Type	Description
value	java.lang.String[]

setEndDate(Date value)

public final void setEndDate(Date value)

Gets or sets the end date and time of the event. If the date is not set, default value for java.util.Date is returned.

Parameters:

Parameter	Type	Description
value	java.util.Date

setEndDateTimeZone(MapiCalendarTimeZone value)

public final void setEndDateTimeZone(MapiCalendarTimeZone value)

Gets or sets time zone information that indicates the time zone of the EndDate property

Parameters:

Parameter	Type	Description
value	MapiCalendarTimeZone

setKeyWords(String value)

public final void setKeyWords(String value)

Gets or sets the categories of the calendar object

Parameters:

Parameter	Type	Description
value	java.lang.String

setLocation(String value)

public final void setLocation(String value)

Gets or sets the location of the event

Parameters:

Parameter	Type	Description
value	java.lang.String

setMessageClass(String value)

public final void setMessageClass(String value)

Gets a case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message.

Value: The string that represents message class.

Parameters:

Parameter	Type	Description
value	java.lang.String

setMessageFlags(long flags)

public final void setMessageFlags(long flags)

Sets the message flags.

Parameters:

Parameter	Type	Description
flags	long	The message flags.

setMileage(String value)

public final void setMileage(String value)

Contains the mileage information that is associated with an item.

Parameters:

Parameter	Type	Description
value	java.lang.String

setNamedPropertyMapping(MapiNamedPropertyMappingStorage value)

public final void setNamedPropertyMapping(MapiNamedPropertyMappingStorage value)

Sets the named property mapping.

Parameters:

Parameter	Type	Description
value	MapiNamedPropertyMappingStorage	The MapiNamedPropertyMappingStorage.

setOrganizer(MapiElectronicAddress value)

public final void setOrganizer(MapiElectronicAddress value)

Gets or sets the organizer.

Parameters:

Parameter	Type	Description
value	MapiElectronicAddress

setProperty(MapiProperty value)

public void setProperty(MapiProperty value)

Sets the property.

Parameters:

Parameter	Type	Description
value	MapiProperty	The property.

setProperty(PropertyDescriptor pd, Object value)

public void setProperty(PropertyDescriptor pd, Object value)

Sets MAPI property.

Parameters:

Parameter	Type	Description
pd	PropertyDescriptor	The property descriptor.
value	java.lang.Object	The property data.

setRecipients(MapiRecipientCollection value)

public final void setRecipients(MapiRecipientCollection value)

Gets the recipients of the message.

Value: The collection of recipients.

Parameters:

Parameter	Type	Description
value	MapiRecipientCollection

setRecurrence(MapiCalendarEventRecurrence value)

public final void setRecurrence(MapiCalendarEventRecurrence value)

Gets or sets the recurrence properties

Parameters:

Parameter	Type	Description
value	MapiCalendarEventRecurrence

setReminderDelta(int value)

public final void setReminderDelta(int value)

Gets or sets the interval, in minutes, between the time at which the reminder first becomes overdue and the start time of the Calendar object

Parameters:

Parameter	Type	Description
value	int

setReminderFileParameter(String value)

public final void setReminderFileParameter(String value)

Specifies the full path of the sound that a client SHOULD play when the reminder becomes overdue.

Parameters:

Parameter	Type	Description
value	java.lang.String

setReminderSet(boolean value)

public final void setReminderSet(boolean value)

Gets or sets a value indicating whether a reminder is set on the object

Parameters:

Parameter	Type	Description
value	boolean

setSensitivity(int value)

public final void setSensitivity(int value)

Gets the Sensitivity.

Value: The sensitivity.

Parameters:

Parameter	Type	Description
value	int

setSequence(int value)

public final void setSequence(int value)

Gets or sets the sequence number

Parameters:

Parameter	Type	Description
value	int

setStartDate(Date value)

public final void setStartDate(Date value)

Gets or sets the start date and time of the event. If the date is not set, default value for java.util.Date is returned.

Parameters:

Parameter	Type	Description
value	java.util.Date

setStartDateTimeZone(MapiCalendarTimeZone value)

public final void setStartDateTimeZone(MapiCalendarTimeZone value)

Gets or sets time zone information that indicates the time zone of the StartDate property

Parameters:

Parameter	Type	Description
value	MapiCalendarTimeZone

setSubject(String value)

public final void setSubject(String value)

Gets or sets the subject of the message.

Value: The string that represents message subject.

Parameters:

Parameter	Type	Description
value	java.lang.String

setUid(String value)

public final void setUid(String value)

Gets the unique identifier

Parameters:

Parameter	Type	Description
value	java.lang.String

toString()

public String toString()

Returns: java.lang.String

tryGetPropertyData(long tag)

public final byte[] tryGetPropertyData(long tag)

Try to get the property data with specified tag key.

Parameters:

Parameter	Type	Description
tag	long	The tag key.

Returns: byte[] - The property data.

tryGetPropertyDateTime(long tag, Date[] value)

public final boolean tryGetPropertyDateTime(long tag, Date[] value)

Gets the value of the specified property as DateTime type. A return value indicates whether the operation succeeded.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.
value	java.util.Date[]	When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

Returns: boolean - true if s was converted successfully; otherwise, false.

tryGetPropertyInt32(long tag, int[] value)

public final boolean tryGetPropertyInt32(long tag, int[] value)

Gets the value of the specified property as Int32 type. A return value indicates whether the operation succeeded.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.
value	int[]	When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

Returns: boolean - true if s was converted successfully; otherwise, false.

tryGetPropertyLong(long tag, long[] value)

public final boolean tryGetPropertyLong(long tag, long[] value)

Gets the value of the specified property as Long type. A return value indicates whether the operation succeeded.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.
value	long[]	When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

Returns: boolean - true if s was converted successfully; otherwise, false.

tryGetPropertyString(long tag)

public final String tryGetPropertyString(long tag)

Try to get a property data as string with specified tag.

Parameters:

Parameter	Type	Description
tag	long	The property tag key.

Returns: java.lang.String - String that contains the contents of property data.

tryGetPropertyString(long tag, int codepage)

public final String tryGetPropertyString(long tag, int codepage)

Try to get a property data as string with specified tag and code page.

Parameters:

Parameter	Type	Description
tag	long	The property tag key.
codepage	int	The code page.

Returns: java.lang.String - String that contains the contents of property data.

tryGetPropertyString(long tag, String[] value)

public final boolean tryGetPropertyString(long tag, String[] value)

Gets the value of the specified property as String type. A return value indicates whether the operation succeeded.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.
value	java.lang.String[]	When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

Returns: boolean - true if s was converted successfully; otherwise, false.

tryGetPropertyString(long tag, String[] value, int codepage)

public final boolean tryGetPropertyString(long tag, String[] value, int codepage)

Gets the value of the specified property as String type. A return value indicates whether the operation succeeded.

Parameters:

Parameter	Type	Description
tag	long	The MAPI property tag.
value	java.lang.String[]	When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.
codepage	int	The specified codepage used to get string value.

Returns: boolean - true if s was converted successfully; otherwise, false.

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

MapiAttachmentPropertyStream MapiCalendarAttendees