com.aspose.email

Class MapiJournal

java.lang.Object

com.aspose.email.MapiPropertyContainer

com.aspose.email.MapiMessageItemBase

com.aspose.email.MapiJournal

All Implemented Interfaces:

IMapiMessageItem, IDisposable, Closeable, AutoCloseable

public final class MapiJournal
extends MapiMessageItemBase

Represents a MAPI journal item.

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.

Example:

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

 // Check if the loaded message is a supported journal type
 if (msg.getSupportedType() == MapiItemType.Journal) {
     // Convert the MAPI message to a MapiJournal object
     MapiJournal mapiJournal = (MapiJournal) msg.toMapiMessageItem();

     // Display some journal info
     System.out.println(mapiJournal.getStartTime());
     System.out.println(mapiJournal.getDescription());
 }
 
 

Field Summary

Fields inherited from class com.aspose.email.MapiMessageItemBase

attachments, namedPropertyMappingStorage, objectsToDispose, recipients

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getBriefDescription() Gets or sets the brief description of activity that is being recorded.
String	getDescription() Gets or sets the description of activity that is being recorded.
int	getDocumentStatus() Gets or sets the status of document.
double	getDuration() Gets the duration of the activity.
Date	getEndTime() Gets or sets the time at which the activity ended.
int	getFlags() Gets or sets a flags that contains metadata about the Journal object.
Date	getStartTime() Gets or sets the time at which the activity began.
MapiMessage	getUnderlyingMessage() Retrieves the underlying MapiMessage object.
void	save(OutputStream stream) Saves the specified stream.
void	save(String fileName) Saves the specified file name.
void	setBriefDescription(String value) Gets or sets the brief description of activity that is being recorded.
void	setDescription(String value) Gets or sets the description of activity that is being recorded.
void	setDocumentStatus(int value) Gets or sets the status of document.
void	setEndTime(Date value) Gets or sets the time at which the activity ended.
void	setFlags(int value) Gets or sets a flags that contains metadata about the Journal object.
void	setStartTime(Date value) Gets or sets the time at which the activity began.

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

MapiJournal

public MapiJournal()

Initializes a new instance of the MapiJournal class.

MapiJournal

public MapiJournal(String subject,
           String body,
           String description,
           String briefDescription)

Initializes a new instance of the MapiJournal class.

Parameters:

subject - The subject.

body - The message body.

description - The description.

briefDescription - The brief description.

Method Detail

getBriefDescription

public final String getBriefDescription()

Gets or sets the brief description of activity that is being recorded.

Value: The string that represents activity.

setBriefDescription

public final void setBriefDescription(String value)

Gets or sets the brief description of activity that is being recorded.

Value: The string that represents activity.

getDescription

public final String getDescription()

Gets or sets the description of activity that is being recorded.

Value: The string that represents activity.

setDescription

public final void setDescription(String value)

Gets or sets the description of activity that is being recorded.

Value: The string that represents activity.

getStartTime

public final Date getStartTime()

Gets or sets the time at which the activity began.

Throws:

ArgumentException - trows when start time is less than end time. Value: The value that represents time at which the activity began.

setStartTime

public final void setStartTime(Date value)

Gets or sets the time at which the activity began.

Throws:

ArgumentException - trows when start time is less than end time. Value: The value that represents time at which the activity began.

getEndTime

public final Date getEndTime()

Gets or sets the time at which the activity ended.

Throws:

ArgumentException - trows when start time is less than end time. Value: The value that represents time at which the activity ended.

setEndTime

public final void setEndTime(Date value)

Gets or sets the time at which the activity ended.

Throws:

ArgumentException - trows when start time is less than end time. Value: The value that represents time at which the activity ended.

getDuration

public final double getDuration()

Gets the duration of the activity.

Value: The value that represents duration of the activity.

getDocumentStatus

public final int getDocumentStatus()

Gets or sets the status of document.

Value: The document status.

setDocumentStatus

public final void setDocumentStatus(int value)

Gets or sets the status of document.

Value: The document status.

getFlags

public final int getFlags()

Gets or sets a flags that contains metadata about the Journal object.

Value: The journal flags.

setFlags

public final void setFlags(int value)

Gets or sets a flags that contains metadata about the Journal object.

Value: The journal flags.

save

public final void save(String fileName)

Saves the specified file name.

Parameters:

fileName - Name of the file.

save

public final void save(OutputStream stream)

Saves the specified stream.

Parameters:

stream - The stream.

getUnderlyingMessage

public final MapiMessage getUnderlyingMessage()

Retrieves the underlying MapiMessage object.

Returns:

The MapiMessage object.

Retrieves the underlying MAPI message from a MapiJournal object and prints out its message class.

 // Retrieve the underlying MAPI message from the MapiJournal object
 MapiMessage msg = mapiJournal.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)0xff, (byte)0xf7, (byte)0xd7, (byte)0xb5, (byte)0xa5, (byte)0xe6, (byte)0xa0, (byte)0x54 })
 System.out.println(msg.getMessageClass());