Aspose::Email::Mapi::MapiJournal Class Referencefinal

Represents the Outlook Journal object. More...

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

Public Member Functions

System::String get_BriefDescription () const
 Gets the brief description of activity that is being recorded. More...
 
void set_BriefDescription (System::String value)
 Sets the brief description of activity that is being recorded. More...
 
System::String get_Description () const
 Gets the description of activity that is being recorded. More...
 
void set_Description (System::String value)
 Sets the description of activity that is being recorded. More...
 
System::DateTime get_StartTime () const
 Gets the time at which the activity began. More...
 
void set_StartTime (System::DateTime value)
 Sets the time at which the activity began. More...
 
System::DateTime get_EndTime () const
 Gets the time at which the activity ended. More...
 
void set_EndTime (System::DateTime value)
 Sets the time at which the activity ended. More...
 
System::TimeSpan get_Duration () const
 Gets the duration of the activity. More...
 
MapiJournalDocumentStatus get_DocumentStatus () const
 Gets the status of document. More...
 
void set_DocumentStatus (MapiJournalDocumentStatus value)
 Sets the status of document. More...
 
MapiJournalFlags get_Flags () const
 Gets a flags that contains metadata about the Journal object. More...
 
void set_Flags (MapiJournalFlags value)
 Sets a flags that contains metadata about the Journal object. More...
 
 MapiJournal ()
 Initializes a new instance of the MapiJournal class. More...
 
 MapiJournal (System::String subject, System::String body, System::String description, System::String briefDescription)
 Initializes a new instance of the MapiJournal class. More...
 
 MapiJournal (System::SharedPtr< MapiMessage > msg)
 Initializes a new instance of the MapiJournal class. More...
 
void Save (System::String fileName)
 Saves the specified file name. More...
 
void Save (System::SharedPtr< System::IO::Stream > stream)
 Saves the specified stream. More...
 
System::SharedPtr< MapiMessageConvertToMapiMessage () override
 Converts journal 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< MapiAttachmentCollectionget_Attachments ()
 Gets the attachments in the message. More...
 
void set_Attachments (System::SharedPtr< MapiAttachmentCollection > value)
 Gets the attachments in the message. More...
 
System::SharedPtr< MapiPropertyStreamget_PropertyStream ()
 Gets the property stream. More...
 
System::SharedPtr< MapiPropertyCollectionget_NamedProperties ()
 Gets the named properties of message. More...
 
System::SharedPtr< MapiRecipientCollectionget_Recipients ()
 Gets the recipients of the message. More...
 
void set_Recipients (System::SharedPtr< MapiRecipientCollection > value)
 Gets the recipients of the message. More...
 
System::SharedPtr< MapiPropertyCollectionget_SubStorages ()
 Gets the sub storages. More...
 
System::SharedPtr< MapiNamedPropertyMappingStorageget_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...
 
Aspose::Email::Storage::Pst::MapiSensitivity get_Sensitivity ()
 Gets the Sensitivity. More...
 
void set_Sensitivity (Aspose::Email::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...
 
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< MapiPropertyGetProperty (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 (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 (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...
 
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< MapiPropertyCollectionget_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< MapiPropertyCollectionGetSubStorages ()
 
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...
 

Friends

class Aspose::Email::Mapi::MapiMessage
 

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< MapiNamedPropertyMappingStoragenamedPropertyMappingStorage
 The named property mapping storage. More...
 
- Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
int32_t codePage
 The code page. More...
 
System::SharedPtr< MapiPropertyCollectionpropertyDictionary
 The property dictionary. More...
 
- Static Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
static const int32_t DefaultCodePage
 
- 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< MapiNamedPropertyCreateNamedProperty (MapiPropertyType type, System::ArrayPtr< uint8_t > data, System::String nameId, System::Guid guid)
 
virtual ~MapiMessageItemBase ()
 
- Protected Attributes inherited from Aspose::Email::Mapi::MapiMessageItemBase
System::SharedPtr< MapiAttachmentCollectionattachments
 The collection of attachments. More...
 
System::SharedPtr< MapiRecipientCollectionrecipients
 The collection of recipients. More...
 

Detailed Description

Represents the Outlook Journal object.

Constructor & Destructor Documentation

◆ MapiJournal() [1/3]

Aspose::Email::Mapi::MapiJournal::MapiJournal ( )

Initializes a new instance of the MapiJournal class.

◆ MapiJournal() [2/3]

Aspose::Email::Mapi::MapiJournal::MapiJournal ( System::String  subject,
System::String  body,
System::String  description,
System::String  briefDescription 
)

Initializes a new instance of the MapiJournal class.

Parameters
subjectThe subject.
bodyThe message body.
descriptionThe description.
briefDescriptionThe brief description.

◆ MapiJournal() [3/3]

Aspose::Email::Mapi::MapiJournal::MapiJournal ( System::SharedPtr< MapiMessage msg)

Initializes a new instance of the MapiJournal class.

Parameters
msgThe MapiMessage that represents IPM.Activity message class.
Exceptions
ArgumentExceptionthrows when message class has unexpected value.
ArgumentNullExceptionthrows when msg is null.

Member Function Documentation

◆ ConvertToMapiMessage()

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

Converts journal object to mapi message

Returns
MapiMessage that represents a MAPI message

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

◆ get_BriefDescription()

System::String Aspose::Email::Mapi::MapiJournal::get_BriefDescription ( ) const

Gets the brief description of activity that is being recorded.

The string that represents activity.

◆ get_Description()

System::String Aspose::Email::Mapi::MapiJournal::get_Description ( ) const

Gets the description of activity that is being recorded.

The string that represents activity.

◆ get_DocumentStatus()

MapiJournalDocumentStatus Aspose::Email::Mapi::MapiJournal::get_DocumentStatus ( ) const

Gets the status of document.

The document status.

◆ get_Duration()

System::TimeSpan Aspose::Email::Mapi::MapiJournal::get_Duration ( ) const

Gets the duration of the activity.

The value that represents duration of the activity.

◆ get_EndTime()

System::DateTime Aspose::Email::Mapi::MapiJournal::get_EndTime ( ) const

Gets the time at which the activity ended.

The value that represents time at which the activity ended.

Exceptions
ArgumentExceptiontrows when start time is less than end time.

◆ get_Flags()

MapiJournalFlags Aspose::Email::Mapi::MapiJournal::get_Flags ( ) const

Gets a flags that contains metadata about the Journal object.

The journal flags.

◆ get_StartTime()

System::DateTime Aspose::Email::Mapi::MapiJournal::get_StartTime ( ) const

Gets the time at which the activity began.

The value that represents time at which the activity began.

Exceptions
ArgumentExceptiontrows when start time is less than end time.

◆ Save() [1/2]

void Aspose::Email::Mapi::MapiJournal::Save ( System::SharedPtr< System::IO::Stream >  stream)

Saves the specified stream.

Parameters
streamThe stream.

◆ Save() [2/2]

void Aspose::Email::Mapi::MapiJournal::Save ( System::String  fileName)

Saves the specified file name.

Parameters
fileNameName of the file.

◆ set_BriefDescription()

void Aspose::Email::Mapi::MapiJournal::set_BriefDescription ( System::String  value)

Sets the brief description of activity that is being recorded.

The string that represents activity.

◆ set_Description()

void Aspose::Email::Mapi::MapiJournal::set_Description ( System::String  value)

Sets the description of activity that is being recorded.

The string that represents activity.

◆ set_DocumentStatus()

void Aspose::Email::Mapi::MapiJournal::set_DocumentStatus ( MapiJournalDocumentStatus  value)

Sets the status of document.

The document status.

◆ set_EndTime()

void Aspose::Email::Mapi::MapiJournal::set_EndTime ( System::DateTime  value)

Sets the time at which the activity ended.

The value that represents time at which the activity ended.

Exceptions
ArgumentExceptiontrows when start time is less than end time.

◆ set_Flags()

void Aspose::Email::Mapi::MapiJournal::set_Flags ( MapiJournalFlags  value)

Sets a flags that contains metadata about the Journal object.

The journal flags.

◆ set_StartTime()

void Aspose::Email::Mapi::MapiJournal::set_StartTime ( System::DateTime  value)

Sets the time at which the activity began.

The value that represents time at which the activity began.

Exceptions
ArgumentExceptiontrows when start time is less than end time.

Friends And Related Function Documentation

◆ Aspose::Email::Mapi::MapiMessage

friend class Aspose::Email::Mapi::MapiMessage
friend