MapiNote

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

public final class MapiNote extends MapiMessageItemBase

Represents a MAPI note (“sticky note”) item.

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

Example:


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

 // Check if the loaded message is a supported note type
 if (msg.getSupportedType() == MapiItemType.Note) {
     // Convert the MAPI message to a MapiNote object
     MapiNote mapiNote = (MapiNote) msg.toMapiMessageItem();

     // Display some note info
     System.out.println(mapiNote.getColor());
     System.out.println(mapiNote.getBody());
 }

Constructors

Constructor	Description
MapiNote()	Initializes a new instance of the MapiNote class.
MapiNote(String subject, String body)	Initializes a new instance of the MapiNote class.

Methods

Method	Description
close()
createMapiNode(String key)	Creates the mapi node.
dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
equals(Object arg0)
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.
getColor()	Gets or sets the suggested background color of the Note object
getCompanies()	Contains the names of the companies that are associated with an item.
getCreationDate()	Gets or sets the creation date of note
getHeight()	Gets or sets height of the visible message window in pixels
getItemId()	The item id, uses with a server
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.
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.
getSensitivity()	Gets the Sensitivity.
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.
getWidth()	Gets or sets width of the visible message window in pixels
getXPosition()	Gets or sets the distance, in pixels, from the left edge of the screen that a user interface displays a Note object
getYPosition()	Gets or sets the distance, in pixels, from the top edge of the screen that a user interface displays a Note object
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 MapiNote to the given stream using specified format.
save(String filePath, int saveFormat)	Saves this MapiNote into file using specified format.
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.
setColor(int value)	Gets or sets the suggested background color of the Note object
setCompanies(String[] value)	Contains the names of the companies that are associated with an item.
setCreationDate(Date value)	Gets or sets the creation date of note
setHeight(int value)	Gets or sets height of the visible message window in pixels
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.
setProperty(MapiProperty value)	Sets the property.
setProperty(PropertyDescriptor pd, Object value)	Sets MAPI property.
setRecipients(MapiRecipientCollection value)	Gets the recipients of the message.
setSensitivity(int value)	Gets the Sensitivity.
setSubject(String value)	Gets or sets the subject of the message.
setWidth(int value)	Gets or sets width of the visible message window in pixels
setXPosition(int value)	Gets or sets the distance, in pixels, from the left edge of the screen that a user interface displays a Note object
setYPosition(int value)	Gets or sets the distance, in pixels, from the top edge of the screen that a user interface displays a Note object
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)

MapiNote()

public MapiNote()

Initializes a new instance of the MapiNote class.

MapiNote(String subject, String body)

public MapiNote(String subject, String body)

Initializes a new instance of the MapiNote class.

Parameters:

Parameter	Type	Description
subject	java.lang.String	The message subject.
body	java.lang.String	The message body.

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

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

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

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

getColor()

public final int getColor()

Gets or sets the suggested background color of the Note object

Returns: int

getCompanies()

public final String[] getCompanies()

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

Returns: java.lang.String[]

getCreationDate()

public final Date getCreationDate()

Gets or sets the creation date of note

Returns: java.util.Date

getHeight()

public final int getHeight()

Gets or sets height of the visible message window in pixels

Returns: int

getItemId()

public String getItemId()

The item id, uses with a server

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

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

getSensitivity()

public final int getSensitivity()

Gets the Sensitivity.

Value: The sensitivity.

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 MapiNote object and prints out its message class.


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

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

getWidth()

public final int getWidth()

Gets or sets width of the visible message window in pixels

Returns: int

getXPosition()

public final int getXPosition()

Gets or sets the distance, in pixels, from the left edge of the screen that a user interface displays a Note object

Returns: int

getYPosition()

public final int getYPosition()

Gets or sets the distance, in pixels, from the top edge of the screen that a user interface displays a Note object

Returns: int

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:

Parameter	Type	Description
tag	long	The tag of MapiProperty.

save(OutputStream stream, int saveFormat)

public final void save(OutputStream stream, int saveFormat)

Saves this MapiNote to the given stream using specified format.

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream
saveFormat	int

save(String filePath, int saveFormat)

public final void save(String filePath, int saveFormat)

Saves this MapiNote into file using specified format.

Parameters:

Parameter	Type	Description
filePath	java.lang.String
saveFormat	int

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.

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

setColor(int value)

public final void setColor(int value)

Gets or sets the suggested background color of the Note 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[]

setCreationDate(Date value)

public final void setCreationDate(Date value)

Gets or sets the creation date of note

Parameters:

Parameter	Type	Description
value	java.util.Date

setHeight(int value)

public final void setHeight(int value)

Gets or sets height of the visible message window in pixels

Parameters:

Parameter	Type	Description
value	int

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.

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

setSensitivity(int value)

public final void setSensitivity(int value)

Gets the Sensitivity.

Value: The sensitivity.

Parameters:

Parameter	Type	Description
value	int

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

setWidth(int value)

public final void setWidth(int value)

Gets or sets width of the visible message window in pixels

Parameters:

Parameter	Type	Description
value	int

setXPosition(int value)

public final void setXPosition(int value)

Gets or sets the distance, in pixels, from the left edge of the screen that a user interface displays a Note object

Parameters:

Parameter	Type	Description
value	int

setYPosition(int value)

public final void setYPosition(int value)

Gets or sets the distance, in pixels, from the top edge of the screen that a user interface displays a Note object

Parameters:

Parameter	Type	Description
value	int

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

MapiNamedPropertyMappingStorage MapiObjectProperty