Aspose::Email::Mapi::MapiNote Class Reference

Represents a MAPI note ("sticky note") item. More...

Inherits Aspose::Email::Mapi::MapiMessageItemBase.

Public Member Functions
System::DateTime	get_CreationDate () const
	Gets the creation date of note More...
void	set_CreationDate (System::DateTime value)
	Sets the creation date of note More...
NoteColor	get_Color () const
	Gets the suggested background color of the Note object More...
void	set_Color (NoteColor value)
	Sets the suggested background color of the Note object More...
int32_t	get_Width () const
	Gets width of the visible message window in pixels More...
void	set_Width (int32_t value)
	Sets width of the visible message window in pixels More...
int32_t	get_Height () const
	Gets height of the visible message window in pixels More...
void	set_Height (int32_t value)
	Sets height of the visible message window in pixels More...
int32_t	get_XPosition () const
	Gets the distance, in pixels, from the left edge of the screen that a user interface displays a Note object More...
void	set_XPosition (int32_t value)
	Sets the distance, in pixels, from the left edge of the screen that a user interface displays a Note object More...
int32_t	get_YPosition () const
	Gets the distance, in pixels, from the top edge of the screen that a user interface displays a Note object More...
void	set_YPosition (int32_t value)
	Sets the distance, in pixels, from the top edge of the screen that a user interface displays a Note object More...
	MapiNote ()
	Initializes a new instance of the MapiNote class. More...
	MapiNote (System::String subject, System::String body)
	Initializes a new instance of the MapiNote class. More...
	MapiNote (System::SharedPtr< MapiMessage > msg)
	Constructor More...
System::SharedPtr< MapiMessage >	GetUnderlyingMessage ()
	Retrieves the underlying MapiMessage object. More...
void	Save (System::SharedPtr< System::IO::Stream > stream, NoteSaveFormat saveFormat)
	Saves this MapiNote to the given stream using specified format. More...
void	Save (System::String filePath, NoteSaveFormat saveFormat)
	Saves this MapiNote into file using specified format. More...
System::SharedPtr< MapiMessage >	ConvertToMapiMessage () override
	Converts note object to mapi message More...
Public Member Functions inherited from Aspose::Email::Mapi::MapiMessageItemBase
virtual System::String	get_ItemId ()
	The item id, uses with a server More...
virtual void	set_ItemId (System::String value)
	The item id, uses with a server More...
System::SharedPtr< MapiAttachmentCollection >	get_Attachments ()
	Gets the attachments in the message. More...
void	set_Attachments (System::SharedPtr< MapiAttachmentCollection > value)
	Gets the attachments in the message. More...
System::SharedPtr< MapiPropertyStream >	get_PropertyStream ()
	Gets the property stream. More...
System::SharedPtr< MapiPropertyCollection >	get_NamedProperties ()
	Gets the named properties of message. More...
System::SharedPtr< MapiRecipientCollection >	get_Recipients ()
	Gets the recipients of the message. More...
void	set_Recipients (System::SharedPtr< MapiRecipientCollection > value)
	Gets the recipients of the message. More...
System::SharedPtr< MapiPropertyCollection >	get_SubStorages ()
	Gets the sub storages. More...
System::SharedPtr< MapiNamedPropertyMappingStorage >	get_NamedPropertyMapping ()
	Gets the named property mapping. More...
System::String	get_SubjectPrefix ()
	Gets a subject prefix that typically indicates some action on a message, such as "FW: " for forwarding. More...
BodyContentType	get_BodyType ()
	Gets the type of the body. More...
System::String	get_BodyRtf ()
	Gets the RTF formatted message text. More...
void	set_BodyRtf (System::String value)
	Sets the RTF formatted message text. More...
System::String	get_BodyHtml ()
	Gets the BodyRtf of the message converted to HTML, if present, otherwise an empty string. More...
System::ArrayPtr< System::String >	get_Companies ()
	Contains the names of the companies that are associated with an item. More...
void	set_Companies (System::ArrayPtr< System::String > value)
	Contains the names of the companies that are associated with an item. More...
System::ArrayPtr< System::String >	get_Categories ()
	Contains keywords or categories for the message object. More...
void	set_Categories (System::ArrayPtr< System::String > value)
	Contains keywords or categories for the message object. More...
System::String	get_Mileage ()
	Contains the mileage information that is associated with an item. More...
void	set_Mileage (System::String value)
	Contains the mileage information that is associated with an item. More...
System::String	get_Billing ()
	Contains the billing information associated with an item. More...
void	set_Billing (System::String value)
	Contains the billing information associated with an item. More...
Storage::Pst::MapiSensitivity	get_Sensitivity ()
	Gets the Sensitivity. More...
void	set_Sensitivity (Storage::Pst::MapiSensitivity value)
	Gets the Sensitivity. More...
System::String	get_MessageClass () override
	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. More...
void	set_MessageClass (System::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. More...
MapiItemType	get_SupportedType () override
	Gets the supported item type. More...
System::String	get_Body () override
	Gets the message text. More...
void	set_Body (System::String value) override
	Gets the message text. More...
System::String	get_Subject () override
	Gets the subject of the message. More...
void	set_Subject (System::String value) override
	Sets the subject of the message. More...
System::SharedPtr< System::Object >	get_VentureLicenseObj () const
	This stores the venture licensing state instead of 2 obvious fields such as string value for watermark and some value indicating license is set or not. More...
System::SharedPtr< MapiProperty >	GetProperty (System::SharedPtr< PropertyDescriptor > pd) override
	Gets MAPI property by property descriptor. More...
bool	TryGetNamedProperty (System::SharedPtr< MapiProperty > mapiProperty, System::SharedPtr< MapiNamedProperty > &mapiNamedProperty) override
	If MapiNamedPropertyMappingStorage is available, initializes and returns MapiNamedProperty, otherwise null. More...
void	SetProperty (System::SharedPtr< PropertyDescriptor > pd, System::SharedPtr< System::Object > value) override
	Sets MAPI property. More...
void	SetStringNamedProperty (System::String value, MapiNamedPropertyId nameId, System::Guid psetId)
void	SetsIMapiMessageItemMembers (System::String messageClass, System::String body, System::String subject)
	Sets MessageClass,Body and Subject. More...
void	Dispose () override
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
void	SetNamedPropertyMapping (System::SharedPtr< MapiNamedPropertyMappingStorage > value)
	Sets the named property mapping. More...
int64_t	GetTagFromNamedProperty (MapiNamedPropertyId propertyId)
	Gets the tag from named property. More...
int64_t	GetTagFromNamedProperty (System::String name)
	Gets the tag from named property. More...
void	AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, int64_t nameId, System::Guid guid)
	Adds the named property. More...
void	AddNamedProperty (System::SharedPtr< MapiAttachment > attachment, MapiPropertyType type, System::ArrayPtr< uint8_t > data, int64_t nameId, System::Guid guid)
	Adds the named property. More...
void	AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, int64_t nameId, System::Guid guid, System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object >>> mvEntries)
	Adds the named property. More...
void	AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::String nameId, System::Guid guid)
	Adds the named property. More...
void	AddNamedProperty (System::SharedPtr< MapiAttachment > attachment, MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::String nameId, System::Guid guid)
	Adds the named property. More...
void	AddNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::String nameId, System::Guid guid, System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object >>> mvEntries)
	Adds the named property. More...
int64_t	AddNamedPropertyToEmbeddedMsg (System::SharedPtr< MapiMessage > msg, MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::SharedPtr< System::Object > nameId, System::Guid guid)
	Adds the named property to embedded message. More...
void	SetBodyRtf (System::String content, bool compression)
	Gets or sets the RTF formatted message text. More...
virtual void	SetBodyContent (System::String content, BodyContentType contentType)
	Sets the content of the body. More...
virtual void	SetBodyContent (System::String content, BodyContentType contentType, bool compression)
	Sets the content of the body. More...
void	SetMessageFlags (MapiMessageFlags flags)
	Sets the message flags. More...
void	RemoveProperty (int64_t tag)
	Provides correctly removing property from all collections. More...
void	SetVentureLicense (System::SharedPtr< System::Object > ventureLicense)
	All Aspose products should implement this method. It is called by a GroupDocs product to indicate whether GroupDocs itself is licensed or not and specify a custom watermark. When GroupDocs is licensed, this document instance should behave as licensed too even if the Aspose product is not licensed. More...
void	UpdateHasAttach ()
	Updates the PR_HASATTACH property value. More...
MapiMessageFlags	GetFlags ()
void	UpdateDisplayNames (MapiRecipientType recipientType)
	Updates the display names. More...
void	AddNamedProperty (System::DateTime value, int64_t nameId, System::Guid guid)
	Adds the named datetime property. More...
void	AddNamedProperty (System::DateTime value, MapiNamedPropertyId nameId, System::Guid guid)
	Adds the named datetime property. More...
void	AddNamedProperty (bool value, MapiNamedPropertyId nameId, System::Guid guid)
	Adds the named bool property. More...
void	AddNamedProperty (bool value, int64_t nameId, System::Guid guid)
	Adds the named bool property. More...
void	AddNamedPropertyLong (int64_t value, MapiNamedPropertyId nameId, System::Guid guid)
	Adds the named long property. More...
void	AddNamedPropertyLong (int64_t value, int64_t nameId, System::Guid guid)
	Adds the named long property. More...
void	AddNamedProperty (System::String value, OutlookMessageFormat format, MapiNamedPropertyId nameId, System::Guid guid)
	Adds the named string property. More...
void	AddNamedProperty (System::String value, MapiNamedPropertyId nameId, System::Guid guid)
	Adds the named string property. More...
void	AddNamedProperty (System::String value, OutlookMessageFormat format, int64_t nameId, System::Guid guid)
	Adds the named string property. More...
void	AddNamedProperty (System::ArrayPtr< uint8_t > value, int64_t nameId, System::Guid guid)
	Adds the named binary property. More...
void	AddNamedProperty (System::ArrayPtr< uint8_t > value, MapiNamedPropertyId nameId, System::Guid guid)
	Adds the named binary property. More...
Public Member Functions inherited from Aspose::Email::Mapi::MapiPropertyContainer
virtual System::SharedPtr< MapiPropertyCollection >	get_Properties ()
	Gets the collection of properties. More...
virtual int32_t	get_CodePage ()
	Gets the code page. More...
System::SharedPtr< System::Text::Encoding >	get_CurrentEncoding ()
	MapiPropertyContainer ()
	Initializes a new instance of the MapiPropertyContainer class. More...
	MapiPropertyContainer (System::SharedPtr< MapiPropertyCollection > properties)
	Initializes a new instance of the MapiPropertyContainer class. More...
System::SharedPtr< MapiPropertyCollection >	GetSubStorages ()
System::String	TryGetPropertyString (int64_t tag, int32_t codepage)
	Try to get a property data as string with specified tag and code page. More...
System::ArrayPtr< uint8_t >	TryGetPropertyData (int64_t tag)
	Try to get the property data with specified tag key. More...
System::String	TryGetPropertyString (int64_t tag)
	Try to get a property data as string with specified tag. More...
System::String	GetPropertyString (int64_t tag, int32_t codepage)
	Gets the string value of the property specified by tag. More...
System::String	GetPropertyString (int64_t tag)
	Gets the string value of the property specified by tag. More...
System::ArrayPtr< uint8_t >	GetPropertyBytes (int64_t tag)
	Gets the string value of the property specified by tag. More...
virtual void	SetProperty (System::SharedPtr< MapiProperty > value)
	Sets the property. More...
System::Nullable< int32_t >	GetPropertyInt32 (int64_t tag)
	Gets the int32 value of the property specified by tag. More...
System::Nullable< int64_t >	GetPropertyLong (int64_t tag)
	Gets the value of the property specified by tag as Long (int64) type. More...
System::Nullable< int16_t >	GetPropertyShort (int64_t tag)
	Gets the value of the property specified by tag as Short type. More...
System::Nullable< bool >	GetPropertyBoolean (int64_t tag)
	Gets the value of the property specified by tag as Boolean type. More...
System::Nullable< System::DateTime >	GetPropertyDateTime (int64_t key)
	Gets the value of the property specified by tag as DateTime type. More...
bool	IsStoreUnicodeOk ()
	Determines if string properties are Unicode encoded or not. More...
bool	TryGetPropertyString (int64_t tag, System::String &value, int32_t codepage)
	Gets the value of the specified property as String type. A return value indicates whether the operation succeeded. More...
bool	TryGetPropertyString (int64_t tag, System::String &value)
	Gets the value of the specified property as String type. A return value indicates whether the operation succeeded. More...
bool	TryGetPropertyDateTime (int64_t tag, System::DateTime &value)
	Gets the value of the specified property as DateTime type. A return value indicates whether the operation succeeded. More...
bool	TryGetPropertyLong (int64_t tag, int64_t &value)
	Gets the value of the specified property as Long type. A return value indicates whether the operation succeeded. More...
bool	TryGetPropertyInt32 (int64_t tag, int32_t &value)
	Gets the value of the specified property as Int32 type. A return value indicates whether the operation succeeded. More...
virtual System::SharedPtr< Nodes::IMapiNode >	CreateMapiNode (System::String key)
	Creates the mapi node. More...
void	SetProperty (int64_t tag, System::ArrayPtr< uint8_t > data)
	Set the property. More...
void	SetProperty (int64_t tag, System::String value, OutlookMessageFormat format)
	Set the string property. More...
void	SetProperty (int64_t tag, System::String value, bool isUnicode)
	Set the string property. More...
void	SetProperty (int64_t tag, System::String value, System::SharedPtr< System::Text::Encoding > nonUnicodeEncoding)
	Set the string property. More...
void	SetProperty (int64_t tag, System::String value)
	Set the string property with CurrentEncoding More...
void	SetProperty (int64_t tag, System::DateTime dateTime)
	Set the datetime property. More...
void	SetPropertyLong (int64_t tag, int64_t value)
	Set the long property. More...

Protected Member Functions
virtual	~MapiNote ()
Protected Member Functions inherited from Aspose::Email::Mapi::MapiMessageItemBase
	MapiMessageItemBase ()
	Initializes a new instance of the MapiMessageItemBase class. More...
	MapiMessageItemBase (System::SharedPtr< MapiPropertyCollection > properties)
	Initializes a new instance of the MapiMessageItemBase class. More...
void	CheckIsDisposed ()
	Checks if the object is disposed and raised exception in this case. More...
void	InitNamedPropertyMappingStorage ()
	Inits the named property mapping storage. More...
System::SharedPtr< MapiNamedProperty >	CreateNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::String nameId, System::Guid guid)
virtual	~MapiMessageItemBase ()
Protected Member Functions inherited from Aspose::Email::Mapi::MapiPropertyContainer
virtual	~MapiPropertyContainer ()

Additional Inherited Members
Static Public Member Functions inherited from Aspose::Email::Mapi::MapiMessageItemBase
static void	SetPriority (System::SharedPtr< MapiMessageItemBase > message, MailPriority priority)
	Sets MailPriority value for MapiMessageItemBase See more PidTagPriority mapi property: https://msdn.microsoft.com/en-us/library/ee159473(v=exchg.80).aspx See more PidTagImportance mapi property: https://msdn.microsoft.com/en-us/library/ee237166(v=exchg.80).aspx More...
static int64_t	GetTagFromNamedProperty (MapiNamedPropertyId propertyId, System::SharedPtr< MapiPropertyCollection > namedProperties)
static int64_t	GetTagFromNamedProperty (System::String name, System::SharedPtr< MapiPropertyCollection > namedProperties)
Public Attributes inherited from Aspose::Email::Mapi::MapiMessageItemBase
System::SharedPtr< MapiNamedPropertyMappingStorage >	namedPropertyMappingStorage
	The named property mapping storage. More...
Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
int32_t	codePage
	The code page. More...
System::SharedPtr< MapiPropertyCollection >	propertyDictionary
	The property dictionary. More...
Static Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
static const int32_t	DefaultCodePage = 20127
Protected Attributes inherited from Aspose::Email::Mapi::MapiMessageItemBase
System::SharedPtr< MapiAttachmentCollection >	attachments
	The collection of attachments. More...
System::SharedPtr< MapiRecipientCollection >	recipients
	The collection of recipients. More...

Detailed Description

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.

The following example demonstrates how to get a MapiNote object from a MapiMessage.

[C#]

var msg = MapiMessage.Load("note.msg");
 
// Check if the loaded message is a supported note type
if (msg.SupportedType == MapiItemType.Note)
{
    // Convert the MAPI message to a MapiNote object
    var mapiNote = (MapiNote)msg.ToMapiMessageItem();
 
    // Display some note info
    Console.WriteLine(mapiNote.Color);
    Console.WriteLine(mapiNote.Body);
}

[Visual Basic]

Dim msg = MapiMessage.Load("note.msg")
 
' Check if the loaded message is a supported note type
If msg.SupportedType = MapiItemType.Note Then
    ' Convert the MAPI message to a MapiNote object
    Dim mapiNote = DirectCast(msg.ToMapiMessageItem(), MapiNote)
 
    ' Display some note info
    Console.WriteLine(mapiNote.Color)
    Console.WriteLine(mapiNote.Body)
End If

Constructor & Destructor Documentation

MapiNote() [1/3]

Aspose::Email::Mapi::MapiNote::MapiNote

(

)

Initializes a new instance of the MapiNote class.

MapiNote() [2/3]

Aspose::Email::Mapi::MapiNote::MapiNote	(	System::String	subject,
		System::String	body
	)

Initializes a new instance of the MapiNote class.

Parameters

subject	The message subject.
body	The message body.

MapiNote() [3/3]

Aspose::Email::Mapi::MapiNote::MapiNote

(

System::SharedPtr< MapiMessage >

msg

)

Constructor

Parameters

msg	The MapiMessage that represents IPM.StickyNote message class

~MapiNote()

virtual Aspose::Email::Mapi::MapiNote::~MapiNote ( )

protectedvirtual

Member Function Documentation

ConvertToMapiMessage()

System::SharedPtr<MapiMessage> Aspose::Email::Mapi::MapiNote::ConvertToMapiMessage ( )

overridevirtual

Converts note object to mapi message

Returns

MapiMessage that represents a MAPI message

Reimplemented from Aspose::Email::Mapi::MapiMessageItemBase.

get_Color()

NoteColor Aspose::Email::Mapi::MapiNote::get_Color

(

)

const

Gets the suggested background color of the Note object

get_CreationDate()

System::DateTime Aspose::Email::Mapi::MapiNote::get_CreationDate

(

)

const

Gets the creation date of note

get_Height()

int32_t Aspose::Email::Mapi::MapiNote::get_Height

(

)

const

Gets height of the visible message window in pixels

get_Width()

int32_t Aspose::Email::Mapi::MapiNote::get_Width

(

)

const

Gets width of the visible message window in pixels

get_XPosition()

int32_t Aspose::Email::Mapi::MapiNote::get_XPosition

(

)

const

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

get_YPosition()

int32_t Aspose::Email::Mapi::MapiNote::get_YPosition

(

)

const

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

GetUnderlyingMessage()

System::SharedPtr<MapiMessage> Aspose::Email::Mapi::MapiNote::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.

[C#]

// 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"
Console.WriteLine(msg.MessageClass);

[Visual Basic]

' Retrieve the underlying MAPI message from the MapiNote object
Dim msg As MapiMessage = mapiNote.GetUnderlyingMessage()
 
' Print out the message class of the MAPI message
' Will output "IPM.StickyNote"
Console.WriteLine(msg.MessageClass)

Save() [1/2]

void Aspose::Email::Mapi::MapiNote::Save	(	System::SharedPtr< System::IO::Stream >	stream,
		NoteSaveFormat	saveFormat
	)

Saves this MapiNote to the given stream using specified format.

The supported save format is MSG.

Parameters

stream	A stream to save to.
saveFormat	A save format.

Exceptions

ArgumentNullException	stream is null.
NotSupportedException	stream does not support writing.
NotSupportedException	The specified format is not supported.

Save() [2/2]

void Aspose::Email::Mapi::MapiNote::Save	(	System::String	filePath,
		NoteSaveFormat	saveFormat
	)

Saves this MapiNote into file using specified format.

The supported save format is MSG.

Parameters

filePath	A file name.
saveFormat	A save format.

Exceptions

ArgumentException	filePath is null or empty.
NotSupportedException	some save option is not supported

set_Color()

void Aspose::Email::Mapi::MapiNote::set_Color

(

NoteColor

value

)

Sets the suggested background color of the Note object

set_CreationDate()

void Aspose::Email::Mapi::MapiNote::set_CreationDate

(

System::DateTime

value

)

Sets the creation date of note

set_Height()

void Aspose::Email::Mapi::MapiNote::set_Height

(

int32_t

value

)

Sets height of the visible message window in pixels

set_Width()

void Aspose::Email::Mapi::MapiNote::set_Width

(

int32_t

value

)

Sets width of the visible message window in pixels

set_XPosition()

void Aspose::Email::Mapi::MapiNote::set_XPosition

(

int32_t

value

)

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

set_YPosition()

void Aspose::Email::Mapi::MapiNote::set_YPosition

(

int32_t

value

)

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