|
||||||||||
| 上一个类 下一个类 | 框架 无框架 | |||||||||
| 摘要: 嵌套 | 字段 | 构造方法 | 方法 | 详细信息: 字段 | 构造方法 | 方法 | |||||||||
java.lang.Objectjavax.mail.Message
javax.mail.internet.MimeMessage
public class MimeMessage
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.
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.
MimeUtility,
Part,
Message,
MimePart,
InternetAddress| 嵌套类摘要 | |
|---|---|
static class |
MimeMessage.RecipientType
This inner class extends the javax.mail.Message.RecipientType class to add additional RecipientTypes. |
| 字段摘要 | |
|---|---|
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. |
protected boolean |
saved
Does the saveChanges method need to be called on
this message? |
| 从类 javax.mail.Message 继承的字段 |
|---|
expunged, folder, msgnum, session |
| 从接口 javax.mail.Part 继承的字段 |
|---|
ATTACHMENT, INLINE |
| 构造方法摘要 | |
|---|---|
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,
int msgnum)
Constructs an empty MimeMessage object with the given Folder and message number. |
protected |
MimeMessage(Folder folder,
InternetHeaders headers,
byte[] content,
int msgnum)
Constructs a MimeMessage from the given InternetHeaders object and content. |
|
MimeMessage(MimeMessage source)
Constructs a new MimeMessage with content initialized from the source MimeMessage. |
|
MimeMessage(Session session)
Default constructor. |
|
MimeMessage(Session session,
InputStream is)
Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream. |
| 方法摘要 | |
|---|---|
void |
addFrom(Address[] addresses)
Add the specified addresses to the existing "From" field. |
void |
addHeader(String name,
String value)
Add this value to the existing values for this header_name. |
void |
addHeaderLine(String line)
Add a raw RFC 822 header-line. |
void |
addRecipients(Message.RecipientType type,
Address[] addresses)
Add the given addresses to the specified recipient type. |
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. |
Enumeration |
getAllHeaderLines()
Get all header lines as an Enumeration of Strings. |
Enumeration |
getAllHeaders()
Return all the headers from this Message as an enumeration of Header objects. |
Address[] |
getAllRecipients()
Get all the recipient addresses for the message. |
Object |
getContent()
Return the content as a Java object. |
String |
getContentID()
Returns the value of the "Content-ID" header field. |
String[] |
getContentLanguage()
Get the languages specified in the "Content-Language" header field of this message. |
String |
getContentMD5()
Return the value of the "Content-MD5" header field. |
protected InputStream |
getContentStream()
Produce the raw bytes of the content. |
String |
getContentType()
Returns the value of the RFC 822 "Content-Type" header field. |
DataHandler |
getDataHandler()
Return a DataHandler for this Message's content. |
String |
getDescription()
Returns the "Content-Description" header field of this Message. |
String |
getDisposition()
Returns the value of the "Content-Disposition" header field. |
String |
getEncoding()
Returns the content transfer encoding from the "Content-Transfer-Encoding" header field. |
String |
getFileName()
Get the filename associated with this Message. |
Flags |
getFlags()
Return a Flags object containing the flags for
this message. |
Address[] |
getFrom()
Returns the value of the RFC 822 "From" header fields. |
String[] |
getHeader(String name)
Get all the headers for this header_name. |
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. |
InputStream |
getInputStream()
Return a decoded input stream for this Message's "content". |
int |
getLineCount()
Return the number of lines for the content of this message. |
Enumeration |
getMatchingHeaderLines(String[] names)
Get matching header lines as an Enumeration of Strings. |
Enumeration |
getMatchingHeaders(String[] names)
Return matching headers from this Message as an Enumeration of Header objects. |
String |
getMessageID()
Returns the value of the "Message-ID" header field. |
Enumeration |
getNonMatchingHeaderLines(String[] names)
Get non-matching header lines as an Enumeration of Strings. |
Enumeration |
getNonMatchingHeaders(String[] names)
Return non-matching headers from this Message as an Enumeration of Header objects. |
InputStream |
getRawInputStream()
Return an InputStream to the raw data with any Content-Transfer-Encoding intact. |
Date |
getReceivedDate()
Returns the Date on this message was received. |
Address[] |
getRecipients(Message.RecipientType type)
Returns the recepients specified by the type. |
Address[] |
getReplyTo()
Return the value of the RFC 822 "Reply-To" header field. |
Address |
getSender()
Returns the value of the RFC 822 "Sender" header field. |
Date |
getSentDate()
Returns the value of the RFC 822 "Date" field. |
int |
getSize()
Return the size of the content of this message in bytes. |
String |
getSubject()
Returns the value of the "Subject" header field. |
boolean |
isMimeType(String mimeType)
Is this Part of the specified MIME type? |
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. |
void |
removeHeader(String name)
Remove all headers with this name. |
Message |
reply(boolean replyToAll)
Get a new Message suitable for a reply to this message. |
void |
saveChanges()
Updates the appropriate header fields of this message to be consistent with the message's contents. |
void |
setContent(Multipart mp)
This method sets the Message's content to a Multipart object. |
void |
setContent(Object o,
String type)
A convenience method for setting this Message's content. |
void |
setContentID(String cid)
Set the "Content-ID" header field of this Message. |
void |
setContentLanguage(String[] languages)
Set the "Content-Language" header of this MimePart. |
void |
setContentMD5(String md5)
Set the "Content-MD5" header field of this Message. |
void |
setDataHandler(DataHandler dh)
This method provides the mechanism to set this part's content. |
void |
setDescription(String description)
Set the "Content-Description" header field for this Message. |
void |
setDescription(String description,
String charset)
Set the "Content-Description" header field for this Message. |
void |
setDisposition(String disposition)
Set the "Content-Disposition" header field of this Message. |
void |
setFileName(String filename)
Set the filename associated with this part, if possible. |
void |
setFlags(Flags flag,
boolean set)
Set the flags for this message. |
void |
setFrom()
Set the RFC 822 "From" header field using the value of the InternetAddress.getLocalAddress method. |
void |
setFrom(Address address)
Set the RFC 822 "From" header field. |
void |
setHeader(String name,
String value)
Set the value for this header_name. |
void |
setRecipients(Message.RecipientType type,
Address[] addresses)
Set the specified recipient type to the given addresses. |
void |
setRecipients(Message.RecipientType type,
String addresses)
Set the specified recipient type to the given addresses. |
void |
setReplyTo(Address[] addresses)
Set the RFC 822 "Reply-To" header field. |
void |
setSender(Address address)
Set the RFC 822 "Sender" header field. |
void |
setSentDate(Date d)
Set the RFC 822 "Date" header field. |
void |
setSubject(String subject)
Set the "Subject" header field. |
void |
setSubject(String subject,
String charset)
Set the "Subject" header field. |
void |
setText(String text)
Convenience method that sets the given String as this part's content, with a MIME type of "text/plain". |
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. |
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. |
void |
writeTo(OutputStream os)
Output the message as an RFC 822 format stream. |
void |
writeTo(OutputStream os,
String[] ignoreList)
Output the message as an RFC 822 format stream, without specified headers. |
| 从类 javax.mail.Message 继承的方法 |
|---|
addRecipient, getFolder, getMessageNumber, isExpunged, match, setExpunged, setFlag, setMessageNumber, setRecipient |
| 从类 java.lang.Object 继承的方法 |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| 字段详细信息 |
|---|
protected DataHandler dh
protected byte[] content
protected InputStream contentStream
contentStream is another such stream representing
the content of this message. In this case, content
will be null.
protected InternetHeaders headers
protected Flags flags
protected boolean modified
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.
protected boolean saved
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.
| 构造方法详细信息 |
|---|
public MimeMessage(Session session)
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.
public MimeMessage(Session session,
InputStream is)
throws MessagingException
The input stream contains an entire MIME formatted message with headers and data.
session - Session object for this messageis - the message input stream
MessagingException
public MimeMessage(MimeMessage source)
throws MessagingException
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.
source - the message to copy content from
MessagingException
protected MimeMessage(Folder folder,
int msgnum)
This method is for providers subclassing MimeMessage.
protected MimeMessage(Folder folder,
InputStream is,
int msgnum)
throws MessagingException
This method is for providers subclassing MimeMessage.
folder - The containing folder.is - the message input streammsgnum - Message number of this message within its folder
MessagingException
protected MimeMessage(Folder folder,
InternetHeaders headers,
byte[] content,
int msgnum)
throws MessagingException
MimeMessage.
folder - The containing folder.headers - The headerscontent - The message contentmsgnum - Message number of this message within its folder
MessagingException| 方法详细信息 |
|---|
protected void parse(InputStream is)
throws MessagingException
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.
is - The message input stream
MessagingException
public Address[] getFrom()
throws MessagingException
null
is returned.
This implementation uses the getHeader method
to obtain the requisite header field.
Message 中的 getFromMessagingExceptionheaders
public void setFrom(Address address)
throws MessagingException
null,
this header is removed.
Message 中的 setFromaddress - the sender of this message
IllegalWriteException - if the underlying
implementation does not support modification
of existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public void setFrom()
throws MessagingException
InternetAddress.getLocalAddress method.
Message 中的 setFromIllegalWriteException - if the underlying
implementation does not support modification
of existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public void addFrom(Address[] addresses)
throws MessagingException
Message 中的 addFromaddresses - the senders of this message
IllegalWriteException - if the underlying
implementation does not support modification
of existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public Address getSender()
throws MessagingException
null
is returned.
This implementation uses the getHeader method
to obtain the requisite header field.
MessagingExceptionheaders
public void setSender(Address address)
throws MessagingException
null,
this header is removed.
address - the sender of this message
IllegalWriteException - if the underlying
implementation does not support modification
of existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public Address[] getRecipients(Message.RecipientType type)
throws MessagingException
Message.RecipientType.TO "To"
Message.RecipientType.CC "Cc"
Message.RecipientType.BCC "Bcc"
MimeMessage.RecipientType.NEWSGROUPS "Newsgroups"
This implementation uses the getHeader method
to obtain the requisite header field.
Message 中的 getRecipientstype - Type of recepient
MessagingException - if header could not
be retrieved
AddressException - if the header is misformattedheaders,
Message.RecipientType.TO,
Message.RecipientType.CC,
Message.RecipientType.BCC,
MimeMessage.RecipientType.NEWSGROUPS
public Address[] getAllRecipients()
throws MessagingException
Message 中的 getAllRecipientsMessagingExceptionMessage.RecipientType.TO,
Message.RecipientType.CC,
Message.RecipientType.BCC,
MimeMessage.RecipientType.NEWSGROUPS
public void setRecipients(Message.RecipientType type,
Address[] addresses)
throws MessagingException
null, the corresponding
recipient field is removed.
Message 中的 setRecipientstype - Recipient typeaddresses - Addresses
IllegalWriteException - if the underlying
implementation does not support modification
of existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingExceptiongetRecipients(javax.mail.Message.RecipientType)
public void setRecipients(Message.RecipientType type,
String addresses)
throws MessagingException
null, the corresponding
recipient field is removed.
type - Recipient typeaddresses - Addresses
AddressException - if the attempt to parse the
addresses String fails
IllegalWriteException - if the underlying
implementation does not support modification
of existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingExceptiongetRecipients(javax.mail.Message.RecipientType)
public void addRecipients(Message.RecipientType type,
Address[] addresses)
throws MessagingException
Message 中的 addRecipientstype - Recipient typeaddresses - Addresses
IllegalWriteException - if the underlying
implementation does not support modification
of existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public void addRecipients(Message.RecipientType type,
String addresses)
throws MessagingException
type - Recipient typeaddresses - Addresses
AddressException - if the attempt to parse the
addresses String fails
IllegalWriteException - if the underlying
implementation does not support modification
of existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public Address[] getReplyTo()
throws MessagingException
getFrom method is called and its value is returned.
This implementation uses the getHeader method
to obtain the requisite header field.
Message 中的 getReplyToMessagingExceptionheaders
public void setReplyTo(Address[] addresses)
throws MessagingException
null, this header is removed.
Message 中的 setReplyToaddresses - addresses to which replies should be directed
IllegalWriteException - if the underlying
implementation does not support modification
of existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
MethodNotSupportedException - if the underlying
implementation does not support setting this
attribute
public String getSubject()
throws MessagingException
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.
Message 中的 getSubjectMessagingExceptionheaders
public void setSubject(String subject)
throws MessagingException
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.
Message 中的 setSubjectsubject - The subject
IllegalWriteException - if the underlying
implementation does not support modification
of existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException. - An
UnsupportedEncodingException may be included
in the exception chain if the charset
conversion fails.
MessagingException
public void setSubject(String subject,
String charset)
throws MessagingException
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.
subject - The subjectcharset - The charset
IllegalWriteException - if the underlying
implementation does not support modification
of existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException. - An
UnsupportedEncodingException may be included
in the exception chain if the charset
conversion fails.
MessagingException
public Date getSentDate()
throws MessagingException
This implementation uses the getHeader method
to obtain the requisite header field.
Message 中的 getSentDateMessagingException
public void setSentDate(Date d)
throws MessagingException
null, the existing "Date" field is removed.
Message 中的 setSentDated - the sent date of this message
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public Date getReceivedDate()
throws MessagingException
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.
Message 中的 getReceivedDateMessagingException
public int getSize()
throws MessagingException
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.
Part 中的 getSizeMessagingException
public int getLineCount()
throws MessagingException
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.
Part 中的 getLineCountMessagingException
public String getContentType()
throws MessagingException
This implementation uses the getHeader method
to obtain the requisite header field.
Part 中的 getContentTypeMessagingExceptionDataHandler
public boolean isMimeType(String mimeType)
throws MessagingException
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.
Part 中的 isMimeTypeMessagingException
public String getDisposition()
throws MessagingException
If the Content-Disposition field is unavailable,
null is returned.
This implementation uses the getHeader method
to obtain the requisite header field.
Part 中的 getDispositionMessagingExceptionPart.ATTACHMENT,
Part.INLINE,
Part.getFileName()
public void setDisposition(String disposition)
throws MessagingException
disposition is null, any existing "Content-Disposition"
header field is removed.
Part 中的 setDispositiondisposition - disposition of this part
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingExceptionPart.ATTACHMENT,
Part.INLINE,
Part.setFileName(java.lang.String)
public String getEncoding()
throws MessagingException
null if the header is unavailable
or its value is absent.
This implementation uses the getHeader method
to obtain the requisite header field.
MimePart 中的 getEncodingMessagingException
public String getContentID()
throws MessagingException
null if the field is unavailable or its value is
absent.
This implementation uses the getHeader method
to obtain the requisite header field.
MimePart 中的 getContentIDMessagingException
public void setContentID(String cid)
throws MessagingException
cid parameter is null, any existing
"Content-ID" is removed.
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public String getContentMD5()
throws MessagingException
null if this field is unavailable or its value
is absent.
This implementation uses the getHeader method
to obtain the requisite header field.
MimePart 中的 getContentMD5MessagingException
public void setContentMD5(String md5)
throws MessagingException
MimePart 中的 setContentMD5md5 - the MD5 value
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public String getDescription()
throws MessagingException
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.
Part 中的 getDescriptionMessagingException
public void setDescription(String description)
throws MessagingException
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.
Part 中的 setDescriptiondescription - content-description
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException. - An
UnsupportedEncodingException may be included
in the exception chain if the charset
conversion fails.
MessagingException
public void setDescription(String description,
String charset)
throws MessagingException
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.
description - Descriptioncharset - Charset for encoding
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException. - An
UnsupportedEncodingException may be included
in the exception chain if the charset
conversion fails.
MessagingException
public String[] getContentLanguage()
throws MessagingException
null if this field is unavailable
or its value is absent.
This implementation uses the getHeader method
to obtain the requisite header field.
MimePart 中的 getContentLanguageMessagingException
public void setContentLanguage(String[] languages)
throws MessagingException
MimePart 中的 setContentLanguagelanguages - array of language tags
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public String getMessageID()
throws MessagingException
The default implementation provided here uses the
getHeader method to return the value of the
"Message-ID" field.
MessagingException - if the retrieval of this field
causes any exception.MessageIDTerm
public String getFileName()
throws MessagingException
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.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.
Part 中的 getFileNameMessagingException
public void setFileName(String filename)
throws MessagingException
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.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.
Part 中的 setFileNamefilename - Filename to associate with this part
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public InputStream getInputStream()
throws IOException,
MessagingException
This implementation obtains the input stream from the DataHandler,
that is, it invokes getDataHandler().getInputStream().
Part 中的 getInputStreamMessagingException
IOException - this is typically thrown by the
DataHandler. Refer to the documentation for
javax.activation.DataHandler for more details.getContentStream(),
DataHandler.getInputStream()
protected InputStream getContentStream()
throws MessagingException
This implementation returns a SharedInputStream, if
contentStream is not null. Otherwise, it
returns a ByteArrayInputStream constructed
out of the content byte array.
MessagingExceptioncontent
public InputStream getRawInputStream()
throws MessagingException
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.
MessagingExceptiongetInputStream(),
getContentStream()
public DataHandler getDataHandler()
throws MessagingException
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());
}
....
}
Part 中的 getDataHandlerMessagingException
public Object getContent()
throws IOException,
MessagingException
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.
Part 中的 getContentMessagingException
IOException - this is typically thrown by the
DataHandler. Refer to the documentation for
javax.activation.DataHandler for more details.Part,
DataHandler.getContent()
public void setDataHandler(DataHandler dh)
throws MessagingException
Part 中的 setDataHandlerdh - The DataHandler for the content.
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public void setContent(Object o,
String type)
throws MessagingException
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.
Part 中的 setContento - the content objecttype - Mime type of the object
IllegalWriteException - if the underlying
implementation does not support modification of
existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public void setText(String text)
throws MessagingException
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.
MimePart 中的 setTextPart 中的 setTexttext - the text content to set
MessagingException - if an error occurssetText(String text, String charset)
public void setText(String text,
String charset)
throws MessagingException
MimePart 中的 setTexttext - the text content to setcharset - the charset to use for the text
MessagingException - if an error occurs
public void setText(String text,
String charset,
String subtype)
throws MessagingException
MimePart 中的 setTexttext - the text content to setcharset - the charset to use for the textsubtype - the MIME subtype to use (e.g., "html")
MessagingException - if an error occurs
public void setContent(Multipart mp)
throws MessagingException
Part 中的 setContentmp - The multipart object that is the Message's content
IllegalWriteException - if the underlying
implementation does not support modification of
existing values
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public Message reply(boolean replyToAll)
throws MessagingException
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.
Message 中的 replyreplyToAll - reply should be sent to all recipients
of this message
MessagingException
public void writeTo(OutputStream os)
throws IOException,
MessagingException
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.
Part 中的 writeToIOException - if an error occurs writing to the stream
or if an error is generated by the
javax.activation layer.
MessagingExceptionDataHandler.writeTo(java.io.OutputStream)
public void writeTo(OutputStream os,
String[] ignoreList)
throws IOException,
MessagingException
saved flag is not set,
the saveChanges method is called.
If the modified flag is not
set and the content array is not null, the
content array is written directly, after
writing the appropriate message headers.
MessagingException
IOException - if an error occurs writing to the stream
or if an error is generated by the
javax.activation layer.DataHandler.writeTo(java.io.OutputStream)
public String[] getHeader(String name)
throws MessagingException
This implementation obtains the headers from the
headers InternetHeaders object.
Part 中的 getHeadername - name of header
MessagingExceptionMimeUtility
public String getHeader(String name,
String delimiter)
throws MessagingException
null, only the first header is
returned.
MimePart 中的 getHeadername - the name of this headerdelimiter - separator between values
MessagingException
public void setHeader(String name,
String value)
throws MessagingException
Part 中的 setHeadername - header namevalue - header value
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingExceptionMimeUtility
public void addHeader(String name,
String value)
throws MessagingException
Part 中的 addHeadername - header namevalue - header value
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingExceptionMimeUtility
public void removeHeader(String name)
throws MessagingException
Part 中的 removeHeadername - the name of this header
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public Enumeration getAllHeaders()
throws MessagingException
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.
Part 中的 getAllHeadersMessagingExceptionMimeUtility
public Enumeration getMatchingHeaders(String[] names)
throws MessagingException
headers InternetHeaders object.
Part 中的 getMatchingHeadersMessagingException
public Enumeration getNonMatchingHeaders(String[] names)
throws MessagingException
headers InternetHeaders object.
Part 中的 getNonMatchingHeadersMessagingException
public void addHeaderLine(String line)
throws MessagingException
MimePart 中的 addHeaderLineIllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
public Enumeration getAllHeaderLines()
throws MessagingException
MimePart 中的 getAllHeaderLinesMessagingException
public Enumeration getMatchingHeaderLines(String[] names)
throws MessagingException
MimePart 中的 getMatchingHeaderLinesMessagingException
public Enumeration getNonMatchingHeaderLines(String[] names)
throws MessagingException
MimePart 中的 getNonMatchingHeaderLinesMessagingException
public Flags getFlags()
throws MessagingException
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.
Message 中的 getFlagsMessagingExceptionFlags
public boolean isSet(Flags.Flag flag)
throws MessagingException
flag
argument is set in this message.
This implementation checks this message's internal
flags object.
Message 中的 isSetflag - the flag
MessagingExceptionFlags.Flag,
Flags.Flag.ANSWERED,
Flags.Flag.DELETED,
Flags.Flag.DRAFT,
Flags.Flag.FLAGGED,
Flags.Flag.RECENT,
Flags.Flag.SEEN
public void setFlags(Flags flag,
boolean set)
throws MessagingException
This implementation modifies the flags field.
Message 中的 setFlagsflag - Flags object containing the flags to be setset - the value to be set
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingExceptionMessageChangedEvent
public void saveChanges()
throws MessagingException
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.
Message 中的 saveChanges
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
protected void updateMessageID()
throws MessagingException
updateHeaders and allows a subclass
to override only the algorithm for choosing a Message-ID.
MessagingException
protected void updateHeaders()
throws MessagingException
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.
IllegalWriteException - if the underlying
implementation does not support modification
IllegalStateException - if this message is
obtained from a READ_ONLY folder.
MessagingException
protected InternetHeaders createInternetHeaders(InputStream is)
throws MessagingException
is - the InputStream to read the headers from
MessagingException
protected MimeMessage createMimeMessage(Session session)
throws MessagingException
session - the Session to use for the new message
MessagingException
|
||||||||||
| 上一个类 下一个类 | 框架 无框架 | |||||||||
| 摘要: 嵌套 | 字段 | 构造方法 | 方法 | 详细信息: 字段 | 构造方法 | 方法 | |||||||||