| java.lang.Object javax.mail.Message javax.mail.internet.MimeMessage
All known Subclasses: com.sun.mail.dsn.MessageHeaders, com.sun.mail.smtp.SMTPMessage, com.sun.mail.pop3.POP3Message, com.sun.mail.imap.IMAPMessage,
MimeMessage | public class MimeMessage extends Message implements MimePart(Code) | | This class represents a MIME style email message. It implements
the Message abstract class and the MimePart
interface.
Clients wanting to create new MIME style messages will instantiate
an empty MimeMessage object and then fill it with appropriate
attributes and content.
Service providers that implement MIME compliant backend stores may
want to subclass MimeMessage and override certain methods to provide
specific implementations. The simplest case is probably a provider
that generates a MIME style input stream and leaves the parsing of
the stream to this class.
MimeMessage uses the InternetHeaders class to parse and
store the top level RFC 822 headers of a message.
The mail.mime.address.strict session property controls
the parsing of address headers. By default, strict parsing of address
headers is done. If this property is set to "false" ,
strict parsing is not done and many illegal addresses that sometimes
occur in real messages are allowed. See the InternetAddress
class for details.
A note on RFC 822 and MIME headers
RFC 822 header fields must contain only
US-ASCII characters. MIME allows non ASCII characters to be present
in certain portions of certain headers, by encoding those characters.
RFC 2047 specifies the rules for doing this. The MimeUtility
class provided in this package can be used to to achieve this.
Callers of the setHeader , addHeader , and
addHeaderLine methods are responsible for enforcing
the MIME requirements for the specified headers. In addition, these
header fields must be folded (wrapped) before being sent if they
exceed the line length limitation for the transport (1000 bytes for
SMTP). Received headers may have been folded. The application is
responsible for folding and unfolding headers as appropriate.
author: John Mani author: Bill Shannon author: Max Spivak author: Kanwar Oberoi See Also: javax.mail.internet.MimeUtility See Also: javax.mail.Part See Also: javax.mail.Message See Also: javax.mail.internet.MimePart See Also: javax.mail.internet.InternetAddress |
Field Summary | |
Object | cachedContent If our content is a Multipart of Message object, we save it
the first time it's created by parsing a stream so that changes
to the contained objects will not be lost. | protected byte[] | content Byte array that holds the bytes of this Message's content. | protected InputStream | contentStream If the data for this message was supplied by an
InputStream that implements the SharedInputStream interface,
contentStream is another such stream representing
the content of this message. | protected DataHandler | dh The DataHandler object representing this Message's content. | protected Flags | flags The Flags for this message. | protected InternetHeaders | headers The InternetHeaders object that stores the header
of this message. | protected boolean | modified A flag indicating whether the message has been modified.
If the message has not been modified, any data in the
content array is assumed to be valid and is used
directly in the writeTo method. | protected boolean | saved Does the saveChanges method need to be called on
this message? This flag is set to false by the public constructor
and set to true by the saveChanges method. |
Constructor Summary | |
public | MimeMessage(Session session) Default constructor. | public | MimeMessage(Session session, InputStream is) Constructs a MimeMessage by reading and parsing the data from the
specified MIME InputStream. | public | MimeMessage(MimeMessage source) Constructs a new MimeMessage with content initialized from the
source MimeMessage. | protected | MimeMessage(Folder folder, int msgnum) Constructs an empty MimeMessage object with the given Folder
and message number. | protected | MimeMessage(Folder folder, InputStream is, int msgnum) Constructs a MimeMessage by reading and parsing the data from the
specified MIME InputStream. | protected | MimeMessage(Folder folder, InternetHeaders headers, byte[] content, int msgnum) Constructs a MimeMessage from the given InternetHeaders object
and content. |
Method Summary | |
public void | addFrom(Address[] addresses) Add the specified addresses to the existing "From" field. | public void | addHeader(String name, String value) Add this value to the existing values for this header_name. | public void | addHeaderLine(String line) Add a raw RFC 822 header-line. | public void | addRecipients(Message.RecipientType type, Address[] addresses) Add the given addresses to the specified recipient type. | public void | addRecipients(Message.RecipientType type, String addresses) Add the given addresses to the specified recipient type. | protected InternetHeaders | createInternetHeaders(InputStream is) Create and return an InternetHeaders object that loads the
headers from the given InputStream. | protected MimeMessage | createMimeMessage(Session session) Create and return a MimeMessage object. | public Enumeration | getAllHeaderLines() Get all header lines as an Enumeration of Strings. | public Enumeration | getAllHeaders() Return all the headers from this Message as an enumeration
of Header objects. | public Address[] | getAllRecipients() Get all the recipient addresses for the message. | public Object | getContent() Return the content as a Java object. | public String | getContentID() Returns the value of the "Content-ID" header field. | public String[] | getContentLanguage() Get the languages specified in the "Content-Language" header
field of this message. | public String | getContentMD5() Return the value of the "Content-MD5" header field. | protected InputStream | getContentStream() Produce the raw bytes of the content. | public String | getContentType() Returns the value of the RFC 822 "Content-Type" header field. | public synchronized DataHandler | getDataHandler() Return a DataHandler for this Message's content. | public String | getDescription() Returns the "Content-Description" header field of this Message.
This typically associates some descriptive information with
this part. | public String | getDisposition() Returns the value of the "Content-Disposition" header field.
This represents the disposition of this part. | public String | getEncoding() Returns the content transfer encoding from the
"Content-Transfer-Encoding" header
field. | public String | getFileName() Get the filename associated with this Message. | public synchronized Flags | getFlags() Return a Flags object containing the flags for
this message. | public Address[] | getFrom() Returns the value of the RFC 822 "From" header fields. | public String[] | getHeader(String name) Get all the headers for this header_name. | public String | getHeader(String name, String delimiter) Get all the headers for this header name, returned as a single
String, with headers separated by the delimiter. | public InputStream | getInputStream() Return a decoded input stream for this Message's "content". | public int | getLineCount() Return the number of lines for the content of this message.
Return -1 if this number cannot be determined. | public Enumeration | getMatchingHeaderLines(String[] names) Get matching header lines as an Enumeration of Strings. | public Enumeration | getMatchingHeaders(String[] names) Return matching headers from this Message as an Enumeration of
Header objects. | public String | getMessageID() Returns the value of the "Message-ID" header field. | public Enumeration | getNonMatchingHeaderLines(String[] names) Get non-matching header lines as an Enumeration of Strings. | public Enumeration | getNonMatchingHeaders(String[] names) Return non-matching headers from this Message as an
Enumeration of Header objects. | public InputStream | getRawInputStream() Return an InputStream to the raw data with any Content-Transfer-Encoding
intact. | public Date | getReceivedDate() Returns the Date on this message was received. | public Address[] | getRecipients(Message.RecipientType type) Returns the recepients specified by the type. | public Address[] | getReplyTo() Return the value of the RFC 822 "Reply-To" header field. | public Address | getSender() Returns the value of the RFC 822 "Sender" header field. | public Date | getSentDate() Returns the value of the RFC 822 "Date" field. | public int | getSize() Return the size of the content of this message in bytes. | public String | getSubject() Returns the value of the "Subject" header field. | public boolean | isMimeType(String mimeType) Is this Part of the specified MIME type? This method
compares only the primaryType and
subType .
The parameters of the content types are ignored. | public synchronized boolean | isSet(Flags.Flag flag) Check whether the flag specified in the flag
argument is set in this message. | protected void | parse(InputStream is) Parse the InputStream setting the headers and
content fields appropriately. | public void | removeHeader(String name) Remove all headers with this name. | public Message | reply(boolean replyToAll) Get a new Message suitable for a reply to this message.
The new Message will have its attributes and headers
set up appropriately. | public void | saveChanges() Updates the appropriate header fields of this message to be
consistent with the message's contents. | public void | setContent(Object o, String type) A convenience method for setting this Message's content. | public void | setContent(Multipart mp) This method sets the Message's content to a Multipart object. | public void | setContentID(String cid) Set the "Content-ID" header field of this Message. | public void | setContentLanguage(String[] languages) Set the "Content-Language" header of this MimePart. | public void | setContentMD5(String md5) Set the "Content-MD5" header field of this Message. | public synchronized void | setDataHandler(DataHandler dh) This method provides the mechanism to set this part's content. | public void | setDescription(String description) Set the "Content-Description" header field for this Message.
If the description parameter is null , then any
existing "Content-Description" fields are removed. | public void | setDescription(String description, String charset) Set the "Content-Description" header field for this Message.
If the description parameter is null , then any
existing "Content-Description" fields are removed. | public void | setDisposition(String disposition) Set the "Content-Disposition" header field of this Message. | public void | setFileName(String filename) Set the filename associated with this part, if possible. | public synchronized void | setFlags(Flags flag, boolean set) Set the flags for this message. | public void | setFrom(Address address) Set the RFC 822 "From" header field. | public void | setFrom() Set the RFC 822 "From" header field using the value of the
InternetAddress.getLocalAddress method. | public void | setHeader(String name, String value) Set the value for this header_name. | public void | setRecipients(Message.RecipientType type, Address[] addresses) Set the specified recipient type to the given addresses. | public void | setRecipients(Message.RecipientType type, String addresses) Set the specified recipient type to the given addresses. | public void | setReplyTo(Address[] addresses) Set the RFC 822 "Reply-To" header field. | public void | setSender(Address address) Set the RFC 822 "Sender" header field. | public void | setSentDate(Date d) Set the RFC 822 "Date" header field. | public void | setSubject(String subject) Set the "Subject" header field. | public void | setSubject(String subject, String charset) Set the "Subject" header field. | public void | setText(String text) Convenience method that sets the given String as this
part's content, with a MIME type of "text/plain". | public void | setText(String text, String charset) Convenience method that sets the given String as this part's
content, with a MIME type of "text/plain" and the specified
charset. | public void | setText(String text, String charset, String subtype) Convenience method that sets the given String as this part's
content, with a primary MIME type of "text" and the specified
MIME subtype. | protected void | updateHeaders() Called by the saveChanges method to actually
update the MIME headers. | protected void | updateMessageID() Update the Message-ID header. | public void | writeTo(OutputStream os) Output the message as an RFC 822 format stream. | public void | writeTo(OutputStream os, String[] ignoreList) Output the message as an RFC 822 format stream, without
specified headers. |
cachedContent | Object cachedContent(Code) | | If our content is a Multipart of Message object, we save it
the first time it's created by parsing a stream so that changes
to the contained objects will not be lost.
XXX - must have package access for MimeBodyPart.updateHeaders
|
content | protected byte[] content(Code) | | Byte array that holds the bytes of this Message's content.
|
contentStream | protected InputStream contentStream(Code) | | If the data for this message was supplied by an
InputStream that implements the SharedInputStream interface,
contentStream is another such stream representing
the content of this message. In this case, content
will be null.
since: JavaMail 1.2 |
dh | protected DataHandler dh(Code) | | The DataHandler object representing this Message's content.
|
flags | protected Flags flags(Code) | | The Flags for this message.
|
headers | protected InternetHeaders headers(Code) | | The InternetHeaders object that stores the header
of this message.
|
modified | protected boolean modified(Code) | | A flag indicating whether the message has been modified.
If the message has not been modified, any data in the
content array is assumed to be valid and is used
directly in the writeTo method. This flag is
set to true when an empty message is created or when the
saveChanges method is called.
since: JavaMail 1.2 |
saved | protected boolean saved(Code) | | Does the saveChanges method need to be called on
this message? This flag is set to false by the public constructor
and set to true by the saveChanges method. The
writeTo method checks this flag and calls the
saveChanges method as necessary. This avoids the
common mistake of forgetting to call the saveChanges
method on a newly constructed message.
since: JavaMail 1.2 |
MimeMessage | public MimeMessage(Session session)(Code) | | Default constructor. An empty message object is created.
The headers field is set to an empty InternetHeaders
object. The flags field is set to an empty Flags
object. The modified flag is set to true.
|
MimeMessage | public MimeMessage(Session session, InputStream is) throws MessagingException(Code) | | Constructs a MimeMessage by reading and parsing the data from the
specified MIME InputStream. The InputStream will be left positioned
at the end of the data for the message. Note that the input stream
parse is done within this constructor itself.
The input stream contains an entire MIME formatted message with
headers and data.
Parameters: session - Session object for this message Parameters: is - the message input stream exception: MessagingException - |
MimeMessage | public MimeMessage(MimeMessage source) throws MessagingException(Code) | | Constructs a new MimeMessage with content initialized from the
source MimeMessage. The new message is independent
of the original.
Note: The current implementation is rather inefficient, copying
the data more times than strictly necessary.
Parameters: source - the message to copy content from exception: MessagingException - since: JavaMail 1.2 |
MimeMessage | protected MimeMessage(Folder folder, int msgnum)(Code) | | Constructs an empty MimeMessage object with the given Folder
and message number.
This method is for providers subclassing MimeMessage .
|
MimeMessage | protected MimeMessage(Folder folder, InputStream is, int msgnum) throws MessagingException(Code) | | Constructs a MimeMessage by reading and parsing the data from the
specified MIME InputStream. The InputStream will be left positioned
at the end of the data for the message. Note that the input stream
parse is done within this constructor itself.
This method is for providers subclassing MimeMessage .
Parameters: folder - The containing folder. Parameters: is - the message input stream Parameters: msgnum - Message number of this message within its folder exception: MessagingException - |
MimeMessage | protected MimeMessage(Folder folder, InternetHeaders headers, byte[] content, int msgnum) throws MessagingException(Code) | | Constructs a MimeMessage from the given InternetHeaders object
and content.
This method is for providers subclassing MimeMessage .
Parameters: folder - The containing folder. Parameters: headers - The headers Parameters: content - The message content Parameters: msgnum - Message number of this message within its folder exception: MessagingException - |
addFrom | public void addFrom(Address[] addresses) throws MessagingException(Code) | | Add the specified addresses to the existing "From" field. If
the "From" field does not already exist, it is created.
Parameters: addresses - the senders of this message exception: IllegalWriteException - if the underlyingimplementation does not support modificationof existing values exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - |
createInternetHeaders | protected InternetHeaders createInternetHeaders(InputStream is) throws MessagingException(Code) | | Create and return an InternetHeaders object that loads the
headers from the given InputStream. Subclasses can override
this method to return a subclass of InternetHeaders, if
necessary. This implementation simply constructs and returns
an InternetHeaders object.
Parameters: is - the InputStream to read the headers from exception: MessagingException - since: JavaMail 1.2 |
createMimeMessage | protected MimeMessage createMimeMessage(Session session) throws MessagingException(Code) | | Create and return a MimeMessage object. The reply method
uses this method to create the MimeMessage object that it
will return. Subclasses can override this method to return
a subclass of MimeMessage. This implementation simply constructs
and returns a MimeMessage object using the supplied Session.
Parameters: session - the Session to use for the new message the new MimeMessage object since: JavaMail 1.4 |
getAllHeaders | public Enumeration getAllHeaders() throws MessagingException(Code) | | Return all the headers from this Message as an enumeration
of Header objects.
Note that certain headers may be encoded as per RFC 2047
if they contain non US-ASCII characters and these should
be decoded.
This implementation obtains the headers from the
headers InternetHeaders object.
array of header objects exception: MessagingException - See Also: javax.mail.internet.MimeUtility |
getAllRecipients | public Address[] getAllRecipients() throws MessagingException(Code) | | Get all the recipient addresses for the message.
Extracts the TO, CC, BCC, and NEWSGROUPS recipients.
array of Address objects exception: MessagingException - See Also: javax.mail.Message.RecipientType.TO See Also: javax.mail.Message.RecipientType.CC See Also: javax.mail.Message.RecipientType.BCC See Also: javax.mail.internet.MimeMessage.RecipientType.NEWSGROUPS |
getContent | public Object getContent() throws IOException, MessagingException(Code) | | Return the content as a Java object. The type of this
object is dependent on the content itself. For
example, the native format of a "text/plain" content
is usually a String object. The native format for a "multipart"
message is always a Multipart subclass. For content types that are
unknown to the DataHandler system, an input stream is returned
as the content.
This implementation obtains the content from the DataHandler,
that is, it invokes getDataHandler().getContent() .
If the content is a Multipart or Message object and was created by
parsing a stream, the object is cached and returned in subsequent
calls so that modifications to the content will not be lost.
Object See Also: javax.mail.Part See Also: javax.activation.DataHandler.getContent exception: MessagingException - exception: IOException - this is typically thrown by theDataHandler. Refer to the documentation forjavax.activation.DataHandler for more details. |
getContentID | public String getContentID() throws MessagingException(Code) | | Returns the value of the "Content-ID" header field. Returns
null if the field is unavailable or its value is
absent.
This implementation uses the getHeader method
to obtain the requisite header field.
content-ID exception: MessagingException - |
getContentLanguage | public String[] getContentLanguage() throws MessagingException(Code) | | Get the languages specified in the "Content-Language" header
field of this message. The Content-Language header is defined by
RFC 1766. Returns null if this field is unavailable
or its value is absent.
This implementation uses the getHeader method
to obtain the requisite header field.
value of content-language header. exception: MessagingException - |
getContentMD5 | public String getContentMD5() throws MessagingException(Code) | | Return the value of the "Content-MD5" header field. Returns
null if this field is unavailable or its value
is absent.
This implementation uses the getHeader method
to obtain the requisite header field.
content-MD5 exception: MessagingException - |
getContentStream | protected InputStream getContentStream() throws MessagingException(Code) | | Produce the raw bytes of the content. This method is used during
parsing, to create a DataHandler object for the content. Subclasses
that can provide a separate input stream for just the message
content might want to override this method.
This implementation returns a SharedInputStream, if
contentStream is not null. Otherwise, it
returns a ByteArrayInputStream constructed
out of the content byte array.
See Also: MimeMessage.content |
getContentType | public String getContentType() throws MessagingException(Code) | | Returns the value of the RFC 822 "Content-Type" header field.
This represents the content-type of the content of this
message. This value must not be null. If this field is
unavailable, "text/plain" should be returned.
This implementation uses the getHeader method
to obtain the requisite header field.
The ContentType of this part exception: MessagingException - See Also: javax.activation.DataHandler |
getDataHandler | public synchronized DataHandler getDataHandler() throws MessagingException(Code) | | Return a DataHandler for this Message's content.
The implementation provided here works as follows. Note the use of
the getContentStream method to
generate the byte stream for the content. Also note that
any transfer-decoding is done automatically within this method.
getDataHandler() {
if (dh == null) {
dh = new DataHandler(new MimePartDataSource(this));
}
return dh;
}
class MimePartDataSource implements DataSource {
public getInputStream() {
return MimeUtility.decode(
getContentStream(), getEncoding());
}
....
}
exception: MessagingException - |
getDescription | public String getDescription() throws MessagingException(Code) | | Returns the "Content-Description" header field of this Message.
This typically associates some descriptive information with
this part. Returns null if this field is unavailable or its
value is absent.
If the Content-Description field is encoded as per RFC 2047,
it is decoded and converted into Unicode. If the decoding or
conversion fails, the raw data is returned as-is
This implementation uses the getHeader method
to obtain the requisite header field.
content-description exception: MessagingException - |
getDisposition | public String getDisposition() throws MessagingException(Code) | | Returns the value of the "Content-Disposition" header field.
This represents the disposition of this part. The disposition
describes how the part should be presented to the user.
If the Content-Disposition field is unavailable,
null is returned.
This implementation uses the getHeader method
to obtain the requisite header field.
disposition of this part, or null if unknown exception: MessagingException - |
getEncoding | public String getEncoding() throws MessagingException(Code) | | Returns the content transfer encoding from the
"Content-Transfer-Encoding" header
field. Returns null if the header is unavailable
or its value is absent.
This implementation uses the getHeader method
to obtain the requisite header field.
content-transfer-encoding exception: MessagingException - |
getFileName | public String getFileName() throws MessagingException(Code) | | Get the filename associated with this Message.
Returns the value of the "filename" parameter from the
"Content-Disposition" header field of this message. If it's
not available, returns the value of the "name" parameter from
the "Content-Type" header field of this BodyPart.
Returns null if both are absent.
If the mail.mime.encodefilename System property
is set to true, the
MimeUtility.decodeTextMimeUtility.decodeText method will be used to decode the
filename. While such encoding is not supported by the MIME
spec, many mailers use this technique to support non-ASCII
characters in filenames. The default value of this property
is false.
filename exception: MessagingException - |
getFlags | public synchronized Flags getFlags() throws MessagingException(Code) | | Return a Flags object containing the flags for
this message.
Note that a clone of the internal Flags object is returned, so
modifying the returned Flags object will not affect the flags
of this message.
Flags object containing the flags for this message exception: MessagingException - See Also: javax.mail.Flags |
getFrom | public Address[] getFrom() throws MessagingException(Code) | | Returns the value of the RFC 822 "From" header fields. If this
header field is absent, the "Sender" header field is used.
If the "Sender" header field is also absent, null
is returned.
This implementation uses the getHeader method
to obtain the requisite header field.
Address object exception: MessagingException - See Also: MimeMessage.headers |
getHeader | public String[] getHeader(String name) throws MessagingException(Code) | | Get all the headers for this header_name. Note that certain
headers may be encoded as per RFC 2047 if they contain
non US-ASCII characters and these should be decoded.
This implementation obtains the headers from the
headers InternetHeaders object.
Parameters: name - name of header array of headers exception: MessagingException - See Also: javax.mail.internet.MimeUtility |
getHeader | public String getHeader(String name, String delimiter) throws MessagingException(Code) | | Get all the headers for this header name, returned as a single
String, with headers separated by the delimiter. If the
delimiter is null , only the first header is
returned.
Parameters: name - the name of this header Parameters: delimiter - separator between values the value fields for all headers with this name exception: MessagingException - |
getLineCount | public int getLineCount() throws MessagingException(Code) | | Return the number of lines for the content of this message.
Return -1 if this number cannot be determined.
Note that this number may not be an exact measure of the
content length and may or may not account for any transfer
encoding of the content.
This implementation returns -1.
number of lines in the content. exception: MessagingException - |
getMatchingHeaders | public Enumeration getMatchingHeaders(String[] names) throws MessagingException(Code) | | Return matching headers from this Message as an Enumeration of
Header objects. This implementation obtains the headers from
the headers InternetHeaders object.
exception: MessagingException - |
getMessageID | public String getMessageID() throws MessagingException(Code) | | Returns the value of the "Message-ID" header field. Returns
null if this field is unavailable or its value is absent.
The default implementation provided here uses the
getHeader method to return the value of the
"Message-ID" field.
Message-ID exception: MessagingException - if the retrieval of this fieldcauses any exception. See Also: javax.mail.search.MessageIDTerm since: JavaMail 1.1 |
getNonMatchingHeaderLines | public Enumeration getNonMatchingHeaderLines(String[] names) throws MessagingException(Code) | | Get non-matching header lines as an Enumeration of Strings.
A Header line is a raw RFC 822 header-line, containing both
the "name" and "value" field.
exception: MessagingException - |
getNonMatchingHeaders | public Enumeration getNonMatchingHeaders(String[] names) throws MessagingException(Code) | | Return non-matching headers from this Message as an
Enumeration of Header objects. This implementation
obtains the header from the headers InternetHeaders object.
exception: MessagingException - |
getRawInputStream | public InputStream getRawInputStream() throws MessagingException(Code) | | Return an InputStream to the raw data with any Content-Transfer-Encoding
intact. This method is useful if the "Content-Transfer-Encoding"
header is incorrect or corrupt, which would prevent the
getInputStream method or getContent method
from returning the correct data. In such a case the application may
use this method and attempt to decode the raw data itself.
This implementation simply calls the getContentStream
method.
See Also: MimeMessage.getInputStream See Also: MimeMessage.getContentStream since: JavaMail 1.2 |
getReceivedDate | public Date getReceivedDate() throws MessagingException(Code) | | Returns the Date on this message was received. Returns
null if this date cannot be obtained.
Note that RFC 822 does not define a field for the received
date. Hence only implementations that can provide this date
need return a valid value.
This implementation returns null .
the date this message was received exception: MessagingException - |
getRecipients | public Address[] getRecipients(Message.RecipientType type) throws MessagingException(Code) | | Returns the recepients specified by the type. The mapping
between the type and the corresponding RFC 822 header is
as follows:
Message.RecipientType.TO "To"
Message.RecipientType.CC "Cc"
Message.RecipientType.BCC "Bcc"
MimeMessage.RecipientType.NEWSGROUPS "Newsgroups"
Returns null if the header specified by the type is not found
or if its value is empty.
This implementation uses the getHeader method
to obtain the requisite header field.
Parameters: type - Type of recepient array of Address objects exception: MessagingException - if header could notbe retrieved exception: AddressException - if the header is misformatted See Also: MimeMessage.headers See Also: javax.mail.Message.RecipientType.TO See Also: javax.mail.Message.RecipientType.CC See Also: javax.mail.Message.RecipientType.BCC See Also: javax.mail.internet.MimeMessage.RecipientType.NEWSGROUPS |
getReplyTo | public Address[] getReplyTo() throws MessagingException(Code) | | Return the value of the RFC 822 "Reply-To" header field. If
this header is unavailable or its value is absent, then
the getFrom method is called and its value is returned.
This implementation uses the getHeader method
to obtain the requisite header field.
exception: MessagingException - See Also: MimeMessage.headers |
getSender | public Address getSender() throws MessagingException(Code) | | Returns the value of the RFC 822 "Sender" header field.
If the "Sender" header field is absent, null
is returned.
This implementation uses the getHeader method
to obtain the requisite header field.
Address object exception: MessagingException - See Also: MimeMessage.headers since: JavaMail 1.3 |
getSentDate | public Date getSentDate() throws MessagingException(Code) | | Returns the value of the RFC 822 "Date" field. This is the date
on which this message was sent. Returns null if this field is
unavailable or its value is absent.
This implementation uses the getHeader method
to obtain the requisite header field.
The sent Date exception: MessagingException - |
getSize | public int getSize() throws MessagingException(Code) | | Return the size of the content of this message in bytes.
Return -1 if the size cannot be determined.
Note that this number may not be an exact measure of the
content size and may or may not account for any transfer
encoding of the content.
This implementation returns the size of the content
array (if not null), or, if contentStream is not
null, and the available method returns a positive
number, it returns that number as the size. Otherwise, it returns
-1.
size of content in bytes exception: MessagingException - |
getSubject | public String getSubject() throws MessagingException(Code) | | Returns the value of the "Subject" header field. Returns null
if the subject field is unavailable or its value is absent.
If the subject is encoded as per RFC 2047, it is decoded and
converted into Unicode. If the decoding or conversion fails, the
raw data is returned as is.
This implementation uses the getHeader method
to obtain the requisite header field.
Subject exception: MessagingException - See Also: MimeMessage.headers |
isMimeType | public boolean isMimeType(String mimeType) throws MessagingException(Code) | | Is this Part of the specified MIME type? This method
compares only the primaryType and
subType .
The parameters of the content types are ignored.
For example, this method will return true when
comparing a Part of content type "text/plain"
with "text/plain; charset=foobar".
If the subType of mimeType is the
special character '*', then the subtype is ignored during the
comparison.
|
isSet | public synchronized boolean isSet(Flags.Flag flag) throws MessagingException(Code) | | Check whether the flag specified in the flag
argument is set in this message.
This implementation checks this message's internal
flags object.
Parameters: flag - the flag value of the specified flag for this message See Also: javax.mail.Flags.Flag See Also: javax.mail.Flags.Flag.ANSWERED See Also: javax.mail.Flags.Flag.DELETED See Also: javax.mail.Flags.Flag.DRAFT See Also: javax.mail.Flags.Flag.FLAGGED See Also: javax.mail.Flags.Flag.RECENT See Also: javax.mail.Flags.Flag.SEEN exception: MessagingException - |
parse | protected void parse(InputStream is) throws MessagingException(Code) | | Parse the InputStream setting the headers and
content fields appropriately. Also resets the
modified flag.
This method is intended for use by subclasses that need to
control when the InputStream is parsed.
Parameters: is - The message input stream exception: MessagingException - |
reply | public Message reply(boolean replyToAll) throws MessagingException(Code) | | Get a new Message suitable for a reply to this message.
The new Message will have its attributes and headers
set up appropriately. Note that this new message object
will be empty, i.e., it will not have a "content".
These will have to be suitably filled in by the client.
If replyToAll is set, the new Message will be addressed
to all recipients of this message. Otherwise, the reply will be
addressed to only the sender of this message (using the value
of the getReplyTo method).
The "Subject" field is filled in with the original subject
prefixed with "Re:" (unless it already starts with "Re:").
The "In-Reply-To" header is set in the new message if this
message has a "Message-Id" header. The ANSWERED
flag is set in this message.
The current implementation also sets the "References" header
in the new message to include the contents of the "References"
header (or, if missing, the "In-Reply-To" header) in this message,
plus the contents of the "Message-Id" header of this message,
as described in RFC 2822.
Parameters: replyToAll - reply should be sent to all recipientsof this message the reply Message exception: MessagingException - |
saveChanges | public void saveChanges() throws MessagingException(Code) | | Updates the appropriate header fields of this message to be
consistent with the message's contents. If this message is
contained in a Folder, any changes made to this message are
committed to the containing folder.
If any part of a message's headers or contents are changed,
saveChanges must be called to ensure that those
changes are permanent. Otherwise, any such modifications may or
may not be saved, depending on the folder implementation.
Messages obtained from folders opened READ_ONLY should not be
modified and saveChanges should not be called on such messages.
This method sets the modified flag to true, the
save flag to true, and then calls the
updateHeaders method.
exception: IllegalWriteException - if the underlyingimplementation does not support modification exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - |
setContent | public void setContent(Object o, String type) throws MessagingException(Code) | | A convenience method for setting this Message's content.
The content is wrapped in a DataHandler object. Note that a
DataContentHandler class for the specified type should be
available to the JavaMail implementation for this to work right.
i.e., to do setContent(foobar, "application/x-foobar") ,
a DataContentHandler for "application/x-foobar" should be installed.
Refer to the Java Activation Framework for more information.
Parameters: o - the content object Parameters: type - Mime type of the object exception: IllegalWriteException - if the underlyingimplementation does not support modification ofexisting values exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - |
setContentLanguage | public void setContentLanguage(String[] languages) throws MessagingException(Code) | | Set the "Content-Language" header of this MimePart. The
Content-Language header is defined by RFC 1766.
Parameters: languages - array of language tags exception: IllegalWriteException - if the underlyingimplementation does not support modification exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - |
setDataHandler | public synchronized void setDataHandler(DataHandler dh) throws MessagingException(Code) | | This method provides the mechanism to set this part's content.
The given DataHandler object should wrap the actual content.
Parameters: dh - The DataHandler for the content. exception: IllegalWriteException - if the underlyingimplementation does not support modification exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - |
setDescription | public void setDescription(String description) throws MessagingException(Code) | | Set the "Content-Description" header field for this Message.
If the description parameter is null , then any
existing "Content-Description" fields are removed.
If the description contains non US-ASCII characters, it will
be encoded using the platform's default charset. If the
description contains only US-ASCII characters, no encoding
is done and it is used as-is.
Note that if the charset encoding process fails, a
MessagingException is thrown, and an UnsupportedEncodingException
is included in the chain of nested exceptions within the
MessagingException.
Parameters: description - content-description exception: IllegalWriteException - if the underlyingimplementation does not support modification exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException.An - UnsupportedEncodingException may be includedin the exception chain if the charsetconversion fails. |
setDescription | public void setDescription(String description, String charset) throws MessagingException(Code) | | Set the "Content-Description" header field for this Message.
If the description parameter is null , then any
existing "Content-Description" fields are removed.
If the description contains non US-ASCII characters, it will
be encoded using the specified charset. If the description
contains only US-ASCII characters, no encoding is done and
it is used as-is.
Note that if the charset encoding process fails, a
MessagingException is thrown, and an UnsupportedEncodingException
is included in the chain of nested exceptions within the
MessagingException.
Parameters: description - Description Parameters: charset - Charset for encoding exception: IllegalWriteException - if the underlyingimplementation does not support modification exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException.An - UnsupportedEncodingException may be includedin the exception chain if the charsetconversion fails. |
setDisposition | public void setDisposition(String disposition) throws MessagingException(Code) | | Set the "Content-Disposition" header field of this Message.
If disposition is null, any existing "Content-Disposition"
header field is removed.
exception: IllegalWriteException - if the underlyingimplementation does not support modification exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - |
setFileName | public void setFileName(String filename) throws MessagingException(Code) | | Set the filename associated with this part, if possible.
Sets the "filename" parameter of the "Content-Disposition"
header field of this message.
If the mail.mime.encodefilename System property
is set to true, the
MimeUtility.encodeTextMimeUtility.encodeText method will be used to encode the
filename. While such encoding is not supported by the MIME
spec, many mailers use this technique to support non-ASCII
characters in filenames. The default value of this property
is false.
exception: IllegalWriteException - if the underlyingimplementation does not support modification exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - |
setFrom | public void setFrom(Address address) throws MessagingException(Code) | | Set the RFC 822 "From" header field. Any existing values are
replaced with the given address. If address is null ,
this header is removed.
Parameters: address - the sender of this message exception: IllegalWriteException - if the underlyingimplementation does not support modificationof existing values exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - |
setHeader | public void setHeader(String name, String value) throws MessagingException(Code) | | Set the value for this header_name. Replaces all existing
header values with this new value. Note that RFC 822 headers
must contain only US-ASCII characters, so a header that
contains non US-ASCII characters must have been encoded by the
caller as per the rules of RFC 2047.
Parameters: name - header name Parameters: value - header value See Also: javax.mail.internet.MimeUtility exception: IllegalWriteException - if the underlyingimplementation does not support modification exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - |
setSender | public void setSender(Address address) throws MessagingException(Code) | | Set the RFC 822 "Sender" header field. Any existing values are
replaced with the given address. If address is null ,
this header is removed.
Parameters: address - the sender of this message exception: IllegalWriteException - if the underlyingimplementation does not support modificationof existing values exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - since: JavaMail 1.3 |
setSentDate | public void setSentDate(Date d) throws MessagingException(Code) | | Set the RFC 822 "Date" header field. This is the date on which the
creator of the message indicates that the message is complete
and ready for delivery. If the date parameter is
null , the existing "Date" field is removed.
exception: IllegalWriteException - if the underlyingimplementation does not support modification exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - |
setSubject | public void setSubject(String subject) throws MessagingException(Code) | | Set the "Subject" header field. If the subject contains
non US-ASCII characters, it will be encoded using the
platform's default charset. If the subject contains only
US-ASCII characters, no encoding is done and it is used
as-is. If the subject is null, the existing "Subject" field
is removed.
The application must ensure that the subject does not contain
any line breaks.
Note that if the charset encoding process fails, a
MessagingException is thrown, and an UnsupportedEncodingException
is included in the chain of nested exceptions within the
MessagingException.
Parameters: subject - The subject exception: IllegalWriteException - if the underlyingimplementation does not support modificationof existing values exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException.An - UnsupportedEncodingException may be includedin the exception chain if the charsetconversion fails. |
setSubject | public void setSubject(String subject, String charset) throws MessagingException(Code) | | Set the "Subject" header field. If the subject contains non
US-ASCII characters, it will be encoded using the specified
charset. If the subject contains only US-ASCII characters, no
encoding is done and it is used as-is. If the subject is null,
the existing "Subject" header field is removed.
The application must ensure that the subject does not contain
any line breaks.
Note that if the charset encoding process fails, a
MessagingException is thrown, and an UnsupportedEncodingException
is included in the chain of nested exceptions within the
MessagingException.
Parameters: subject - The subject Parameters: charset - The charset exception: IllegalWriteException - if the underlyingimplementation does not support modificationof existing values exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException.An - UnsupportedEncodingException may be includedin the exception chain if the charsetconversion fails. |
setText | public void setText(String text) throws MessagingException(Code) | | Convenience method that sets the given String as this
part's content, with a MIME type of "text/plain". If the
string contains non US-ASCII characters. it will be encoded
using the platform's default charset. The charset is also
used to set the "charset" parameter.
Note that there may be a performance penalty if
text is large, since this method may have
to scan all the characters to determine what charset to
use.
If the charset is already known, use the
setText method that takes the charset parameter.
Parameters: text - the text content to set exception: MessagingException - if an error occurs See Also: MimeMessage.setText(String text,String charset) |
setText | public void setText(String text, String charset) throws MessagingException(Code) | | Convenience method that sets the given String as this part's
content, with a MIME type of "text/plain" and the specified
charset. The given Unicode string will be charset-encoded
using the specified charset. The charset is also used to set
the "charset" parameter.
Parameters: text - the text content to set Parameters: charset - the charset to use for the text exception: MessagingException - if an error occurs |
setText | public void setText(String text, String charset, String subtype) throws MessagingException(Code) | | Convenience method that sets the given String as this part's
content, with a primary MIME type of "text" and the specified
MIME subtype. The given Unicode string will be charset-encoded
using the specified charset. The charset is also used to set
the "charset" parameter.
Parameters: text - the text content to set Parameters: charset - the charset to use for the text Parameters: subtype - the MIME subtype to use (e.g., "html") exception: MessagingException - if an error occurs since: JavaMail 1.4 |
updateHeaders | protected void updateHeaders() throws MessagingException(Code) | | Called by the saveChanges method to actually
update the MIME headers. The implementation here sets the
Content-Transfer-Encoding header (if needed
and not already set), the MIME-Version header
and the Message-ID header. Also, if the content
of this message is a MimeMultipart , it's
updateHeaders method is called.
exception: IllegalWriteException - if the underlyingimplementation does not support modification exception: IllegalStateException - if this message isobtained from a READ_ONLY folder. exception: MessagingException - |
updateMessageID | protected void updateMessageID() throws MessagingException(Code) | | Update the Message-ID header. This method is called
by the updateHeaders and allows a subclass
to override only the algorithm for choosing a Message-ID.
since: JavaMail 1.4 |
writeTo | public void writeTo(OutputStream os) throws IOException, MessagingException(Code) | | Output the message as an RFC 822 format stream.
Note that, depending on how the messag was constructed, it may
use a variety of line termination conventions. Generally the
output should be sent through an appropriate FilterOutputStream
that converts the line terminators to the desired form, either
CRLF for MIME compatibility and for use in Internet protocols,
or the local platform's line terminator for storage in a local
text file.
This implementation calls the writeTo(OutputStream,
String[]) method with a null ignore list.
exception: IOException - if an error occurs writing to the streamor if an error is generated by thejavax.activation layer. exception: MessagingException - See Also: javax.activation.DataHandler.writeTo |
|
|