com.aspose.email

Class MapiNote

java.lang.Object

com.aspose.email.MapiPropertyContainer

com.aspose.email.MapiMessageItemBase

com.aspose.email.MapiNote

All Implemented Interfaces:

IMapiMessageItem, IDisposable, Closeable, AutoCloseable

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

Field Summary

Fields inherited from class com.aspose.email.MapiMessageItemBase

attachments, namedPropertyMappingStorage, objectsToDispose, recipients

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	getColor() Gets or sets the suggested background color of the Note object
Date	getCreationDate() Gets or sets the creation date of note
int	getHeight() Gets or sets height of the visible message window in pixels
MapiMessage	getUnderlyingMessage() Retrieves the underlying MapiMessage object.
int	getWidth() Gets or sets width of the visible message window in pixels
int	getXPosition() Gets or sets the distance, in pixels, from the left edge of the screen that a user interface displays a Note object
int	getYPosition() Gets or sets the distance, in pixels, from the top edge of the screen that a user interface displays a Note object
void	save(OutputStream stream, int saveFormat) Saves this MapiNote to the given stream using specified format.
void	save(String filePath, int saveFormat) Saves this MapiNote into file using specified format.
void	setColor(int value) Gets or sets the suggested background color of the Note object
void	setCreationDate(Date value) Gets or sets the creation date of note
void	setHeight(int value) Gets or sets height of the visible message window in pixels
void	setWidth(int value) Gets or sets width of the visible message window in pixels
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
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

Methods inherited from class com.aspose.email.MapiMessageItemBase

checkIsDisposed, close, createNamedProperty, dispose, getAttachments, getBilling, getBody, getBodyHtml, getBodyRtf, getBodyType, getCategories, getCompanies, getItemId, getMessageClass, getMileage, getNamedProperties, getNamedPropertyMapping, getProperty, getPropertyStream, getRecipients, getSensitivity, getSubject, getSubjectPrefix, getSubStorages, getSupportedType, initNamedPropertyMappingStorage, removeProperty, setBilling, setBody, setBodyContent, setBodyContent, setBodyRtf, setBodyRtf, setCategories, setCompanies, setMessageClass, setMessageFlags, setMileage, setNamedPropertyMapping, setProperty, setRecipients, setSensitivity, setsIMapiMessageItemMembers, setSubject

Methods inherited from class com.aspose.email.MapiPropertyContainer

createMapiNode, getCodePage, getProperties, getPropertyBoolean, getPropertyBytes, getPropertyDateTime, getPropertyInt32, getPropertyLong, getPropertyShort, getPropertyString, getPropertyString, isStoreUnicodeOk, setProperty, tryGetPropertyData, tryGetPropertyDateTime, tryGetPropertyInt32, tryGetPropertyLong, tryGetPropertyString, tryGetPropertyString, tryGetPropertyString, tryGetPropertyString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapiNote

public MapiNote()

Initializes a new instance of the MapiNote class.

MapiNote

public MapiNote(String subject,
        String body)

Initializes a new instance of the MapiNote class.

Parameters:

subject - The message subject.

body - The message body.

Method Detail

getCreationDate

public final Date getCreationDate()

Gets or sets the creation date of note

setCreationDate

public final void setCreationDate(Date value)

Gets or sets the creation date of note

getColor

public final int getColor()

Gets or sets the suggested background color of the Note object

setColor

public final void setColor(int value)

Gets or sets the suggested background color of the Note object

getWidth

public final int getWidth()

Gets or sets width of the visible message window in pixels

setWidth

public final void setWidth(int value)

Gets or sets width of the visible message window in pixels

getHeight

public final int getHeight()

Gets or sets height of the visible message window in pixels

setHeight

public final void setHeight(int value)

Gets or sets height of the visible message window in pixels

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

setXPosition

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

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

setYPosition

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

getUnderlyingMessage

public final MapiMessage getUnderlyingMessage()

Retrieves the underlying MapiMessage object.

Returns:

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 XVHK4D9KDb.get(new byte[] { (byte)0xc6, (byte)0xa8, (byte)0x7f, (byte)0x5c, (byte)0xed, (byte)0xe0, (byte)0xca, (byte)0xbf, (byte)0xb8, (byte)0xf6, (byte)0x9a, (byte)0x42, (byte)0x80, (byte)0x4a })
 System.out.println(msg.getMessageClass());
 
 

save

public final void save(OutputStream stream,
        int saveFormat)

Saves this MapiNote to the given stream using specified format.

save

public final void save(String filePath,
        int saveFormat)

Saves this MapiNote into file using specified format.