MapiTask

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

public class MapiTask extends MapiMessageItemBase

Represents a MAPI task item.

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

Example:


 // Load the MAPI message from a file
 MapiMessage msg = MapiMessage.load("task.msg");

 // Check if the loaded message is a supported task type
 if (msg.getSupportedType() == MapiItemType.Task) {
     // Convert the MAPI message to a MapiTask object
     MapiTask mapiTask = (MapiTask) msg.toMapiMessageItem();

     // Display some task info
     System.out.println(mapiTask.getSubject());
     System.out.println(mapiTask.getDueDate());
 }
 

Constructors

ConstructorDescription
MapiTask()Initializes a new instance of the MapiTask class.
MapiTask(String subject, String body, Date startDate, Date dueDate)Initializes a new instance of the MapiTask class.

Methods

MethodDescription
close()
createMapiNode(String key)Creates the mapi node.
dispose()Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
equals(Object arg0)
fromVTodo(InputStream stream)Creates an instance of MapiTask from the specified stream.
fromVTodo(InputStream stream, boolean detectEncoding)Creates an instance of MapiTask from the specified stream.
fromVTodo(String filePath)Creates an instance of MapiTask from the specified .ics file.
fromVTodo(String filePath, boolean detectEncoding)Creates an instance of MapiTask from the specified .ics file.
getAcceptanceState()Gets or sets the acceptance state of the task.
getActualEffort()Gets or sets the number of minutes that the user actually spent working on a task.
getAttachments()Gets the attachments in the message.
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.
getCategories()Contains keywords or categories for the message object.
getClass()
getCodePage()Gets the code page.
getCompanies()Contains the names of the companies that are associated with an item.
getDateCompleted()Gets or sets the date when the user completed work on the task.
getDueDate()Gets or sets the date by which the user expects work on the task to be complete.
getEstimatedEffort()Gets or sets the number of minutes that the user expects to work on a task.
getFlags()Gets the indication flags of the Task object.
getHistory()Gets or sets the type of change that was last made to the Task object.
getItemId()The item id, uses with a server
getLastUpdate()Gets or sets the date and time of the most recent change made to the Task object.
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.
getMode()Gets or sets the assignment status of the Task object.
getNamedProperties()Gets the named properties of message.
getNamedPropertyMapping()Gets the named property mapping.
getPercentComplete()Gets or sets the progress the user has made on a task.
getPriority()Gets or sets the current Priority of the Task object.
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.
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
getReminderTime()Gets or sets the initial signal time for a reminder
getSensitivity()Gets the Sensitivity.
getStartDate()Gets or sets the date on which the user expects work on the task to begin.
getState()Gets or sets the current assignment state of the Task object.
getStatus()Gets or sets the status of the user’s progress on the task.
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.
getUnderlyingMessage()Retrieves the underlying MapiMessage object.
getUsers()Gets or sets information about task users.
hashCode()
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, int saveFormat)Saves this MapiTask to the given stream using specified format.
save(String filePath, int saveFormat)Saves this MapiTask into file using specified format.
setAcceptanceState(int value)Gets or sets the acceptance state of the task.
setActualEffort(int value)Gets or sets the number of minutes that the user actually spent working on a task.
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.
setCategories(String[] value)Contains keywords or categories for the message object.
setCompanies(String[] value)Contains the names of the companies that are associated with an item.
setDateCompleted(Date value)Gets or sets the date when the user completed work on the task.
setDueDate(Date value)Gets or sets the date by which the user expects work on the task to be complete.
setEstimatedEffort(int value)Gets or sets the number of minutes that the user expects to work on a task.
setHistory(int value)Gets or sets the type of change that was last made to the Task object.
setLastUpdate(Date value)Gets or sets the date and time of the most recent change made to the Task object.
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.
setMode(int value)Gets or sets the assignment status of the Task object.
setNamedPropertyMapping(MapiNamedPropertyMappingStorage value)Sets the named property mapping.
setPercentComplete(int value)Gets or sets the progress the user has made on a task.
setPriority(int value)Gets or sets the current Priority of the Task object.
setProperty(MapiProperty value)Sets the property.
setProperty(PropertyDescriptor pd, Object value)Sets MAPI property.
setRecipients(MapiRecipientCollection value)Gets the recipients of the message.
setRecurrence(MapiCalendarRecurrencePattern value)Gets or sets the recurrence properties.
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
setReminderTime(Date value)Gets or sets the initial signal time for a reminder
setSensitivity(int value)Gets the Sensitivity.
setStartDate(Date value)Gets or sets the date on which the user expects work on the task to begin.
setState(int value)Gets or sets the current assignment state of the Task object.
setStatus(int value)Gets or sets the status of the user’s progress on the task.
setSubject(String value)Gets or sets the subject of the message.
setUsers(MapiTaskUsers value)Gets or sets information about task users.
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)

MapiTask()

public MapiTask()

Initializes a new instance of the MapiTask class.

MapiTask(String subject, String body, Date startDate, Date dueDate)

public MapiTask(String subject, String body, Date startDate, Date dueDate)

Initializes a new instance of the MapiTask class.

Parameters:

ParameterTypeDescription
subjectjava.lang.StringThe subject.
bodyjava.lang.StringThe message body.
startDatejava.util.DateThe start date.
dueDatejava.util.DateThe due date.

close()

public void close()

createMapiNode(String key)

public IMapiNode createMapiNode(String key)

Creates the mapi node.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe node key.

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

dispose()

public void dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

fromVTodo(InputStream stream)

public static MapiTask fromVTodo(InputStream stream)

Creates an instance of MapiTask from the specified stream.

Parameters:

ParameterTypeDescription
streamjava.io.InputStreamThe stream to be loaded.

Returns: MapiTask - Returns a MapiTask instance which is loaded from the specified stream.

fromVTodo(InputStream stream, boolean detectEncoding)

public static MapiTask fromVTodo(InputStream stream, boolean detectEncoding)

Creates an instance of MapiTask from the specified stream.

Parameters:

ParameterTypeDescription
streamjava.io.InputStreamThe stream to be loaded.
detectEncodingbooleanDetermines a data encoding by analyzing its byte order mark (BOM)

Returns: MapiTask - Returns a MapiTask instance which is loaded from the specified stream.

fromVTodo(String filePath)

public static MapiTask fromVTodo(String filePath)

Creates an instance of MapiTask from the specified .ics file.

Parameters:

ParameterTypeDescription
filePathjava.lang.StringThe path to the file to be loaded.

Returns: MapiTask - Returns a MapiTask instance which is loaded from the specified file.

fromVTodo(String filePath, boolean detectEncoding)

public static MapiTask fromVTodo(String filePath, boolean detectEncoding)

Creates an instance of MapiTask from the specified .ics file.

Parameters:

ParameterTypeDescription
filePathjava.lang.StringThe path to the file to be loaded.
detectEncodingbooleanDetermines a data encoding by analyzing its byte order mark (BOM)

Returns: MapiTask - Returns a MapiTask instance which is loaded from the specified file.

getAcceptanceState()

public final int getAcceptanceState()

Gets or sets the acceptance state of the task.

Returns: int

getActualEffort()

public final int getActualEffort()

Gets or sets the number of minutes that the user actually spent working on a task.

Returns: int

getAttachments()

public final MapiAttachmentCollection getAttachments()

Gets the attachments in the message.

Value: The attachment collection.

Returns: MapiAttachmentCollection

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

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

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[]

getDateCompleted()

public final Date getDateCompleted()

Gets or sets the date when the user completed work on the task.

Returns: java.util.Date

getDueDate()

public final Date getDueDate()

Gets or sets the date by which the user expects work on the task to be complete.

Returns: java.util.Date

getEstimatedEffort()

public final int getEstimatedEffort()

Gets or sets the number of minutes that the user expects to work on a task.

Returns: int

getFlags()

public final int getFlags()

Gets the indication flags of the Task object.

Returns: int

getHistory()

public final int getHistory()

Gets or sets the type of change that was last made to the Task object.

Returns: int

getItemId()

public String getItemId()

The item id, uses with a server

Returns: java.lang.String

getLastUpdate()

public final Date getLastUpdate()

Gets or sets the date and time of the most recent change made to the Task object.

Returns: java.util.Date

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

getMode()

public final int getMode()

Gets or sets the assignment status of the Task object.

Returns: int

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

getPercentComplete()

public final int getPercentComplete()

Gets or sets the progress the user has made on a task.

Returns: int

getPriority()

public final int getPriority()

Gets or sets the current Priority of the Task object.

Returns: int

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:

ParameterTypeDescription
pdPropertyDescriptorProperty 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:

ParameterTypeDescription
taglongThe 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:

ParameterTypeDescription
taglongThe 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:

ParameterTypeDescription
keylongThe 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:

ParameterTypeDescription
taglongThe 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:

ParameterTypeDescription
taglongThe 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:

ParameterTypeDescription
taglongThe 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:

ParameterTypeDescription
taglongThe 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:

ParameterTypeDescription
taglongThe MAPI property tag.
codepageintThe 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 MapiCalendarRecurrencePattern getRecurrence()

Gets or sets the recurrence properties.

Returns: MapiCalendarRecurrencePattern

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

getReminderTime()

public final Date getReminderTime()

Gets or sets the initial signal time for a reminder

Returns: java.util.Date

getSensitivity()

public final int getSensitivity()

Gets the Sensitivity.

Value: The sensitivity.

Returns: int

getStartDate()

public final Date getStartDate()

Gets or sets the date on which the user expects work on the task to begin.

Returns: java.util.Date

getState()

public final int getState()

Gets or sets the current assignment state of the Task object.

Returns: int

getStatus()

public final int getStatus()

Gets or sets the status of the user’s progress on the task.

Returns: int

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

getUnderlyingMessage()

public final MapiMessage getUnderlyingMessage()

Retrieves the underlying MapiMessage object.

Returns: MapiMessage - The MapiMessage object.

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


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

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

getUsers()

public final MapiTaskUsers getUsers()

Gets or sets information about task users.

Returns: MapiTaskUsers

hashCode()

public native int hashCode()

Returns: int

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:

ParameterTypeDescription
taglongThe tag of MapiProperty.

save(OutputStream stream, int saveFormat)

public final void save(OutputStream stream, int saveFormat)

Saves this MapiTask to the given stream using specified format.

Parameters:

ParameterTypeDescription
streamjava.io.OutputStream
saveFormatint

save(String filePath, int saveFormat)

public final void save(String filePath, int saveFormat)

Saves this MapiTask into file using specified format.

Parameters:

ParameterTypeDescription
filePathjava.lang.String
saveFormatint

setAcceptanceState(int value)

public final void setAcceptanceState(int value)

Gets or sets the acceptance state of the task.

Parameters:

ParameterTypeDescription
valueint

setActualEffort(int value)

public final void setActualEffort(int value)

Gets or sets the number of minutes that the user actually spent working on a task.

Parameters:

ParameterTypeDescription
valueint

setBilling(String value)

public final void setBilling(String value)

Contains the billing information associated with an item.

Parameters:

ParameterTypeDescription
valuejava.lang.String

setBody(String value)

public void setBody(String value)

Gets the message text.

Value: The string that represents message body.

Parameters:

ParameterTypeDescription
valuejava.lang.String

setBodyContent(String content, int contentType)

public void setBodyContent(String content, int contentType)

Sets the content of the body.

Parameters:

ParameterTypeDescription
contentjava.lang.StringThe content.
contentTypeintType 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:

ParameterTypeDescription
contentjava.lang.StringThe content.
contentTypeintType of the content.
compressionbooleanSpecify that the content should be compressed.

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

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.


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.

Parameters:

ParameterTypeDescription
valuejava.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.


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.

Parameters:

ParameterTypeDescription
valuejava.lang.String
compressionbooleanSpecify that the content should be compressed.

setCategories(String[] value)

public final void setCategories(String[] value)

Contains keywords or categories for the message object.

Parameters:

ParameterTypeDescription
valuejava.lang.String[]

setCompanies(String[] value)

public final void setCompanies(String[] value)

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

Parameters:

ParameterTypeDescription
valuejava.lang.String[]

setDateCompleted(Date value)

public final void setDateCompleted(Date value)

Gets or sets the date when the user completed work on the task.

Parameters:

ParameterTypeDescription
valuejava.util.Date

setDueDate(Date value)

public final void setDueDate(Date value)

Gets or sets the date by which the user expects work on the task to be complete.

Parameters:

ParameterTypeDescription
valuejava.util.Date

setEstimatedEffort(int value)

public final void setEstimatedEffort(int value)

Gets or sets the number of minutes that the user expects to work on a task.

Parameters:

ParameterTypeDescription
valueint

setHistory(int value)

public final void setHistory(int value)

Gets or sets the type of change that was last made to the Task object.

Parameters:

ParameterTypeDescription
valueint

setLastUpdate(Date value)

public final void setLastUpdate(Date value)

Gets or sets the date and time of the most recent change made to the Task object.

Parameters:

ParameterTypeDescription
valuejava.util.Date

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:

ParameterTypeDescription
valuejava.lang.String

setMessageFlags(long flags)

public final void setMessageFlags(long flags)

Sets the message flags.

Parameters:

ParameterTypeDescription
flagslongThe message flags.

setMileage(String value)

public final void setMileage(String value)

Contains the mileage information that is associated with an item.

Parameters:

ParameterTypeDescription
valuejava.lang.String

setMode(int value)

public final void setMode(int value)

Gets or sets the assignment status of the Task object.

Parameters:

ParameterTypeDescription
valueint

setNamedPropertyMapping(MapiNamedPropertyMappingStorage value)

public final void setNamedPropertyMapping(MapiNamedPropertyMappingStorage value)

Sets the named property mapping.

Parameters:

ParameterTypeDescription
valueMapiNamedPropertyMappingStorageThe MapiNamedPropertyMappingStorage.

setPercentComplete(int value)

public final void setPercentComplete(int value)

Gets or sets the progress the user has made on a task.

Parameters:

ParameterTypeDescription
valueint

setPriority(int value)

public final void setPriority(int value)

Gets or sets the current Priority of the Task object.

Parameters:

ParameterTypeDescription
valueint

setProperty(MapiProperty value)

public void setProperty(MapiProperty value)

Sets the property.

Parameters:

ParameterTypeDescription
valueMapiPropertyThe property.

setProperty(PropertyDescriptor pd, Object value)

public void setProperty(PropertyDescriptor pd, Object value)

Sets MAPI property.

Parameters:

ParameterTypeDescription
pdPropertyDescriptorThe property descriptor.
valuejava.lang.ObjectThe property data.

setRecipients(MapiRecipientCollection value)

public final void setRecipients(MapiRecipientCollection value)

Gets the recipients of the message.

Value: The collection of recipients.

Parameters:

ParameterTypeDescription
valueMapiRecipientCollection

setRecurrence(MapiCalendarRecurrencePattern value)

public final void setRecurrence(MapiCalendarRecurrencePattern value)

Gets or sets the recurrence properties.

Parameters:

ParameterTypeDescription
valueMapiCalendarRecurrencePattern

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:

ParameterTypeDescription
valuejava.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:

ParameterTypeDescription
valueboolean

setReminderTime(Date value)

public final void setReminderTime(Date value)

Gets or sets the initial signal time for a reminder

Parameters:

ParameterTypeDescription
valuejava.util.Date

setSensitivity(int value)

public final void setSensitivity(int value)

Gets the Sensitivity.

Value: The sensitivity.

Parameters:

ParameterTypeDescription
valueint

setStartDate(Date value)

public final void setStartDate(Date value)

Gets or sets the date on which the user expects work on the task to begin.

Parameters:

ParameterTypeDescription
valuejava.util.Date

setState(int value)

public final void setState(int value)

Gets or sets the current assignment state of the Task object.

Parameters:

ParameterTypeDescription
valueint

setStatus(int value)

public final void setStatus(int value)

Gets or sets the status of the user’s progress on the task.

Parameters:

ParameterTypeDescription
valueint

setSubject(String value)

public final void setSubject(String value)

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.

Parameters:

ParameterTypeDescription
valuejava.lang.String

setUsers(MapiTaskUsers value)

public final void setUsers(MapiTaskUsers value)

Gets or sets information about task users.

Parameters:

ParameterTypeDescription
valueMapiTaskUsers

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:

ParameterTypeDescription
taglongThe 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:

ParameterTypeDescription
taglongThe MAPI property tag.
valuejava.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:

ParameterTypeDescription
taglongThe MAPI property tag.
valueint[]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:

ParameterTypeDescription
taglongThe MAPI property tag.
valuelong[]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:

ParameterTypeDescription
taglongThe 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:

ParameterTypeDescription
taglongThe property tag key.
codepageintThe 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:

ParameterTypeDescription
taglongThe MAPI property tag.
valuejava.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:

ParameterTypeDescription
taglongThe MAPI property tag.
valuejava.lang.String[]When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.
codepageintThe 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:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int