com.compoze.exchange.webdav
Class Message

java.lang.Object

  |

  +--com.compoze.exchange.webdav.AbstractItem

        |

        +--com.compoze.exchange.webdav.AbstractMessage

              |

              +--com.compoze.exchange.webdav.Message

All Implemented Interfaces:

java.lang.Cloneable, IItem, java.io.Serializable

Direct Known Subclasses:

Meeting, Report

public class Message

extends AbstractMessage

implements java.io.Serializable, java.lang.Cloneable

This class extends AbstractItem to represent an item that is a message in the Exchange store.

The following table contains the properties defined in the Exchange store schema and mappings to their corresponding Java enumeration and methods:

Exchange Store Property	Property Enumeration	Java Methods
urn:schemas:mailheader:approved	MailHeaderProperty.APPROVED	getModerator() setModerator(String)
urn:schemas:mailheader:comment	MailHeaderProperty.COMMENT	getComment() setComment(String)
urn:schemas:mailheader:content-base	MailHeaderProperty.CONTENT_BASE	getContentBase() setContentBase(String)
urn:schemas:mailheader:content-description	MailHeaderProperty.CONTENT_DESCRIPTION	getContentDescription() setContentDescription(String)
urn:schemas:mailheader:content-disposition	MailHeaderProperty.CONTENT_DISPOSITION	getContentDisposition() setContentDisposition(String)
urn:schemas:httpmail:content-disposition-type	HttpMailProperty.CONTENT_DISPOSITION_TYPE	getContentDispositionType()
urn:schemas:mailheader:content-id	MailHeaderProperty.CONTENT_ID	getContentId() setContentId(String)
urn:schemas:mailheader:content-language	MailHeaderProperty.CONTENT_LANGUAGE	getContentLanguage() setContentLanguage(String)
urn:schemas:mailheader:content-location	MailHeaderProperty.CONTENT_LOCATION	getContentLocation() setContentLocation(URL)
urn:schemas:httpmail:content-media-type	HttpMailProperty.CONTENT_MEDIA_TYPE	getContentMediaType()
urn:schemas:mailheader:content-transfer-encoding	MailHeaderProperty.CONTENT_TRANSFER_ENCODING	getContentTransferEncoding() setContentTransferEncoding(String)
urn:schemas:mailheader:content-type	MailHeaderProperty.CONTENT_TYPE	getContentType() setContentType(String)
urn:schemas:mailheader:date	MailHeaderProperty.DATE	getDateSent() setDateSent(Date)
urn:schemas:mailheader:disposition	MailHeaderProperty.DISPOSITION	getDisposition() setDisposition(String)
urn:schemas:mailheader:disposition-notification-to	MailHeaderProperty.DISPOSITION_NOTIFICATION_TO	getDispositionNotificationAddress() setDispositionNotificationAddress(String)
urn:schemas:mailheader:distribution	MailHeaderProperty.DISTRIBUTION	getDistribution() setDistribution(List)
urn:schemas:mailheader:expires	MailHeaderProperty.EXPIRES	getExpires() setExpires(Date)
urn:schemas:mailheader:expires	MailHeaderProperty.APPROVED	getExpiryDate() setExpiryDate(Date)
urn:schemas:mailheader:followup-to	MailHeaderProperty.FOLLOWUP_TO	getFollowupNewsgroups() setFollowupNewsgroups(List)
urn:schemas:httpmail:importance urn:schemas:mailheader:importance	HttpMailProperty.IMPORTANCE MailHeaderProperty.IMPORTANCE	getImportance() setImportance(Importance)
urn:schemas:mailheader:in-reply-to	MailHeaderProperty.IN_REPLY_TO	getInReplyTo() setInReplyTo(String)
urn:schemas:mailheader:keywords	MailHeaderProperty.KEYWORDS	getKeywords() setKeywords(List)
urn:schemas:mailheader:lines	MailHeaderProperty.LINES	getLines()
urn:schemas:mailheader:message-id	MailHeaderProperty.MESSAGE_ID	getMessageId() setMessageId(String)
urn:schemas:mailheader:mime-version	MailHeaderProperty.MIME_VERSION	getMimeVersion() setMimeVersion(String)
urn:schemas:mailheader:newsgroups	MailHeaderProperty.NEWSGROUPS	getNewsgroups() setNewsgroups(List)
urn:schemas:mailheader:organization	MailHeaderProperty.ORGANIZATION	getOrganization() setOrganization(String)
urn:schemas:mailheader:original-recipient	MailHeaderProperty.ORIGINAL_RECIPIENT	getOriginalRecipient() setOriginalRecipient(String)
urn:schemas:httpmail:priority urn:schemas:mailheader:priority	HttpMailProperty.PRIORITY MailHeaderProperty.PRIORITY	getImportance() setImportance(Importance)
urn:schemas:mailheader:received	MailHeaderProperty.RECEIVED	AbstractMessage.getDateReceived()
urn:schemas:mailheader:references	MailHeaderProperty.REFERENCES	getReferences() setReferences(String)
urn:schemas:mailheader:relay-version	MailHeaderProperty.RELAY_VERSION	getRelayVersion() setRelayVersion(String)
urn:schemas:mailheader:reply-to	MailHeaderProperty.REPLY_TO	getReplyToAddresses() setReplyToAddresses(List)
urn:schemas:httpmail:reply-by	HttpMailProperty.REPLY_BY	getReplyBy() setReplyBy(Date)
urn:schemas:mailheader:return-path	MailHeaderProperty.RETURN_PATH	getReturnPath() setReturnPath(String)
urn:schemas:httpmail:savedestination	HttpMailProperty.SAVE_DESTINATION	getSaveDestination() setSaveDestination(String)
urn:schemas:httpmail:saveinsent	HttpMailProperty.SAVE_IN_SENT	isSaveInSent() setSaveInSent(boolean)
urn:schemas:mailheader:sender	MailHeaderProperty.SENDER	getSender() setSender(String)
urn:schemas:httpmail:senderemail	HttpMailProperty.SENDER_EMAIL	getSenderEmail()
urn:schemas:httpmail:sendername	HttpMailProperty.SENDER_NAME	getSenderName() setSenderName(String)
urn:schemas:httmpheader:submitted	HttpMailProperty.SUBMITTED	isSubmitted() setSubmitted(boolean)
urn:schemas:mailheader:summary	MailHeaderProperty.SUMMARY	getSummary() setSummary(String)
urn:schemas:mailheader:thread-index	MailHeaderProperty.THREAD_INDEX	getThreadIndex() setThreadIndex(String)
urn:schemas:mailheader:thread-topic	MailHeaderProperty.THREAD_TOPIC	getThreadTopic() setThreadTopic(String)
urn:schemas:mailheader:x-mailer	MailHeaderProperty.X_MAILER	getXMailer() setXMailer(String)
urn:schemas:mailheader:x-message-flag r	MailHeaderProperty.X_MESSAGE_FLAG	getMessageFlag() setMessageFlag(MessageFlag)

Below is an example of how to create and send a message:

   MailFolder draftsFolder = m_session.getUserMailbox().getDraftsFolder();

   Message message = new Message("first.last@compoze.com", "Testing WebDAV Message API");
   message.setBody("Please delete message upon receiving.");
   message.setImportance(Importance.HIGH);
   message.setSensitivity(Sensitivity.CONFIDENTIAL);

   //  Add attachment
   try
   	{
	Attachment attachment = new Attachment("attachment.txt",
	    new ByteArrayInputStream (new String ("Here is some attachment data").getBytes()));
	message.addAttachment(attachment);
   	}
   catch (IOException ioe)
   	{
 	ioe.printStackTrace ();
   	}

   draftsFolder.addItem(message);
   message.send();
 

See Also:

Serialized Form

Field Summary

static java.lang.String	FORWARD_PREFIX
static java.lang.String	REPLY_PREFIX

Constructor Summary

	Message(com.compoze.util.mail.InternetAddress[] to, java.lang.String sSubject) Constructor.
	Message(java.util.List toAddresses, java.lang.String sSubject) Constructor.
	Message(java.lang.String sSubject) Constructor.
protected	Message(java.lang.String sSubject, OutlookMessageType outlookMessageClass, ContentClass contentClass)
	Message(java.lang.String sToAddresses, java.lang.String sSubject) Constructor.
protected	Message(java.lang.String sSubject, java.lang.String sOutlookMessageClass, java.lang.String sContentClass)

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
Message	forward() Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverForward()
Message	forward(Folder folder) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverForward(Folder)
java.lang.String	getComment() Gets the comment for the message.
java.lang.String	getContentBase() Gets the base for relative Uniform Resource Identifiers (URIs) occurring in other header fields and in HTML documents that do not have any BASE element within the HTML markup.
java.lang.String	getContentDescription() Gets the optional description of the message body part.
java.lang.String	getContentDisposition() Gets the intended disposition of the message body part.
java.lang.String	getContentDispositionType() Gets the type portion of the Content-Disposition Multipurpose Internet Mail Extensions (MIME) header for the message body part.
java.lang.String	getContentId() Gets the unique identifier for the message body part.
java.lang.String	getContentLanguage() Gets the language identifier for the message body part text content.
java.lang.String	getContentLocation() Gets the Uniform Resource Identifier (URI) that corresponds to the content of the message body part.
java.lang.String	getContentMediaType() Gets the content media type for the message body part.
java.lang.String	getContentTransferEncoding() Gets the encoding mechanism used to encode the message body part content.
java.lang.String	getContentType() Gets the message body part content type.
java.util.Date	getDateSent() Gets the date the message was sent.
static java.util.List	getDefaultProperties() Gets a list of default properties pertaining to a message.
java.lang.String	getDisplayCC() Method description.
java.lang.String	getDisplayTo()
java.lang.String	getDisposition() Gets the Mail Delivery Notification (MDN) status indicator for the message.
java.lang.String	getDispositionNotificationAddress() Gets where disposition notifications should be sent.
java.util.LinkedList	getDistribution() Gets a list of newsgroups, intended to restrict the ditribution of the message.
java.lang.String	getDistributionString() Gets the comma seperated list of newsgroups, intended to restrict the ditribution of the message.
java.util.Date	getExpires() Gets the date the message expires.
java.util.Date	getExpiryDate() Gets the expiry date of the message.
java.util.LinkedList	getFollowupNewsgroups() Gets a list of newsgroups to which follow up messages are to be posted.
java.lang.String	getFollowupNewsgroupString() Gets the comma seperated list of newsgroups to which follow up messages are to be posted.
Importance	getHeaderImportance() Gets the level of importance of message stored in the Header: Importance field.
java.lang.String	getHTMLDescription() Gets the HTML content of this message.
Importance	getImportance() Gets the level of importance of this message.
java.lang.String	getInReplyTo() Gets the message identifier of the message which this message is a reply.
java.util.LinkedList	getKeywords() Gets a list of keywords for the message.
java.lang.String	getKeywordsString() Gets the comma seperated list of keywords for the message.
int	getLines() Gets the number of lines in the body of the (newsgroup) message.
MessageFlag	getMessageFlag() Gets the message flag for this message.
java.lang.String	getMessageId() Gets the unique identifier of message.
java.lang.String	getMimeVersion() Gets the version of Multipurpose Internet Mail Extensions (MIME) used to format the message.
java.lang.String	getModerator() Gets the address of the moderator that approved and posted the message.
java.util.LinkedList	getNewsgroups() Gets a list of newsgroup addresses for the message.
java.lang.String	getNewsgroupsString() Gets a comma seperated list of newsgroup addresses for the message.
java.lang.String	getOrganization() Gets the organization of sender.
java.lang.String	getOriginalRecipient() Gets the e-mail address of an original recipient of the message.
Priority	getPriority() Gets the priority of the message.
static java.util.List	getProperties() Gets a list of properties pertaining to a message.
java.lang.String	getReceived() Gets the Simple Mail Transport Protocol (SMTP) host Received headers for a message.
java.lang.String	getReferences() Gets the Usenet header used to correlate replies with their original messages.
java.lang.String	getRelayVersion() Gets the version of the program responsible for transmitting an article over the immediate link.
java.util.Date	getReplyBy() Gets date to reply to this message.
java.util.LinkedList	getReplyToAddresses() Gets the addresses to which replies should be sent.
java.lang.String	getReplyToAddressString() Gets the comma seperated addresses to which replies should be sent.
java.lang.String	getReturnPath() Gets the address of the message originator.
java.lang.String	getReturnReceiptTo() Gets the address to which return receipts should be sent.
java.lang.String	getSaveDestination() Gets where the message should be saved after it is transmitted using the mail transmission URI.
java.lang.String	getSender() Gets the sender of the message.
java.lang.String	getSenderEmail() Gets the email address of the message sender.
java.lang.String	getSenderName() Gets the display name of the message sender.
java.lang.String	getSummary() Gets the summary of the message.
java.lang.String	getThreadIndex() Gets the identifier of a particular conversation thread; computed from message references.
java.lang.String	getThreadTopic() Gets the topic of discussion thread.
java.lang.String	getXMailer() Gets the name of the software (X-Mailer) used to send the message.
boolean	isMeetingCancellation() Determines if this message is a meeting cancellation (the result of calling AbstractMessage.getType() is IPM.Schedule.Meeting.Canceled).
boolean	isMeetingRequest() Determines if this message is a meeting request (the result of calling AbstractMessage.getType() is IPM.Schedule.Meeting.Request).
boolean	isMeetingResponse() Determines if this message is a meeting response (the result of calling AbstractMessage.getType() is IPM.Schedule.Meeting.Resp.Neg or IPM.Schedule.Meeting.Resp.Pos or IPM.Schedule.Meeting.Resp.Tent).
boolean	isOutOfOfficeReply() Determines if a message is an out of office reply.
boolean	isSaveInSent() Gets whether the item should be saved in the Sent Items folder after it is transmitted.
boolean	isSubmitted() Gets whether the message has been submitted to the Outbox.
boolean	isUndeliverableMessage() Determines if a message is an undeliverable message.
Message	reply() Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverReply()
Message	reply(Folder folder, boolean bReplyAll) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverReply(Folder, boolean)
Message	replyAll() Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverReplyAll()
com.compoze.util.webdav.WebdavResponse30	send() Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverSend()
com.compoze.util.webdav.WebdavResponse30	send(Mailbox mailbox) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverSend(Mailbox)
com.compoze.util.webdav.WebdavResponse30	send(java.lang.String sMailSubmissionURI) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverSend(String)
Message	serverForward() Requests the server to create a message to forward.
Message	serverForward(Folder folder) Requests the server to create a message to forward.
Message	serverReply() Requests the server to create a message to reply with.
Message	serverReply(Folder folder, boolean bReplyAll) Requests the server to create a message to reply with.
Message	serverReplyAll() Requests the server to create a message to reply all with.
void	serverSend() Requests the server to send the message using the user's mailbox.
void	serverSend(Mailbox mailbox) Requests the server to send the message using the specified user mailbox.
void	serverSend(java.lang.String sMailSubmissionURI) Requests the server to send the message using the specified submission URI.
void	serverUpdate(boolean bServerRefresh) Requests the server to update the message of any changed properties.
void	setComment(java.lang.String sComment) Sets the comment for the message.
void	setContentBase(java.lang.String sContentBase) Sets the base for relative Uniform Resource Identifiers (URIs) occurring in other header fields and in HTML documents that do not have any BASE element within the HTML markup.
void	setContentDescription(java.lang.String sContentDescription) Sets the optional description of the message body part.
void	setContentDisposition(java.lang.String sContentDisposition) Sets the intended disposition of the message body part.
void	setContentId(java.lang.String sContentId) Sets the unique identifier for the message body part.
void	setContentLanguage(java.lang.String sContentLanguage) Sets the language identifier for the message body part text content.
void	setContentLocation(java.lang.String sContentLocation) Sets the Uniform Resource Identifier (URI) that corresponds to the content of the message body part.
void	setContentLocation(java.net.URL contentLocation) Sets the Uniform Resource Identifier (URI) that corresponds to the content of the message body part.
void	setContentTransferEncoding(java.lang.String sContentTransferEncoding) Sets the encoding mechanism used to encode the message body part content.
void	setContentType(java.lang.String sContentType) Sets the message body part content type.
void	setDateSent(java.util.Date sent) Gets the date the message was sent.
void	setDisposition(java.lang.String sDispostion) Sets the Mail Delivery Notification (MDN) status indicator for the message.
void	setDispositionNotificationAddress(java.lang.String sDispositionNotificationAddress) Sets where disposition notifications should be sent.
void	setDistribution(java.util.List distribution) Sets a list of newsgroups, intended to restrict the ditribution of the message.
void	setExpires(java.util.Date expires) Sets the date the message expires.
void	setExpiryDate(java.util.Date expiryDate) Sets the expiry date of the message.
void	setFollowupNewsgroups(java.util.List newsgroups) Sets a list of newsgroups to which folloow up messages are to be posted.
void	setHeaderImportance(Importance importance) Sets the level of importance of message in the Header: Importance field.
void	setHTMLDescription(java.lang.String sHTMLDescription) Sets the HTML content of this message.
void	setImportance(Importance importance) Sets the level of importance of this message.
void	setInReplyTo(java.lang.String sInReplyTo) Sets the message identifier of the message which this message is a reply.
void	setKeywords(java.util.List keywords) Sets a list of keywords for the message.
void	setMessageFlag(MessageFlag flag) Sets the message flag for this message
void	setMessageId(java.lang.String sMessageId) Sets the unique identifier of message.
void	setMimeVersion(java.lang.String sMimeVersion) Sets the version of Multipurpose Internet Mail Extensions (MIME) used to format the message.
void	setModerator(java.lang.String sModerator) Gets the address of the moderator that approved and posted the message.
void	setNewsgroups(java.util.List newsgroups) Sets a list of newsgroup addresses for the message.
void	setOrganization(java.lang.String sOrganization) Sets the organization of sender.
void	setOriginalRecipient(java.lang.String sOriginalRecipient) Sets the e-mail address of an original recipient of the message.
void	setPriority(Priority priority) Sets the priority of the message.
void	setReferences(java.lang.String sReferences) Sets the Usenet header used to correlate replies with their original messages.
void	setRelayVersion(java.lang.String sRelayVersion) Sets the version of the program responsible for transmitting an article over the immediate link.
void	setReplyBy(java.util.Date replyBy) Sets date to reply to this message.
void	setReplyToAddresses(java.util.List addresses) Sets the addresses to which replies should be sent.
void	setReturnPath(java.lang.String sReturnPath) Sets the address of the message originator.
void	setReturnReceiptTo(java.lang.String sReturnReceiptTo) Sets the address to which return receipts should be sent.
void	setSaveDestination(java.lang.String sSaveDestination) Sets where the message should be saved after it is transmitted using the mail transmission URI.
void	setSaveDestination(java.net.URL saveDestination) Sets where the message should be saved after it is transmitted using the mail transmission URI.
void	setSaveInSent(boolean bSaveInSent) Sets whether the item should be saved in the Sent Items folder after it is transmitted.
void	setSender(java.lang.String sSender) Sets the sender of the message.
void	setSenderName(java.lang.String sSenderName) Sets the display name of the message sender.
void	setSubmitted(boolean bSubmitted) Sets whether the message has been submitted to the Outbox.
void	setSummary(java.lang.String sSummary) Sets the summary of the message.
void	setThreadIndex(java.lang.String sThreadIndex) Sets the identifier of a particular conversation thread; computed from message references.
void	setThreadTopic(java.lang.String sTopic) Sets the topic of discussion thread.
void	setXMailer(java.lang.String sName) Sets the name of the software used to send the message.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class com.compoze.exchange.webdav.AbstractMessage

addAttachment, createFilename, equals, getAttachments, getBccAddresses, getBccAddressesString, getBccRecipients, getBody, getCategories, getCcAddresses, getCcAddressesString, getCcRecipients, getContactNames, getDateReceived, getFrom, getFromAddresses, getFromAddressesString, getFromEmailAddress, getFromName, getNormalizedSubject, getSensitivity, getSize, getSubject, getTextDescription, getToAddresses, getToAddressesString, getToRecipients, getType, hasAttachment, isRead, serverDeleteAttachment, serverGetAttachments, setBccAddresses, setBccRecipients, setBccRecipients, setBody, setCategories, setCategories, setCcAddresses, setCcRecipients, setCcRecipients, setContactNames, setContactNames, setDateReceived, setFrom, setFrom, setFromAddress, setFromAddresses, setRead, setSensitivity, setSubject, setTextDescription, setToAddresses, setToRecipients, setToRecipients, setType

Methods inherited from class com.compoze.exchange.webdav.AbstractItem

copy, copy, copy, createFilename, delete, equals, getContentClass, getCreationDate, getDateLastModified, getDisplayName, getFile, getHRef, getID, getParentFolder, getPermanentURL, getUID, isFolder, isHidden, isReadOnly, isRoot, move, move, move, serverCopyTo, serverCopyTo, serverCopyTo, serverCopyTo, serverDelete, serverGetParentFolder, serverMoveTo, serverMoveTo, serverMoveTo, serverMoveTo, serverUpdate, setContentClass, setContentClass, setHidden, setReadOnly, setReleased, setType, setUID, update, update, validate

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FORWARD_PREFIX

public static final java.lang.String FORWARD_PREFIX

REPLY_PREFIX

public static final java.lang.String REPLY_PREFIX

Constructor Detail

Message

protected Message(java.lang.String sSubject,
                  java.lang.String sOutlookMessageClass,
                  java.lang.String sContentClass)

Message

protected Message(java.lang.String sSubject,
                  OutlookMessageType outlookMessageClass,
                  ContentClass contentClass)

Message

public Message(java.lang.String sSubject)

Constructor.

Parameters:

sSubject - the subject of the message

Message

public Message(java.lang.String sToAddresses,
               java.lang.String sSubject)

Constructor.

Parameters:

sToAddresses - comma seperated list of addresses to send message to

sSubject - the subject of the message or empty)

Message

public Message(java.util.List toAddresses,
               java.lang.String sSubject)

Constructor.

Parameters:

toAddress - list of addresses to send message to

sSubject - the subject of the message

Message

public Message(com.compoze.util.mail.InternetAddress[] to,
               java.lang.String sSubject)

Constructor.

Parameters:

array - of InternetAddress objects of recipients to send message to

sSubject - the subject of the message

Method Detail

isMeetingCancellation

public boolean isMeetingCancellation()

Determines if this message is a meeting cancellation (the result of calling AbstractMessage.getType() is IPM.Schedule.Meeting.Canceled).

Returns:

true if the message is a meeting cancellation

isMeetingRequest

public boolean isMeetingRequest()

Determines if this message is a meeting request (the result of calling AbstractMessage.getType() is IPM.Schedule.Meeting.Request).

Returns:

true if the message is a meeting request

isMeetingResponse

public boolean isMeetingResponse()

Determines if this message is a meeting response (the result of calling AbstractMessage.getType() is IPM.Schedule.Meeting.Resp.Neg or IPM.Schedule.Meeting.Resp.Pos or IPM.Schedule.Meeting.Resp.Tent).

Returns:

true if the message is a meeting response

getHTMLDescription

public java.lang.String getHTMLDescription()

Gets the HTML content of this message.

Returns:

the HTML content of the message.

setHTMLDescription

public void setHTMLDescription(java.lang.String sHTMLDescription)

Sets the HTML content of this message.

Parameters:

sHTMLDescription - the HTML content of the message.

getMessageFlag

public MessageFlag getMessageFlag()

Gets the message flag for this message.

Returns:

the message flag for the message or null if flag is not set.

See Also:

MailHeaderProperty.X_MESSAGE_FLAG

setMessageFlag

public void setMessageFlag(MessageFlag flag)

Sets the message flag for this message

Parameters:

flag - the flag to set this message to

See Also:

MapiProperty.MESSAGE_FLAG_STATUS, MapiProperty.MESSAGE_FLAG_CODE

getReplyBy

public java.util.Date getReplyBy()

Gets date to reply to this message. This method is used in conjuction with getting the message flag (see getMessageFlag()).

Returns:

the date to reply to the message.

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.REPLY_BY, getMessageFlag()

setReplyBy

public void setReplyBy(java.util.Date replyBy)

Sets date to reply to this message. This method is used in conjunction with setting the message flag (see setMessageFlag(MessageFlag)). .

Parameters:

replyBy - the date to reply to the message.

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.REPLY_BY, setMessageFlag(MessageFlag)

isOutOfOfficeReply

public boolean isOutOfOfficeReply()

Determines if a message is an out of office reply.

Returns:

true if the message is an out of office reply, or its type is IPM.Note.Rules.OofTemplate.Microsoft

isUndeliverableMessage

public boolean isUndeliverableMessage()

Determines if a message is an undeliverable message.

Returns:

true if the message is an undeliverable message, or its type is REPORT.IPM.Note.NDR

getXMailer

public java.lang.String getXMailer()

Gets the name of the software (X-Mailer) used to send the message.

Returns:

the name of the software (X-Mailer), or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.X_MAILER

setXMailer

public void setXMailer(java.lang.String sName)

Sets the name of the software used to send the message.

Parameters:

sName - the name

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.X_MAILER

getThreadTopic

public java.lang.String getThreadTopic()

Gets the topic of discussion thread.

Returns:

the topic, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.THREAD_TOPIC

setThreadTopic

public void setThreadTopic(java.lang.String sTopic)

Sets the topic of discussion thread.

Parameters:

sTopic - the topic

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.THREAD_TOPIC

getThreadIndex

public java.lang.String getThreadIndex()

Gets the identifier of a particular conversation thread; computed from message references.

Returns:

the thread index, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.THREAD_INDEX

setThreadIndex

public void setThreadIndex(java.lang.String sThreadIndex)

Sets the identifier of a particular conversation thread; computed from message references.

Parameters:

sThreadIndex - the thread index

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.THREAD_INDEX

getSummary

public java.lang.String getSummary()

Gets the summary of the message.

Returns:

the summary, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.SUMMARY

setSummary

public void setSummary(java.lang.String sSummary)

Sets the summary of the message.

Parameters:

sSummary - the summary

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.SUMMARY

isSubmitted

public boolean isSubmitted()

Gets whether the message has been submitted to the Outbox.

Returns:

true if submitted; false otherwise

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SUBMITTED

setSubmitted

public void setSubmitted(boolean bSubmitted)

Sets whether the message has been submitted to the Outbox.

Parameters:

bSubmitted - true if submitted; false otherwise

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SUBMITTED

getSenderEmail

public java.lang.String getSenderEmail()

Gets the email address of the message sender.

Returns:

the sender's email address, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SENDER_EMAIL

getSenderName

public java.lang.String getSenderName()

Gets the display name of the message sender.

Returns:

the display name of sender, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SENDER_NAME

setSenderName

public void setSenderName(java.lang.String sSenderName)

Sets the display name of the message sender.

Parameters:

sSenderName - display name of sender

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SENDER_NAME

getSender

public java.lang.String getSender()

Gets the sender of the message.

It is used to designate who actually sent a message when the From: header has multiple addresses or when the sender is not the single addressee on the From: header.

Returns:

the sender's address, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.SENDER

setSender

public void setSender(java.lang.String sSender)

Sets the sender of the message.

It is used to designate who actually sent a message when the From: header has multiple addresses, or when the sender is not the single addressee on the From: header.

Parameters:

sSender - the sender's address

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.SENDER

isSaveInSent

public boolean isSaveInSent()

Gets whether the item should be saved in the Sent Items folder after it is transmitted.

By default, the message will be stored in the user's Sent Items folder. To specify an alternate folder, use getSaveDestination() and setSaveDestination(URL) methods.

Returns:

true to be saved in Sent Items folder; false otherwise

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SAVE_IN_SENT

setSaveInSent

public void setSaveInSent(boolean bSaveInSent)

Sets whether the item should be saved in the Sent Items folder after it is transmitted.

By default, the message will be stored in the user's Sent Items folder. To specify an alternate folder, use getSaveDestination() and setSaveDestination(String) methods.

Parameters:

bSaveInSent - true to be saved in Sent Items folder; false otherwise

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SAVE_IN_SENT

getSaveDestination

public java.lang.String getSaveDestination()

Gets where the message should be saved after it is transmitted using the mail transmission URI.

Returns:

the url to the folder to save this message, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SAVE_DESTINATION

setSaveDestination

public void setSaveDestination(java.net.URL saveDestination)

Sets where the message should be saved after it is transmitted using the mail transmission URI.

Parameters:

saveDestination - the url to the folder to save this message

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SAVE_DESTINATION

setSaveDestination

public void setSaveDestination(java.lang.String sSaveDestination)

Sets where the message should be saved after it is transmitted using the mail transmission URI.

Parameters:

sSaveDestination - the url to the folder to save this message

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SAVE_DESTINATION

getReturnReceiptTo

public java.lang.String getReturnReceiptTo()

Gets the address to which return receipts should be sent.

Returns:

the return receipts address, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.RETURN_RECEIPT_TO

setReturnReceiptTo

public void setReturnReceiptTo(java.lang.String sReturnReceiptTo)

Sets the address to which return receipts should be sent.

Parameters:

sReturnReceiptTo - the return receipts address

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.RETURN_RECEIPT_TO

getReturnPath

public java.lang.String getReturnPath()

Gets the address of the message originator.

Returns:

the message originator address, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.RETURN_PATH

setReturnPath

public void setReturnPath(java.lang.String sReturnPath)

Sets the address of the message originator.

Parameters:

sReturnPath - the message originator address

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.RETURN_PATH

getReplyToAddressString

public java.lang.String getReplyToAddressString()

Gets the comma seperated addresses to which replies should be sent.

Returns:

comma seperated list of addresses, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.REPLY_TO

getReplyToAddresses

public java.util.LinkedList getReplyToAddresses()

Gets the addresses to which replies should be sent.

Returns:

list of addresses, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.REPLY_TO

setReplyToAddresses

public void setReplyToAddresses(java.util.List addresses)

Sets the addresses to which replies should be sent.

Parameters:

addressList - list of addresses

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.REPLY_TO

getRelayVersion

public java.lang.String getRelayVersion()

Gets the version of the program responsible for transmitting an article over the immediate link.

Returns:

the version of the program, or null if not set

See Also:

MailHeaderProperty.RELAY_VERSION

setRelayVersion

public void setRelayVersion(java.lang.String sRelayVersion)

Sets the version of the program responsible for transmitting an article over the immediate link.

Parameters:

sRelayVersion - the version of the program

See Also:

MailHeaderProperty.RELAY_VERSION

getReferences

public java.lang.String getReferences()

Gets the Usenet header used to correlate replies with their original messages.

Returns:

the Usenet header, or null if not set

See Also:

MailHeaderProperty.REFERENCES

setReferences

public void setReferences(java.lang.String sReferences)

Sets the Usenet header used to correlate replies with their original messages.

Parameters:

sReferences - the Usenet header

See Also:

MailHeaderProperty.REFERENCES

getReceived

public java.lang.String getReceived()

Gets the Simple Mail Transport Protocol (SMTP) host Received headers for a message.

Returns:

the host Received headers, or null if not set

See Also:

MailHeaderProperty.RECEIVED

getPriority

public Priority getPriority()

Gets the priority of the message.

Returns:

the priority, or null if not set

See Also:

HttpMailProperty.PRIORITY, MailHeaderProperty.PRIORITY

setPriority

public void setPriority(Priority priority)

Sets the priority of the message.

Parameters:

priority - the priority

See Also:

HttpMailProperty.PRIORITY, MailHeaderProperty.PRIORITY

getOriginalRecipient

public java.lang.String getOriginalRecipient()

Gets the e-mail address of an original recipient of the message.

Returns:

the original recipient email address, or null if not set

See Also:

MailHeaderProperty.ORIGINAL_RECIPIENT

setOriginalRecipient

public void setOriginalRecipient(java.lang.String sOriginalRecipient)

Sets the e-mail address of an original recipient of the message.

Parameters:

sAddress - the original recipient email address

See Also:

MailHeaderProperty.ORIGINAL_RECIPIENT

getOrganization

public java.lang.String getOrganization()

Gets the organization of sender.

Returns:

the organization, or null if not set

See Also:

MailHeaderProperty.ORGANIZATION

setOrganization

public void setOrganization(java.lang.String sOrganization)

Sets the organization of sender.

Parameters:

sOrganization - the organization

See Also:

MailHeaderProperty.ORGANIZATION

getNewsgroupsString

public java.lang.String getNewsgroupsString()

Gets a comma seperated list of newsgroup addresses for the message.

Returns:

comma seperated list of newsgroup addresses, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.NEWSGROUPS

getNewsgroups

public java.util.LinkedList getNewsgroups()

Gets a list of newsgroup addresses for the message.

Returns:

list of newsgroup addresses, or an emply list if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.NEWSGROUPS

setNewsgroups

public void setNewsgroups(java.util.List newsgroups)

Sets a list of newsgroup addresses for the message.

Parameters:

newsgroups - list of newsgroup addresses

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.NEWSGROUPS

getMessageId

public java.lang.String getMessageId()

Gets the unique identifier of message.

Returns:

the identifier, or null if not set

See Also:

MailHeaderProperty.MESSAGE_ID

setMessageId

public void setMessageId(java.lang.String sMessageId)

Sets the unique identifier of message.

Parameters:

sMessageId - the identifier

See Also:

MailHeaderProperty.MESSAGE_ID

getLines

public int getLines()

Gets the number of lines in the body of the (newsgroup) message.

Returns:

the number of lines

See Also:

MailHeaderProperty.LINES

getKeywordsString

public java.lang.String getKeywordsString()

Gets the comma seperated list of keywords for the message.

Returns:

comma seperated list of keywords, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.KEYWORDS

getKeywords

public java.util.LinkedList getKeywords()

Gets a list of keywords for the message.

Returns:

list of keywords, or an empty list if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.KEYWORDS

setKeywords

public void setKeywords(java.util.List keywords)

Sets a list of keywords for the message.

Parameters:

keywords - list of keywords

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.KEYWORDS

getInReplyTo

public java.lang.String getInReplyTo()

Gets the message identifier of the message which this message is a reply.

Returns:

the message identifier, or null if not set

See Also:

MailHeaderProperty.IN_REPLY_TO

setInReplyTo

public void setInReplyTo(java.lang.String sInReplyTo)

Sets the message identifier of the message which this message is a reply.

Parameters:

sInReplyTo - the message identifier

See Also:

MailHeaderProperty.IN_REPLY_TO

getImportance

public Importance getImportance()

Gets the level of importance of this message.

Overrides:

getImportance in class AbstractMessage

Returns:

the importance of the message, or null if not set

See Also:

HttpMailProperty.IMPORTANCE, MailHeaderProperty.IMPORTANCE

setImportance

public void setImportance(Importance importance)

Sets the level of importance of this message.

Overrides:

setImportance in class AbstractMessage

Parameters:

importance - the level of importance of the message

See Also:

HttpMailProperty.IMPORTANCE, MailHeaderProperty.IMPORTANCE

getHeaderImportance

public Importance getHeaderImportance()

Gets the level of importance of message stored in the Header: Importance field.

Returns:

the importance of message, or null if not set

See Also:

MailHeaderProperty.IMPORTANCE

setHeaderImportance

public void setHeaderImportance(Importance importance)

Sets the level of importance of message in the Header: Importance field.

Parameters:

importance - the level of importance

See Also:

MailHeaderProperty.IMPORTANCE

getFollowupNewsgroupString

public java.lang.String getFollowupNewsgroupString()

Gets the comma seperated list of newsgroups to which follow up messages are to be posted.

This property corresponds to the Followup-To: mailheader.

Returns:

comma seperated list of newsgroups, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.FOLLOWUP_TO

getFollowupNewsgroups

public java.util.LinkedList getFollowupNewsgroups()

Gets a list of newsgroups to which follow up messages are to be posted.

This property corresponds to the Followup-To: mailheader.

Returns:

list of newsgroups, or an empty list if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.FOLLOWUP_TO

setFollowupNewsgroups

public void setFollowupNewsgroups(java.util.List newsgroups)

Sets a list of newsgroups to which folloow up messages are to be posted.

This property corresponds to the Followup-To: mailheader.

Parameters:

newsgroups - list of newsgroups

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.FOLLOWUP_TO

getExpiryDate

public java.util.Date getExpiryDate()

Gets the expiry date of the message. Microsoft Outlook uses this in internet mode for setting the expiration date of a message.

Returns:

the expiry date, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.EXPIRY_DATE

setExpiryDate

public void setExpiryDate(java.util.Date expiryDate)

Sets the expiry date of the message. Microsoft Outlook uses this in internet mode for setting the expiration date of a message.

Parameters:

expiryDate - the expiry date

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.EXPIRY_DATE

getExpires

public java.util.Date getExpires()

Gets the date the message expires.

Returns:

expiration date, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.EXPIRES

setExpires

public void setExpires(java.util.Date expires)

Sets the date the message expires.

Returns:

expires expiration date

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.EXPIRES

getDistributionString

public java.lang.String getDistributionString()

Gets the comma seperated list of newsgroups, intended to restrict the ditribution of the message.

Returns:

comma seperated list of newsgroups, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.DISTRIBUTION

getDistribution

public java.util.LinkedList getDistribution()

Gets a list of newsgroups, intended to restrict the ditribution of the message.

Returns:

list of newsgroups, or an empty list if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.DISTRIBUTION

setDistribution

public void setDistribution(java.util.List distribution)

Sets a list of newsgroups, intended to restrict the ditribution of the message.

Parameters:

distribution - list of newsgroups

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.DISTRIBUTION

getDispositionNotificationAddress

public java.lang.String getDispositionNotificationAddress()

Gets where disposition notifications should be sent.

Returns:

diposition notification address, or null if not set

See Also:

MailHeaderProperty.DISPOSITION_NOTIFICATION_TO

setDispositionNotificationAddress

public void setDispositionNotificationAddress(java.lang.String sDispositionNotificationAddress)

Sets where disposition notifications should be sent.

Parameters:

sDispositionNotificationAddress - diposition notification address

See Also:

MailHeaderProperty.DISPOSITION_NOTIFICATION_TO

getDisposition

public java.lang.String getDisposition()

Gets the Mail Delivery Notification (MDN) status indicator for the message.

Returns:

the MDN status indicator, or null if not set

See Also:

MailHeaderProperty.DISPOSITION

setDisposition

public void setDisposition(java.lang.String sDispostion)

Sets the Mail Delivery Notification (MDN) status indicator for the message.

Parameters:

sDisposition - the MDN status indicator

See Also:

MailHeaderProperty.DISPOSITION

getDisplayTo

public java.lang.String getDisplayTo()

getDisplayCC

public java.lang.String getDisplayCC()

Method description.

getDateSent

public java.util.Date getDateSent()

Gets the date the message was sent.

Returns:

the date message was sent, or null if not set

See Also:

MailHeaderProperty.DATE

setDateSent

public void setDateSent(java.util.Date sent)

Gets the date the message was sent.

Parameters:

sent - the date message was sent

See Also:

MailHeaderProperty.DATE

getModerator

public java.lang.String getModerator()

Gets the address of the moderator that approved and posted the message.

Returns:

the moderator's address, or null if not set

See Also:

MailHeaderProperty.APPROVED

setModerator

public void setModerator(java.lang.String sModerator)

Gets the address of the moderator that approved and posted the message.

Parameters:

sMoerator - the moderator's address

See Also:

MailHeaderProperty.APPROVED

getComment

public java.lang.String getComment()

Gets the comment for the message.

Overrides:

getComment in class AbstractItem

Returns:

the commment, or null if not set

See Also:

MailHeaderProperty.COMMENT

setComment

public void setComment(java.lang.String sComment)

Sets the comment for the message.

Overrides:

setComment in class AbstractItem

Parameters:

sComment - the commment

See Also:

MailHeaderProperty.COMMENT

getContentBase

public java.lang.String getContentBase()

Gets the base for relative Uniform Resource Identifiers (URIs) occurring in other header fields and in HTML documents that do not have any BASE element within the HTML markup.

Returns:

base for relative URIs, or null if not set

See Also:

MailHeaderProperty.CONTENT_BASE

setContentBase

public void setContentBase(java.lang.String sContentBase)

Sets the base for relative Uniform Resource Identifiers (URIs) occurring in other header fields and in HTML documents that do not have any BASE element within the HTML markup.

Parameters:

sConentBase - base for relative URIs

See Also:

MailHeaderProperty.CONTENT_BASE

getContentDescription

public java.lang.String getContentDescription()

Gets the optional description of the message body part.

Returns:

optional description, or null if not set

See Also:

MailHeaderProperty.CONTENT_DESCRIPTION

setContentDescription

public void setContentDescription(java.lang.String sContentDescription)

Sets the optional description of the message body part.

Parameters:

sContentDescription - optional description

See Also:

MailHeaderProperty.CONTENT_DESCRIPTION

getContentDisposition

public java.lang.String getContentDisposition()

Gets the intended disposition of the message body part.

Returns:

the intended disposition, or null if not set

See Also:

MailHeaderProperty.CONTENT_DISPOSITION

setContentDisposition

public void setContentDisposition(java.lang.String sContentDisposition)

Sets the intended disposition of the message body part.

Returns:

sContentDispostion the intended disposition

See Also:

MailHeaderProperty.CONTENT_DISPOSITION

getContentDispositionType

public java.lang.String getContentDispositionType()

Gets the type portion of the Content-Disposition Multipurpose Internet Mail Extensions (MIME) header for the message body part.

Returns:

the type portion of MIME header, or null if not set

See Also:

HttpMailProperty.CONTENT_DISPOSITION_TYPE

getContentId

public java.lang.String getContentId()

Gets the unique identifier for the message body part.

Returns:

unique identifier, or null if not set

See Also:

MailHeaderProperty.CONTENT_ID

setContentId

public void setContentId(java.lang.String sContentId)

Sets the unique identifier for the message body part.

Returns:

sContentID unique identifier

See Also:

MailHeaderProperty.CONTENT_ID

getContentLanguage

public java.lang.String getContentLanguage()

Gets the language identifier for the message body part text content.

Returns:

language identifier, or null if not set

See Also:

MailHeaderProperty.CONTENT_LANGUAGE

setContentLanguage

public void setContentLanguage(java.lang.String sContentLanguage)

Sets the language identifier for the message body part text content.

Returns:

sContentLanguage language identifier

See Also:

MailHeaderProperty.CONTENT_LANGUAGE

getContentLocation

public java.lang.String getContentLocation()

Gets the Uniform Resource Identifier (URI) that corresponds to the content of the message body part.

Returns:

the content URI, or null if not set

See Also:

MailHeaderProperty.CONTENT_LOCATION

setContentLocation

public void setContentLocation(java.net.URL contentLocation)

Sets the Uniform Resource Identifier (URI) that corresponds to the content of the message body part.

Parameters:

contentLocation - the content URI

See Also:

MailHeaderProperty.CONTENT_LOCATION

setContentLocation

public void setContentLocation(java.lang.String sContentLocation)

Sets the Uniform Resource Identifier (URI) that corresponds to the content of the message body part.

Parameters:

sContentLocation - the content URI

See Also:

MailHeaderProperty.CONTENT_LOCATION

getContentMediaType

public java.lang.String getContentMediaType()

Gets the content media type for the message body part.

Returns:

the content media type, or null if not set

See Also:

HttpMailProperty.CONTENT_MEDIA_TYPE

getContentTransferEncoding

public java.lang.String getContentTransferEncoding()

Gets the encoding mechanism used to encode the message body part content.

Returns:

the encoding mechanism, or null if not set

See Also:

MailHeaderProperty.CONTENT_TRANSFER_ENCODING

setContentTransferEncoding

public void setContentTransferEncoding(java.lang.String sContentTransferEncoding)

Sets the encoding mechanism used to encode the message body part content.

Returns:

sContentTransferEncoding the encoding mechanism

See Also:

MailHeaderProperty.CONTENT_TRANSFER_ENCODING

getContentType

public java.lang.String getContentType()

Gets the message body part content type.

Returns:

the body part content type, or null if not set

See Also:

MailHeaderProperty.CONTENT_TYPE

setContentType

public void setContentType(java.lang.String sContentType)

Sets the message body part content type.

Returns:

sContentType the body part content type

See Also:

MailHeaderProperty.CONTENT_TYPE

getMimeVersion

public java.lang.String getMimeVersion()

Gets the version of Multipurpose Internet Mail Extensions (MIME) used to format the message.

Returns:

the verison of MIME used, or null if not set

See Also:

MailHeaderProperty.MIME_VERSION

setMimeVersion

public void setMimeVersion(java.lang.String sMimeVersion)

Sets the version of Multipurpose Internet Mail Extensions (MIME) used to format the message.

Parameters:

sMimeVersion - the verison of MIME used

See Also:

MailHeaderProperty.MIME_VERSION

send

public com.compoze.util.webdav.WebdavResponse30 send()
                                              throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverSend()

Sends the message using the user's mailbox. A list of recipients, either in the to, cc, or bcc fields, must be set.

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeResponseException - if not sent successfully

ExchangeRuntimeException - if this object has been released and can no longer be used

serverSend

public void serverSend()
                throws ExchangeException

Requests the server to send the message using the user's mailbox. A list of recipients, either in the to, cc, or bcc fields, must be set.

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeResponseException - if not sent successfully

ExchangeRuntimeException - if this object has been released and can no longer be used

send

public com.compoze.util.webdav.WebdavResponse30 send(Mailbox mailbox)
                                              throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverSend(Mailbox)

Sends the message using a specified user mailbox. A list of recipients, either in the to, cc, or bcc fields, must be set.

Parameters:

mailbox - the mailbox to send the message from.

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeResponseException - if not sent successfully

ExchangeRuntimeException - if this object has been released and can no longer be used

serverSend

public void serverSend(Mailbox mailbox)
                throws ExchangeException

Requests the server to send the message using the specified user mailbox. A list of recipients, either in the to, cc, or bcc fields, must be set.

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeResponseException - if not sent successfully

ExchangeRuntimeException - if this object has been released and can no longer be used

send

public com.compoze.util.webdav.WebdavResponse30 send(java.lang.String sMailSubmissionURI)
                                              throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverSend(String)

Sends the message using the specified submission URI. A list of recipients, either in the to, cc, or bcc fields, must be set.

Parameters:

sMailSubmissionURI - the URI to submit the mail message to.

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeResponseException - if not sent successfully

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

Mailbox.getMailSubmissionURI()

serverSend

public void serverSend(java.lang.String sMailSubmissionURI)
                throws ExchangeException

Requests the server to send the message using the specified submission URI. A list of recipients, either in the to, cc, or bcc fields, must be set.

Parameters:

sMailSubmissionURI - the URI to submit the mail message to.

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeResponseException - if not sent successfully

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

Mailbox.getMailSubmissionURI()

forward

public Message forward()
                throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverForward()

Creates a message for forwarding.

Returns:

a message to forward

serverForward

public Message serverForward()
                      throws ExchangeException

Requests the server to create a message to forward.

Returns:

the message to forward

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

forward

public Message forward(Folder folder)
                throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverForward(Folder)

Creats a message for forwarding in the specfied folder.

Parameters:

folder - folder to create message in

Returns:

a message to forward

serverForward

public Message serverForward(Folder folder)
                      throws ExchangeException

Requests the server to create a message to forward.

Parameters:

folder - the folder to create the forward in

Returns:

the message to forward

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

reply

public Message reply()
              throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverReply()

Creates a message for replying.

Returns:

a message to reply

serverReply

public Message serverReply()
                    throws ExchangeException

Requests the server to create a message to reply with.

Parameters:

folder - the folder to create the reply in

bReplyAll - true reply to all

Returns:

the message to reply with

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

replyAll

public Message replyAll()
                 throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverReplyAll()

Creates a message for replying to all.

Returns:

a message to reply to all

serverReplyAll

public Message serverReplyAll()
                       throws ExchangeException

Requests the server to create a message to reply all with.

Parameters:

folder - the folder to create the reply all in

Returns:

the message to reply all with

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

reply

public Message reply(Folder folder,
                     boolean bReplyAll)
              throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverReply(Folder, boolean)

Creates a message for replying in the specified folder. Specifying the flag to reply to all (true) will create a message that will reply to all members in the From, To, Cc, and Bcc fields.

Parameters:

folder - folder to create message in

bReplyAll - true to reply to all: false otherwise

Returns:

a message to reply

serverReply

public Message serverReply(Folder folder,
                           boolean bReplyAll)
                    throws ExchangeException

Requests the server to create a message to reply with.

Parameters:

folder - the folder to create the reply in

bReplyAll - true reply to all

Returns:

the message to reply with

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

serverUpdate

public void serverUpdate(boolean bServerRefresh)
                  throws ExchangeException

Requests the server to update the message of any changed properties.

If the message does not exist in the Exchange store, it is created, else the existing mesage is updated.

An AttachmentException is thrown if any conflicts occur attaching (uploading) files to the message. The exception will state what files failed to attach. The message is still updated and can be sent, but will exclude the failed attachments.

Overrides:

serverUpdate in class AbstractMessage

Parameters:

bServerRefresh - true requests the server to refresh the properties

Throws:

AttachmentException - if any files failed to attached to this message.

ExchangeException - if a problem occurred while connecting to or interaction with Exchange Server

ExchangeRuntimeException - if this object has been released and can no longer be used

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates and returns a copy of this object. Attachments are not included in the returned copy.

Overrides:

clone in class AbstractMessage

Returns:

a clone of this instance.

Throws:

java.lang.CloneNotSupportedException - if the object's class does not support the Cloneable interface.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class AbstractMessage

Returns:

the string representation of the object.

getDefaultProperties

public static java.util.List getDefaultProperties()

Gets a list of default properties pertaining to a message.
Following is the list of properties returned:

• HttpMailProperty.IMPORTANCE

Returns:

a list (unmodifiable) of properties.

See Also:

AbstractItem.getDefaultProperties()

getProperties

public static java.util.List getProperties()

Gets a list of properties pertaining to a message.

Returns:

a list (unmodifiable) of properties.

See Also:

AbstractMessage.getProperties()