Class MapiJournal

MapiJournal class

Represents a MAPI journal item.

public sealed class MapiJournal : MapiMessageItemBase

Constructors

Name	Description
MapiJournal()	Initializes a new instance of the `MapiJournal` class.
MapiJournal(string, string, string, string)	Initializes a new instance of the `MapiJournal` class.

Properties

Name	Description
Attachments { get; }	Gets the attachments in the message.
Billing { get; set; }	Contains the billing information associated with an item.
Body { get; set; }	Gets the message text.
BodyHtml { get; }	Gets the `BodyRtf` of the message converted to HTML, if present, otherwise an empty string.
BodyRtf { get; set; }	Gets or sets the RTF formatted message text.
BodyType { get; }	Gets the type of the body.
BriefDescription { get; set; }	Gets or sets the brief description of activity that is being recorded.
Categories { get; set; }	Contains keywords or categories for the message object.
virtual CodePage { get; }	Gets the code page.
Companies { get; set; }	Contains the names of the companies that are associated with an item.
Description { get; set; }	Gets or sets the description of activity that is being recorded.
DocumentStatus { get; set; }	Gets or sets the status of document.
Duration { get; }	Gets the duration of the activity.
EndTime { get; set; }	Gets or sets the time at which the activity ended.
Flags { get; set; }	Gets or sets a flags that contains metadata about the Journal object.
virtual ItemId { get; }	The item id, uses with a server
MessageClass { get; set; }	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.
Mileage { get; set; }	Contains the mileage information that is associated with an item.
NamedProperties { get; }	Gets the named properties of message.
NamedPropertyMapping { get; }	Gets the named property mapping.
virtual Properties { get; }	Gets the collection of properties.
PropertyStream { get; }	Gets the property stream.
Recipients { get; set; }	Gets the recipients of the message.
Sensitivity { get; set; }	Gets the Sensitivity.
StartTime { get; set; }	Gets or sets the time at which the activity began.
Subject { get; set; }	Gets or sets the subject of the message.
SubjectPrefix { get; }	Gets a subject prefix that typically indicates some action on a message, such as “FW: " for forwarding.
SubStorages { get; }	Gets the sub storages.
SupportedType { get; }	Gets the supported item type.

Methods

Name	Description
virtual Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
override GetProperty(PropertyDescriptor)	Gets MAPI property by property descriptor.
GetPropertyBoolean(long)	Gets the value of the property specified by tag as Boolean type.
GetPropertyBytes(long)	Gets the string value of the property specified by tag.
GetPropertyDateTime(long)	Gets the value of the property specified by tag as DateTime type.
GetPropertyInt32(long)	Gets the int32 value of the property specified by tag.
GetPropertyLong(long)	Gets the value of the property specified by tag as Long (int64) type.
GetPropertyShort(long)	Gets the value of the property specified by tag as Short type.
GetPropertyString(long)	Gets the string value of the property specified by tag.
GetPropertyString(long, int)	Gets the string value of the property specified by tag.
GetUnderlyingMessage()	Retrieves the underlying MapiMessage object.
IsStoreUnicodeOk()	Determines if string properties are Unicode encoded or not.
RemoveProperty(long)	Provides correctly removing property from all collections.
Save(Stream)	Saves the specified stream.
Save(string)	Saves the specified file name.
virtual SetBodyContent(string, BodyContentType)	Sets the content of the body.
virtual SetBodyContent(string, BodyContentType, bool)	Sets the content of the body.
SetBodyRtf(string, bool)	Gets or sets the RTF formatted message text.
SetMessageFlags(MapiMessageFlags)	Sets the message flags.
virtual SetProperty(MapiProperty)	Sets the property.
override SetProperty(PropertyDescriptor, object)	Sets MAPI property.
TryGetPropertyData(long)	Try to get the property data with specified tag key.
TryGetPropertyDateTime(long, ref DateTime)	Gets the value of the specified property as DateTime type. A return value indicates whether the operation succeeded.
TryGetPropertyInt32(long, ref int)	Gets the value of the specified property as Int32 type. A return value indicates whether the operation succeeded.
TryGetPropertyLong(long, ref long)	Gets the value of the specified property as Long type. A return value indicates whether the operation succeeded.
TryGetPropertyString(long)	Try to get a property data as string with specified tag.
TryGetPropertyString(long, int)	Try to get a property data as string with specified tag and code page.
TryGetPropertyString(long, ref string)	Gets the value of the specified property as String type. A return value indicates whether the operation succeeded.
TryGetPropertyString(long, ref string, int)	Gets the value of the specified property as String type. A return value indicates whether the operation succeeded.

Remarks

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

Examples

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

[C#]

var msg = MapiMessage.Load("journal.msg");

// Check if the loaded message is a supported journal type
if (msg.SupportedType == MapiItemType.Journal)
{
    // Convert the MAPI message to a MapiJournal object
    var mapiJournal = (MapiJournal)msg.ToMapiMessageItem();
    
    // Display some journal info
    Console.WriteLine(mapiJournal.StartTime);
    Console.WriteLine(mapiJournal.Description);           
}

[Visual Basic]

Dim msg = MapiMessage.Load("journal.msg")

' Check if the loaded message is a supported journal type
If msg.SupportedType = MapiItemType.Journal Then
    ' Convert the MAPI message to a MapiJournal object
    Dim mapiJournal = DirectCast(msg.ToMapiMessageItem(), MapiJournal)
    
    ' Display some journal info
    Console.WriteLine(mapiJournal.StartTime)
    Console.WriteLine(mapiJournal.Description)
End If