org.nhindirect.stagent.mail
Class Message

java.lang.Object
  javax.mail.Message
      javax.mail.internet.MimeMessage
          org.nhindirect.stagent.mail.Message

All Implemented Interfaces:

javax.mail.internet.MimePart, javax.mail.Part

Direct Known Subclasses:

NotificationMessage

public class Message
extends javax.mail.internet.MimeMessage

Extension to Java MimeMessage with utility methods.

Author:

Greg Meyer, Umesh Madan

Nested Class Summary

Nested classes/interfaces inherited from class javax.mail.internet.MimeMessage

javax.mail.internet.MimeMessage.RecipientType

Field Summary

Fields inherited from interface javax.mail.Part

ATTACHMENT, INLINE

Constructor Summary

Message(java.io.InputStream inStream)
Constructs a message from input stream containing the entire message.

Message(javax.mail.internet.InternetHeaders headers, byte[] content)
Constructs a message with the provided headers and message body.

Message(javax.mail.internet.MimeMessage message)
Constructs a message from an existing MimeMessage.

Method Summary

MimeEntity	extractEntityForSignature(boolean includeEpilogue) Creates a MimeEntity object from this message that will be used for creating a message signature.
MimeEntity	extractMimeEntity() Gets a copy of this message without any non-mime headers.
java.lang.String	getBCCHeader() Gets the raw bcc header.
java.lang.String	getCCHeader() Gets the raw cc header.
byte[]	getContentAsBytes() Gets the content (body) of the message as a byte array.
java.lang.String	getDateHeader() Gets the raw date header.
java.lang.String	getFromHeader() Gets the raw from header.
java.lang.String	getIDHeader() Gets the raw message id header.
java.lang.String	getSubjectHeader() Gets the raw subject header.
java.lang.String	getToHeader() Gets the raw to header.
java.lang.String	toString()

Methods inherited from class javax.mail.internet.MimeMessage

addFrom, addHeader, addHeaderLine, addRecipients, addRecipients, getAllHeaderLines, getAllHeaders, getAllRecipients, getContent, getContentID, getContentLanguage, getContentMD5, getContentType, getDataHandler, getDescription, getDisposition, getEncoding, getFileName, getFlags, getFrom, getHeader, getHeader, getInputStream, getLineCount, getMatchingHeaderLines, getMatchingHeaders, getMessageID, getNonMatchingHeaderLines, getNonMatchingHeaders, getRawInputStream, getReceivedDate, getRecipients, getReplyTo, getSender, getSentDate, getSize, getSubject, isMimeType, isSet, removeHeader, reply, saveChanges, setContent, setContent, setContentID, setContentLanguage, setContentMD5, setDataHandler, setDescription, setDescription, setDisposition, setFileName, setFlags, setFrom, setFrom, setHeader, setRecipients, setRecipients, setReplyTo, setSender, setSentDate, setSubject, setSubject, setText, setText, setText, writeTo, writeTo

Methods inherited from class javax.mail.Message

addRecipient, getFolder, getMessageNumber, isExpunged, match, setFlag, setRecipient

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message(javax.mail.internet.InternetHeaders headers,
               byte[] content)
        throws javax.mail.MessagingException

Constructs a message with the provided headers and message body.

Parameters:

headers - Collection of headers to apply to the message.

content - The message's body.

Throws:

javax.mail.MessagingException

Message

public Message(javax.mail.internet.MimeMessage message)
        throws javax.mail.MessagingException

Constructs a message from an existing MimeMessage.

Parameters:

message - The message that will make up the header and body of this message.

Throws:

javax.mail.MessagingException

Message

public Message(java.io.InputStream inStream)
        throws javax.mail.MessagingException

Constructs a message from input stream containing the entire message.

Parameters:

inStream - An input stream containing the entire content (headers and content) of the message.

Throws:

javax.mail.MessagingException

Method Detail

getToHeader

public java.lang.String getToHeader()

Gets the raw to header.

Returns:

The raw to header of the message.

getCCHeader

public java.lang.String getCCHeader()

Gets the raw cc header.

Returns:

The raw cc header of the message.

getBCCHeader

public java.lang.String getBCCHeader()

Gets the raw bcc header.

Returns:

The raw bcc header of the message.

getFromHeader

public java.lang.String getFromHeader()

Gets the raw from header.

Returns:

The raw from header of the message.

getSubjectHeader

public java.lang.String getSubjectHeader()

Gets the raw subject header.

Returns:

The raw subject header of the message.

getIDHeader

public java.lang.String getIDHeader()

Gets the raw message id header.

Returns:

The raw message id header of the message.

getDateHeader

public java.lang.String getDateHeader()

Gets the raw date header.

Returns:

The raw date header of the message.

extractMimeEntity

public MimeEntity extractMimeEntity()

Gets a copy of this message without any non-mime headers.

extractEntityForSignature

public MimeEntity extractEntityForSignature(boolean includeEpilogue)

Creates a MimeEntity object from this message that will be used for creating a message signature.

Parameters:

includeEpilogue - Indicates if the message's epilogue part (if one exists) should be used in generating the message signature digest.

Returns:

MimeEntity object that will be used for creating a message signature.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getContentAsBytes

public byte[] getContentAsBytes()

Gets the content (body) of the message as a byte array.

Returns:

The content (body) of the message as a byte array.