com.aspose.email

Class MapiMessageItemBase

java.lang.Object

com.aspose.email.MapiPropertyContainer

com.aspose.email.MapiMessageItemBase

All Implemented Interfaces:

IMapiMessageItem, IDisposable, Closeable, AutoCloseable

Direct Known Subclasses:

MapiCalendar, MapiContact, MapiDistributionList, MapiJournal, MapiMessage, MapiNote, MapiTask

public abstract class MapiMessageItemBase
extends MapiPropertyContainer
implements IMapiMessageItem, IDisposable, Closeable

Represents the base class for all MapiMessageItem classes and keeps common collections of mapi properties, attachments, recipients.

Field Summary

Fields

Modifier and Type	Field and Description
protected MapiAttachmentCollection	attachments The collection of attachments.
protected MapiNamedPropertyMappingStorage	namedPropertyMappingStorage The named property mapping storage.
protected List<IDisposable>	objectsToDispose The collection of objects to be disposed with MapiMessageItemBase.
protected MapiRecipientCollection	recipients The collection of recipients.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapiMessageItemBase() Initializes a new instance of the MapiMessageItemBase class.
protected	MapiMessageItemBase(MapiPropertyCollection properties) Initializes a new instance of the MapiMessageItemBase class.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkIsDisposed() Checks if the object is disposed and raised exception in this case.
void	close()
protected MapiNamedProperty	createNamedProperty(int type, byte[] data, String nameId, Guid guid)
void	dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
MapiAttachmentCollection	getAttachments() Gets the attachments in the message.
String	getBilling() Contains the billing information associated with an item.
String	getBody() Gets the message text.
String	getBodyHtml() Gets the BodyRtf(getBodyRtf()/setBodyRtf(String)) of the message converted to HTML, if present, otherwise an empty string.
String	getBodyRtf() Gets or sets the RTF formatted message text.
int	getBodyType() Gets the type of the body.
String[]	getCategories() Contains keywords or categories for the message object.
String[]	getCompanies() Contains the names of the companies that are associated with an item.
String	getItemId() The item id, uses with a server
String	getMessageClass() Gets a case-sensitive string that identifies the sender-defined message class, such as IPM.Note.
String	getMileage() Contains the mileage information that is associated with an item.
MapiPropertyCollection	getNamedProperties() Gets the named properties of message.
MapiNamedPropertyMappingStorage	getNamedPropertyMapping() Gets the named property mapping.
MapiProperty	getProperty(PropertyDescriptor pd) Gets MAPI property by property descriptor.
MapiPropertyStream	getPropertyStream() Gets the property stream.
MapiRecipientCollection	getRecipients() Gets the recipients of the message.
int	getSensitivity() Gets the Sensitivity.
String	getSubject() Gets or sets the subject of the message.
String	getSubjectPrefix() Gets a subject prefix that typically indicates some action on a message, such as "FW: " for forwarding.
MapiPropertyCollection	getSubStorages() Gets the sub storages.
int	getSupportedType() Gets the supported item type.
protected void	initNamedPropertyMappingStorage() Inits the named property mapping storage.
void	removeProperty(long tag) Provides correctly removing property from all collections.
void	setBilling(String value) Contains the billing information associated with an item.
void	setBody(String value) Gets the message text.
void	setBodyContent(String content, int contentType) Sets the content of the body.
void	setBodyContent(String content, int contentType, boolean compression) Sets the content of the body.
void	setBodyRtf(String value) Gets or sets the RTF formatted message text.
void	setBodyRtf(String value, boolean compression) Gets or sets the RTF formatted message text.
void	setCategories(String[] value) Contains keywords or categories for the message object.
void	setCompanies(String[] value) Contains the names of the companies that are associated with an item.
void	setMessageClass(String value) Gets a case-sensitive string that identifies the sender-defined message class, such as IPM.Note.
void	setMessageFlags(long flags) Sets the message flags.
void	setMileage(String value) Contains the mileage information that is associated with an item.
void	setNamedPropertyMapping(MapiNamedPropertyMappingStorage value) Sets the named property mapping.
void	setProperty(PropertyDescriptor pd, Object value) Sets MAPI property.
void	setRecipients(MapiRecipientCollection value) Gets the recipients of the message.
void	setSensitivity(int value) Gets the Sensitivity.
protected void	setsIMapiMessageItemMembers(String messageClass, String body, String subject) Sets MessageClass,Body and Subject.
void	setSubject(String value) Gets or sets the subject of the message.

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

Field Detail

attachments

protected MapiAttachmentCollection attachments

The collection of attachments.

recipients

protected MapiRecipientCollection recipients

The collection of recipients.

namedPropertyMappingStorage

protected MapiNamedPropertyMappingStorage namedPropertyMappingStorage

The named property mapping storage.

objectsToDispose

protected List<IDisposable> objectsToDispose

The collection of objects to be disposed with MapiMessageItemBase.

Constructor Detail

MapiMessageItemBase

protected MapiMessageItemBase()

Initializes a new instance of the MapiMessageItemBase class.

MapiMessageItemBase

protected MapiMessageItemBase(MapiPropertyCollection properties)

Initializes a new instance of the MapiMessageItemBase class.

Parameters:

properties - MapiPropertyCollection

Method Detail

getItemId

public String getItemId()

The item id, uses with a server

getProperty

public MapiProperty getProperty(PropertyDescriptor pd)

Gets MAPI property by property descriptor.

Overrides:

getProperty in class MapiPropertyContainer

Parameters:

pd - Property descriptor for looked property

Returns:

Mapi property if it is found, otherwise null.

setProperty

public void setProperty(PropertyDescriptor pd,
               Object value)

Sets MAPI property.

Overrides:

setProperty in class MapiPropertyContainer

Parameters:

pd - The property descriptor.

value - The property data.

getAttachments

public final MapiAttachmentCollection getAttachments()

Gets the attachments in the message.

Value: The attachment collection.

getPropertyStream

public final MapiPropertyStream getPropertyStream()

Gets the property stream.

Value: The property stream.

getNamedProperties

public final MapiPropertyCollection getNamedProperties()

Gets the named properties of message.

Value: The collection of named properties.

getRecipients

public final MapiRecipientCollection getRecipients()

Gets the recipients of the message.

Value: The collection of recipients.

setRecipients

public final void setRecipients(MapiRecipientCollection value)

Gets the recipients of the message.

Value: The collection of recipients.

getSubStorages

public final MapiPropertyCollection getSubStorages()

Gets the sub storages.

Value: The sub storages.

getNamedPropertyMapping

public final MapiNamedPropertyMappingStorage getNamedPropertyMapping()

Gets the named property mapping.

Value: The named property mapping.

getSubjectPrefix

public final String getSubjectPrefix()

Gets a subject prefix that typically indicates some action on a message, such as "FW: " for forwarding.

Value: The string that represents subject prefix.

getBodyType

public final int getBodyType()

Gets the type of the body.

Value: The type of the body.

getBodyRtf

public final String getBodyRtf()

Gets or sets the RTF formatted message text.

Value: The string that represents message body rtf.

When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated. A string value being set must have RTF format. Thus, if it is necessary to set a value in HTML format, the value must be first to encoded within RTF, according to RTF Extensions Specification. To set the content of the body message in HTML or Plain Text formats quickly, please, use SetBodyContent method. When setting a null value or empty string, the values of BodyRtf and Body properties are set null.

setBodyRtf

public final void setBodyRtf(String value)

Gets or sets the RTF formatted message text.

Value: The string that represents message body rtf.

When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated. A string value being set must have RTF format. Thus, if it is necessary to set a value in HTML format, the value must be first to encoded within RTF, according to RTF Extensions Specification. To set the content of the body message in HTML or Plain Text formats quickly, please, use SetBodyContent method. When setting a null value or empty string, the values of BodyRtf and Body properties are set null.

getBodyHtml

public final String getBodyHtml()

Gets the BodyRtf(getBodyRtf()/setBodyRtf(String)) of the message converted to HTML, if present, otherwise an empty string.

getCompanies

public final String[] getCompanies()

Contains the names of the companies that are associated with an item.

setCompanies

public final void setCompanies(String[] value)

Contains the names of the companies that are associated with an item.

getCategories

public final String[] getCategories()

Contains keywords or categories for the message object.

setCategories

public final void setCategories(String[] value)

Contains keywords or categories for the message object.

getMileage

public final String getMileage()

Contains the mileage information that is associated with an item.

setMileage

public final void setMileage(String value)

Contains the mileage information that is associated with an item.

getBilling

public final String getBilling()

Contains the billing information associated with an item.

setBilling

public final void setBilling(String value)

Contains the billing information associated with an item.

getSensitivity

public final int getSensitivity()

Gets the Sensitivity.

Value: The sensitivity.

setSensitivity

public final void setSensitivity(int value)

Gets the Sensitivity.

Value: The sensitivity.

getMessageClass

public final String getMessageClass()

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.

Value: The string that represents message class.

Specified by:

getMessageClass in interface IMapiMessageItem

setMessageClass

public final void setMessageClass(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.

Value: The string that represents message class.

getSupportedType

public final int getSupportedType()

Gets the supported item type.

Value: The MapiItemType.

Specified by:

getSupportedType in interface IMapiMessageItem

getBody

public String getBody()

Gets the message text.

Value: The string that represents message body.

Specified by:

getBody in interface IMapiMessageItem

setBody

public void setBody(String value)

Gets the message text.

Value: The string that represents message body.

Specified by:

setBody in interface IMapiMessageItem

getSubject

public final String getSubject()

Gets or sets the subject of the message.

Value: The string that represents message subject.

When setting a value, the values of SubjectPrefix(PR_SUBJECT_PREFIX) and NormalizedSubject(PR_NORMALIZED_SUBJECT) properties are updated as well. If Subject has no prefix, the value of SubjectPrefix property is set null. When setting a null value or empty string, the values of Subject, SubjectPrefix, NormalizedSubject properties are set null.

Specified by:

getSubject in interface IMapiMessageItem

setSubject

public final void setSubject(String value)

Gets or sets the subject of the message.

Value: The string that represents message subject.

When setting a value, the values of SubjectPrefix(PR_SUBJECT_PREFIX) and NormalizedSubject(PR_NORMALIZED_SUBJECT) properties are updated as well. If Subject has no prefix, the value of SubjectPrefix property is set null. When setting a null value or empty string, the values of Subject, SubjectPrefix, NormalizedSubject properties are set null.

Specified by:

setSubject in interface IMapiMessageItem

setsIMapiMessageItemMembers

protected final void setsIMapiMessageItemMembers(String messageClass,
                               String body,
                               String subject)

Sets MessageClass,Body and Subject.

Parameters:

messageClass -

body -

subject -

dispose

public void dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Specified by:

dispose in interface IDisposable

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

checkIsDisposed

protected final void checkIsDisposed()

Checks if the object is disposed and raised exception in this case.

initNamedPropertyMappingStorage

protected final void initNamedPropertyMappingStorage()

Inits the named property mapping storage.

setNamedPropertyMapping

public final void setNamedPropertyMapping(MapiNamedPropertyMappingStorage value)

Sets the named property mapping.

Parameters:

value - The MapiNamedPropertyMappingStorage.

createNamedProperty

protected MapiNamedProperty createNamedProperty(int type,
                                    byte[] data,
                                    String nameId,
                                    Guid guid)

setBodyRtf

public final void setBodyRtf(String value,
              boolean compression)

Gets or sets the RTF formatted message text.

Value: The string that represents message body rtf.

When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated. A string value being set must have RTF format. Thus, if it is necessary to set a value in HTML format, the value must be first to encoded within RTF, according to RTF Extensions Specification. To set the content of the body message in HTML or Plain Text formats quickly, please, use SetBodyContent method. When setting a null value or empty string, the values of BodyRtf and Body properties are set null.

Parameters:

compression - Specify that the content should be compressed.

setBodyContent

public void setBodyContent(String content,
                  int contentType)

Sets the content of the body.

Parameters:

content - The content.

contentType - Type of the content.

It is provided for setting of the content of the body message in RTF, HTML or Plain Text formats. When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated as well. Note, after the value in HTML format is set, BodyRtf property returns the value which is encoded within RTF.

Throws:

ArgumentNullException - throws if the specified content string is null or empty.

setBodyContent

public void setBodyContent(String content,
                  int contentType,
                  boolean compression)

Sets the content of the body.

Parameters:

content - The content.

contentType - Type of the content.

compression - Specify that the content should be compressed.

It is provided for setting of the content of the body message in RTF, HTML or Plain Text formats. When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated as well. Note, after the value in HTML format is set, BodyRtf property returns the value which is encoded within RTF.

Throws:

ArgumentNullException - throws if the specified content string is null or empty.

setMessageFlags

public final void setMessageFlags(long flags)

Sets the message flags.

Parameters:

flags - The message flags.

removeProperty

public final void removeProperty(long tag)

Provides correctly removing property from all collections.

Parameters:

tag - The tag of MapiProperty.