IMAPMessage (XJavaMail API 0.1.6 API)

java.lang.Object
- javax.mail.Message
- - javax.mail.internet.MimeMessage
  - - net.iotgw.mail.imap.IMAPMessage

所有已实现的接口:

MimePart, Part, ReadableMime

直接已知子类:

IMAPNestedMessage
```
public class IMAPMessage
extends MimeMessage
implements ReadableMime
```
This class implements an IMAPMessage object.
An IMAPMessage object starts out as a light-weight object. It gets filled-in incrementally when a request is made for some item. Or when a prefetch is done using the FetchProfile.
An IMAPMessage has a messageNumber and a sequenceNumber. The messageNumber is its index into its containing folder's messageCache. The sequenceNumber is its IMAP sequence-number.

作者:

John Mani, Bill Shannon

嵌套类概要

嵌套类
限定符和类型类和说明

static class IMAPMessage.FetchProfileCondition
This class implements the test to be done on each message in the folder.
- 从类继承的嵌套类/接口 javax.mail.internet.MimeMessage
  MimeMessage.RecipientType

嵌套类
限定符和类型	类和说明
`static class`	`IMAPMessage.FetchProfileCondition` This class implements the test to be done on each message in the folder.

字段概要

字段
限定符和类型	字段和说明
`protected BODYSTRUCTURE`	`bs`
`protected ENVELOPE`	`envelope`
`protected Map<String,Object>`	`items` A map of the extension FETCH items.
`protected String`	`sectionId`

从类继承的字段 javax.mail.internet.MimeMessage
cachedContent, content, contentStream, dh, flags, headers, modified, saved

从类继承的字段 javax.mail.Message
expunged, folder, msgnum, session

从接口继承的字段 javax.mail.Part
ATTACHMENT, INLINE

构造器概要

构造器
限定符	构造器和说明
`protected`	`IMAPMessage(IMAPFolder folder, int msgnum)` Constructor.
`protected`	`IMAPMessage(Session session)` Constructor, for use by IMAPNestedMessage.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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.
`protected void`	`checkExpunged()`
`protected Object`	`fetchItem(FetchItem fitem)` Fetch an individual item for the current message.
`protected void`	`forceCheckExpunged()` Do a NOOP to force any untagged EXPUNGE responses and then check if this message is expunged.
`Enumeration<String>`	`getAllHeaderLines()` Get all header-lines.
`Enumeration<Header>`	`getAllHeaders()` Get all headers.
`String`	`getContentID()` Get the Content-ID.
`String[]`	`getContentLanguage()` Get the content language.
`String`	`getContentMD5()` Get the Content-MD5.
`protected InputStream`	`getContentStream()` Get all the bytes for this message.
`String`	`getContentType()` Get the Content-Type.
`DataHandler`	`getDataHandler()` Get the DataHandler object for this message.
`String`	`getDescription()` Get the decoded Content-Description.
`String`	`getDisposition()` Get the Content-Disposition.
`String`	`getEncoding()` Get the Content-Transfer-Encoding.
`protected int`	`getFetchBlockSize()`
`String`	`getFileName()` Get the "filename" Disposition parameter.
`Flags`	`getFlags()` Get the Flags for this message.
`Address[]`	`getFrom()` Get the "From" attribute.
`String[]`	`getHeader(String name)` Get the named header.
`String`	`getHeader(String name, String delimiter)` Get the named header.
`String`	`getInReplyTo()` Get the In-Reply-To header.
`Object`	`getItem(FetchItem fitem)` Return the data associated with the FetchItem.
`int`	`getLineCount()` Get the total number of lines.
`Enumeration<String>`	`getMatchingHeaderLines(String[] names)` Get all matching header-lines.
`Enumeration<Header>`	`getMatchingHeaders(String[] names)` Get matching headers.
`protected Object`	`getMessageCacheLock()` Get the messageCacheLock, associated with this Message's Folder.
`String`	`getMessageID()` Get the Message-ID.
`InputStream`	`getMimeStream()` Return the MIME format stream corresponding to this message.
`long`	`getModSeq()` Return the modification sequence number (MODSEQ) for this message.
`Enumeration<String>`	`getNonMatchingHeaderLines(String[] names)` Get all non-matching headerlines.
`Enumeration<Header>`	`getNonMatchingHeaders(String[] names)` Get non-matching headers.
`boolean`	`getPeek()` Get whether or not to use the PEEK variant of FETCH when fetching message content.
`protected IMAPProtocol`	`getProtocol()` Get this message's folder's protocol connection.
`Date`	`getReceivedDate()` Get the received date (INTERNALDATE).
`Address[]`	`getRecipients(Message.RecipientType type)` Get the desired Recipient type.
`Address[]`	`getReplyTo()` Get the ReplyTo addresses.
`Address`	`getSender()` Get the "Sender" attribute.
`Date`	`getSentDate()` Get the SentDate.
`protected int`	`getSequenceNumber()` Get this message's IMAP sequence number.
`int`	`getSize()` Get the message size.
`long`	`getSizeLong()` Get the message size as a long.
`String`	`getSubject()` Get the decoded subject.
`protected long`	`getUID()` Return the UID for this message.
`protected void`	`handleExtensionFetchItems(Map<String,Object> extensionItems)` Apply the data in the extension FETCH items to this message.
`protected boolean`	`handleFetchItem(Item item, String[] hdrs, boolean allHeaders)` Apply the data in the FETCH item to this message.
`protected boolean`	`ignoreBodyStructureSize()`
`void`	`invalidateHeaders()` Invalidate cached header and envelope information for this message.
`protected boolean`	`isREV1()`
`boolean`	`isSet(Flags.Flag flag)` Test if the given Flags are set in this message.
`void`	`removeHeader(String name)` Remove all headers with this name.
`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 content)` This method provides the mechanism to set this part's content.
`void`	`setDescription(String description, String charset)` Set the "Content-Description" header field for this Message.
`void`	`setDisposition(String disposition)` Set the disposition in the "Content-Disposition" header field of this body part.
`protected void`	`setExpunged(boolean set)` Sets the expunged flag for this Message.
`void`	`setFileName(String filename)` Set the filename associated with this part, if possible.
`void`	`setFlags(Flags flag, boolean set)` Set/Unset the given flags in this message.
`void`	`setFrom(Address address)` Set the RFC 822 "From" header field.
`void`	`setHeader(String name, String value)` Set the value for this header_name.
`protected void`	`setMessageNumber(int msgnum)` Wrapper around the protected method Message.setMessageNumber() to make that method accessible to IMAPFolder.
`void`	`setPeek(boolean peek)` Set whether or not to use the PEEK variant of FETCH when fetching message content.
`void`	`setRecipients(Message.RecipientType type, Address[] 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, String charset)` Set the "Subject" header field.
`protected void`	`setUID(long uid)`
`void`	`writeTo(OutputStream os)` Write out the bytes into the given OutputStream.

从类继承的方法 javax.mail.internet.MimeMessage
addRecipients, createInternetHeaders, createMimeMessage, getAllRecipients, getContent, getInputStream, getRawInputStream, isMimeType, parse, reply, reply, saveChanges, setContent, setContent, setDescription, setFrom, setFrom, setRecipients, setSubject, setText, setText, setText, updateHeaders, updateMessageID, writeTo

从类继承的方法 javax.mail.Message
addRecipient, getFolder, getMessageNumber, getSession, isExpunged, match, setFlag, setRecipient

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - bs
```
protected BODYSTRUCTURE bs
```
  - envelope
```
protected ENVELOPE envelope
```
  - items
```
protected Map<String,Object> items
```
    A map of the extension FETCH items. In addition to saving the data in this map, an entry in this map indicates that we *have* the data, and so it doesn't need to be fetched again. The map is created only when needed, to avoid significantly increasing the effective size of an IMAPMessage object.
    
    从以下版本开始:
    
    JavaMail 1.4.6
  - sectionId
```
protected String sectionId
```
- 构造器详细资料
  - IMAPMessage
```
protected IMAPMessage(IMAPFolder folder,
                      int msgnum)
```
    Constructor.
    
    参数:
    
    folder - the folder containing this message
    
    msgnum - the message sequence number
  - IMAPMessage
```
protected IMAPMessage(Session session)
```
    Constructor, for use by IMAPNestedMessage.
    
    参数:
    
    session - the Session
- 方法详细资料
  - getProtocol
```
protected IMAPProtocol getProtocol()
                            throws ProtocolException,
                                   FolderClosedException
```
    Get this message's folder's protocol connection. Throws FolderClosedException, if the protocol connection is not available. ASSERT: Must hold the messageCacheLock.
    
    返回:
    
    the IMAPProtocol object for the containing folder
    
    抛出:
    
    ProtocolException - for protocol errors
    
    FolderClosedException - if the folder is closed
  - isREV1
```
protected boolean isREV1()
                  throws FolderClosedException
```
    抛出:
    
    FolderClosedException
  - getMessageCacheLock
```
protected Object getMessageCacheLock()
```
    Get the messageCacheLock, associated with this Message's Folder.
    
    返回:
    
    the message cache lock object
  - getSequenceNumber
```
protected int getSequenceNumber()
```
    Get this message's IMAP sequence number. ASSERT: This method must be called only when holding the messageCacheLock.
    
    返回:
    
    the message sequence number
  - setMessageNumber
```
protected void setMessageNumber(int msgnum)
```
    Wrapper around the protected method Message.setMessageNumber() to make that method accessible to IMAPFolder.
    
    覆盖:
    
    setMessageNumber 在类中 Message
    
    参数:
    
    msgnum - the message number
  - getUID
```
protected long getUID()
```
    Return the UID for this message. Returns -1 if not known; use UIDFolder.getUID() in this case.
    
    返回:
    
    the UID
    
    另请参阅:
    
    UIDFolder.getUID(javax.mail.Message)
  - setUID
```
protected void setUID(long uid)
```
  - getModSeq
```
public long getModSeq()
               throws MessagingException
```
    Return the modification sequence number (MODSEQ) for this message. Returns -1 if not known.
    
    返回:
    
    the modification sequence number
    
    抛出:
    
    MessagingException - for failures
    
    从以下版本开始:
    
    JavaMail 1.5.1
    
    另请参阅:
    
    "RFC 4551"
  - setExpunged
```
protected void setExpunged(boolean set)
```
    从类复制的说明: Message
    
    Sets the expunged flag for this Message. This method is to be used only by the implementation classes.
    
    覆盖:
    
    setExpunged 在类中 Message
    
    参数:
    
    set - the expunged flag
  - checkExpunged
```
protected void checkExpunged()
                      throws MessageRemovedException
```
    抛出:
    
    MessageRemovedException
  - forceCheckExpunged
```
protected void forceCheckExpunged()
                           throws MessageRemovedException,
                                  FolderClosedException
```
    Do a NOOP to force any untagged EXPUNGE responses and then check if this message is expunged.
    
    抛出:
    
    MessageRemovedException - if the message has been removed
    
    FolderClosedException - if the folder has been closed
  - getFetchBlockSize
```
protected int getFetchBlockSize()
```
  - ignoreBodyStructureSize
```
protected boolean ignoreBodyStructureSize()
```
  - getFrom
```
public Address[] getFrom()
                  throws MessagingException
```
    Get the "From" attribute.
    
    覆盖:
    
    getFrom 在类中 MimeMessage
    
    返回:
    
    Address object
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeMessage.headers
  - setFrom
```
public void setFrom(Address address)
             throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Set the RFC 822 "From" header field. Any existing values are replaced with the given address. If address is null, this header is removed.
    
    覆盖:
    
    setFrom 在类中 MimeMessage
    
    参数:
    
    address - the sender of this message
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
  - addFrom
```
public void addFrom(Address[] addresses)
             throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Add the specified addresses to the existing "From" field. If the "From" field does not already exist, it is created.
    
    覆盖:
    
    addFrom 在类中 MimeMessage
    
    参数:
    
    addresses - the senders of this message
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
  - getSender
```
public Address getSender()
                  throws MessagingException
```
    Get the "Sender" attribute.
    
    覆盖:
    
    getSender 在类中 MimeMessage
    
    返回:
    
    Address object
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeMessage.headers
  - setSender
```
public void setSender(Address address)
               throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Set the RFC 822 "Sender" header field. Any existing values are replaced with the given address. If address is null, this header is removed.
    
    覆盖:
    
    setSender 在类中 MimeMessage
    
    参数:
    
    address - the sender of this message
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
  - getRecipients
```
public Address[] getRecipients(Message.RecipientType type)
                        throws MessagingException
```
    Get the desired Recipient type.
    
    覆盖:
    
    getRecipients 在类中 MimeMessage
    
    参数:
    
    type - Type of recepient
    
    返回:
    
    array of Address objects
    
    抛出:
    
    MessagingException - if header could not be retrieved
    
    AddressException - if the header is misformatted
    
    另请参阅:
    
    MimeMessage.headers, Message.RecipientType.TO, Message.RecipientType.CC, Message.RecipientType.BCC, MimeMessage.RecipientType.NEWSGROUPS
  - setRecipients
```
public void setRecipients(Message.RecipientType type,
                          Address[] addresses)
                   throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Set the specified recipient type to the given addresses. If the address parameter is null, the corresponding recipient field is removed.
    
    覆盖:
    
    setRecipients 在类中 MimeMessage
    
    参数:
    
    type - Recipient type
    
    addresses - Addresses
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
    
    另请参阅:
    
    MimeMessage.getRecipients(javax.mail.Message.RecipientType)
  - addRecipients
```
public void addRecipients(Message.RecipientType type,
                          Address[] addresses)
                   throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Add the given addresses to the specified recipient type.
    
    覆盖:
    
    addRecipients 在类中 MimeMessage
    
    参数:
    
    type - Recipient type
    
    addresses - Addresses
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
  - getReplyTo
```
public Address[] getReplyTo()
                     throws MessagingException
```
    Get the ReplyTo addresses.
    
    覆盖:
    
    getReplyTo 在类中 MimeMessage
    
    返回:
    
    addresses to which replies should be directed
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeMessage.headers
  - setReplyTo
```
public void setReplyTo(Address[] addresses)
                throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Set the RFC 822 "Reply-To" header field. If the address parameter is null, this header is removed.
    
    覆盖:
    
    setReplyTo 在类中 MimeMessage
    
    参数:
    
    addresses - addresses to which replies should be directed
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
  - getSubject
```
public String getSubject()
                  throws MessagingException
```
    Get the decoded subject.
    
    覆盖:
    
    getSubject 在类中 MimeMessage
    
    返回:
    
    Subject
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeMessage.headers
  - setSubject
```
public void setSubject(String subject,
                       String charset)
                throws MessagingException
```
    从类复制的说明: MimeMessage
    
    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.
    
    覆盖:
    
    setSubject 在类中 MimeMessage
    
    参数:
    
    subject - The subject
    
    charset - The charset
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
  - getSentDate
```
public Date getSentDate()
                 throws MessagingException
```
    Get the SentDate.
    
    覆盖:
    
    getSentDate 在类中 MimeMessage
    
    返回:
    
    The sent Date
    
    抛出:
    
    MessagingException - for failures
  - setSentDate
```
public void setSentDate(Date d)
                 throws MessagingException
```
    从类复制的说明: MimeMessage
    
    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.
    
    覆盖:
    
    setSentDate 在类中 MimeMessage
    
    参数:
    
    d - the sent date of this message
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
  - getReceivedDate
```
public Date getReceivedDate()
                     throws MessagingException
```
    Get the received date (INTERNALDATE).
    
    覆盖:
    
    getReceivedDate 在类中 MimeMessage
    
    返回:
    
    the date this message was received
    
    抛出:
    
    MessagingException - for failures
  - getSize
```
public int getSize()
            throws MessagingException
```
    Get the message size.
    Note that this returns RFC822.SIZE. That is, it's the size of the whole message, header and body included. Note also that if the size of the message is greater than Integer.MAX_VALUE (2GB), this method returns Integer.MAX_VALUE.
    
    指定者:
    
    getSize 在接口中 Part
    
    覆盖:
    
    getSize 在类中 MimeMessage
    
    返回:
    
    size of content in bytes
    
    抛出:
    
    MessagingException - for failures
  - getSizeLong
```
public long getSizeLong()
                 throws MessagingException
```
    Get the message size as a long.
    Suitable for messages that might be larger than 2GB.
    
    返回:
    
    the message size as a long integer
    
    抛出:
    
    MessagingException - for failures
    
    从以下版本开始:
    
    JavaMail 1.6
  - getLineCount
```
public int getLineCount()
                 throws MessagingException
```
    Get the total number of lines.
    Returns the "body_fld_lines" field from the BODYSTRUCTURE. Note that this field is available only for text/plain and message/rfc822 types
    
    指定者:
    
    getLineCount 在接口中 Part
    
    覆盖:
    
    getLineCount 在类中 MimeMessage
    
    返回:
    
    number of lines in the content.
    
    抛出:
    
    MessagingException - for failures
  - getContentLanguage
```
public String[] getContentLanguage()
                            throws MessagingException
```
    Get the content language.
    
    指定者:
    
    getContentLanguage 在接口中 MimePart
    
    覆盖:
    
    getContentLanguage 在类中 MimeMessage
    
    返回:
    
    value of content-language header.
    
    抛出:
    
    MessagingException - for failures
  - setContentLanguage
```
public void setContentLanguage(String[] languages)
                        throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Set the "Content-Language" header of this MimePart. The Content-Language header is defined by RFC 1766.
    
    指定者:
    
    setContentLanguage 在接口中 MimePart
    
    覆盖:
    
    setContentLanguage 在类中 MimeMessage
    
    参数:
    
    languages - array of language tags
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
  - getInReplyTo
```
public String getInReplyTo()
                    throws MessagingException
```
    Get the In-Reply-To header.
    
    返回:
    
    the In-Reply-To header
    
    抛出:
    
    MessagingException - for failures
    
    从以下版本开始:
    
    JavaMail 1.3.3
  - getContentType
```
public String getContentType()
                      throws MessagingException
```
    Get the Content-Type. Generate this header from the BODYSTRUCTURE. Append parameters as well.
    
    指定者:
    
    getContentType 在接口中 Part
    
    覆盖:
    
    getContentType 在类中 MimeMessage
    
    返回:
    
    The ContentType of this part
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    DataHandler
  - getDisposition
```
public String getDisposition()
                      throws MessagingException
```
    Get the Content-Disposition.
    
    指定者:
    
    getDisposition 在接口中 Part
    
    覆盖:
    
    getDisposition 在类中 MimeMessage
    
    返回:
    
    disposition of this part, or null if unknown
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    Part.ATTACHMENT, Part.INLINE, Part.getFileName()
  - setDisposition
```
public void setDisposition(String disposition)
                    throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Set the disposition in the "Content-Disposition" header field of this body part. If the disposition is null, any existing "Content-Disposition" header field is removed.
    
    指定者:
    
    setDisposition 在接口中 Part
    
    覆盖:
    
    setDisposition 在类中 MimeMessage
    
    参数:
    
    disposition - disposition of this part
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
    
    另请参阅:
    
    Part.ATTACHMENT, Part.INLINE, Part.setFileName(java.lang.String)
  - getEncoding
```
public String getEncoding()
                   throws MessagingException
```
    Get the Content-Transfer-Encoding.
    
    指定者:
    
    getEncoding 在接口中 MimePart
    
    覆盖:
    
    getEncoding 在类中 MimeMessage
    
    返回:
    
    content-transfer-encoding
    
    抛出:
    
    MessagingException - for failures
  - getContentID
```
public String getContentID()
                    throws MessagingException
```
    Get the Content-ID.
    
    指定者:
    
    getContentID 在接口中 MimePart
    
    覆盖:
    
    getContentID 在类中 MimeMessage
    
    返回:
    
    content-ID
    
    抛出:
    
    MessagingException - for failures
  - setContentID
```
public void setContentID(String cid)
                  throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Set the "Content-ID" header field of this Message. If the cid parameter is null, any existing "Content-ID" is removed.
    
    覆盖:
    
    setContentID 在类中 MimeMessage
    
    参数:
    
    cid - the content ID
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
  - getContentMD5
```
public String getContentMD5()
                     throws MessagingException
```
    Get the Content-MD5.
    
    指定者:
    
    getContentMD5 在接口中 MimePart
    
    覆盖:
    
    getContentMD5 在类中 MimeMessage
    
    返回:
    
    content-MD5
    
    抛出:
    
    MessagingException - for failures
  - setContentMD5
```
public void setContentMD5(String md5)
                   throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Set the "Content-MD5" header field of this Message.
    
    指定者:
    
    setContentMD5 在接口中 MimePart
    
    覆盖:
    
    setContentMD5 在类中 MimeMessage
    
    参数:
    
    md5 - the MD5 value
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
  - getDescription
```
public String getDescription()
                      throws MessagingException
```
    Get the decoded Content-Description.
    
    指定者:
    
    getDescription 在接口中 Part
    
    覆盖:
    
    getDescription 在类中 MimeMessage
    
    返回:
    
    content-description
    
    抛出:
    
    MessagingException - for failures
  - setDescription
```
public void setDescription(String description,
                           String charset)
                    throws MessagingException
```
    从类复制的说明: MimeMessage
    
    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.
    
    覆盖:
    
    setDescription 在类中 MimeMessage
    
    参数:
    
    description - Description
    
    charset - Charset for encoding
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - An UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.
  - getMessageID
```
public String getMessageID()
                    throws MessagingException
```
    Get the Message-ID.
    
    覆盖:
    
    getMessageID 在类中 MimeMessage
    
    返回:
    
    Message-ID
    
    抛出:
    
    MessagingException - if the retrieval of this field causes any exception.
    
    另请参阅:
    
    MessageIDTerm
  - getFileName
```
public String getFileName()
                   throws MessagingException
```
    Get the "filename" Disposition parameter. (Only available in IMAP4rev1). If thats not available, get the "name" ContentType parameter.
    
    指定者:
    
    getFileName 在接口中 Part
    
    覆盖:
    
    getFileName 在类中 MimeMessage
    
    返回:
    
    filename
    
    抛出:
    
    MessagingException - for failures
  - setFileName
```
public void setFileName(String filename)
                 throws MessagingException
```
    从类复制的说明: MimeMessage
    
    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.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.
    
    指定者:
    
    setFileName 在接口中 Part
    
    覆盖:
    
    setFileName 在类中 MimeMessage
    
    参数:
    
    filename - Filename to associate with this part
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
  - getContentStream
```
protected InputStream getContentStream()
                                throws MessagingException
```
    Get all the bytes for this message. Overrides getContentStream() in MimeMessage. This method is ultimately used by the DataHandler to obtain the input stream for this message.
    
    覆盖:
    
    getContentStream 在类中 MimeMessage
    
    返回:
    
    an InputStream containing the raw bytes
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeMessage.getContentStream()
  - getDataHandler
```
public DataHandler getDataHandler()
                           throws MessagingException
```
    Get the DataHandler object for this message.
    
    指定者:
    
    getDataHandler 在接口中 Part
    
    覆盖:
    
    getDataHandler 在类中 MimeMessage
    
    返回:
    
    DataHandler for the content
    
    抛出:
    
    MessagingException - for failures
  - setDataHandler
```
public void setDataHandler(DataHandler content)
                    throws MessagingException
```
    从类复制的说明: MimeMessage
    
    This method provides the mechanism to set this part's content. The given DataHandler object should wrap the actual content.
    
    指定者:
    
    setDataHandler 在接口中 Part
    
    覆盖:
    
    setDataHandler 在类中 MimeMessage
    
    参数:
    
    content - The DataHandler for the content.
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
  - getMimeStream
```
public InputStream getMimeStream()
                          throws MessagingException
```
    Return the MIME format stream corresponding to this message.
    
    指定者:
    
    getMimeStream 在接口中 ReadableMime
    
    返回:
    
    the MIME format stream
    
    抛出:
    
    MessagingException - for failures
    
    从以下版本开始:
    
    JavaMail 1.4.5
  - writeTo
```
public void writeTo(OutputStream os)
             throws IOException,
                    MessagingException
```
    Write out the bytes into the given OutputStream.
    
    指定者:
    
    writeTo 在接口中 Part
    
    覆盖:
    
    writeTo 在类中 MimeMessage
    
    参数:
    
    os - the stream to write to
    
    抛出:
    
    IOException - if an error occurs writing to the stream or if an error is generated by the javax.activation layer.
    
    MessagingException - for other failures
    
    另请参阅:
    
    DataHandler.writeTo(java.io.OutputStream)
  - getHeader
```
public String[] getHeader(String name)
                   throws MessagingException
```
    Get the named header.
    
    指定者:
    
    getHeader 在接口中 Part
    
    覆盖:
    
    getHeader 在类中 MimeMessage
    
    参数:
    
    name - name of header
    
    返回:
    
    array of headers
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeUtility
  - getHeader
```
public String getHeader(String name,
                        String delimiter)
                 throws MessagingException
```
    Get the named header.
    
    指定者:
    
    getHeader 在接口中 MimePart
    
    覆盖:
    
    getHeader 在类中 MimeMessage
    
    参数:
    
    name - the name of this header
    
    delimiter - separator between values
    
    返回:
    
    the value fields for all headers with this name
    
    抛出:
    
    MessagingException - for failures
  - setHeader
```
public void setHeader(String name,
                      String value)
               throws MessagingException
```
    从类复制的说明: MimeMessage
    
    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.
    
    指定者:
    
    setHeader 在接口中 Part
    
    覆盖:
    
    setHeader 在类中 MimeMessage
    
    参数:
    
    name - header name
    
    value - header value
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
    
    另请参阅:
    
    MimeUtility
  - addHeader
```
public void addHeader(String name,
                      String value)
               throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Add this value to the existing values for this header_name. Note that RFC 822 headers must contain only US-ASCII characters, so a header that contains non US-ASCII characters must have been encoded as per the rules of RFC 2047.
    
    指定者:
    
    addHeader 在接口中 Part
    
    覆盖:
    
    addHeader 在类中 MimeMessage
    
    参数:
    
    name - header name
    
    value - header value
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
    
    另请参阅:
    
    MimeUtility
  - removeHeader
```
public void removeHeader(String name)
                  throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Remove all headers with this name.
    
    指定者:
    
    removeHeader 在接口中 Part
    
    覆盖:
    
    removeHeader 在类中 MimeMessage
    
    参数:
    
    name - the name of this header
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
  - getAllHeaders
```
public Enumeration<Header> getAllHeaders()
                                  throws MessagingException
```
    Get all headers.
    
    指定者:
    
    getAllHeaders 在接口中 Part
    
    覆盖:
    
    getAllHeaders 在类中 MimeMessage
    
    返回:
    
    array of header objects
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeUtility
  - getMatchingHeaders
```
public Enumeration<Header> getMatchingHeaders(String[] names)
                                       throws MessagingException
```
    Get matching headers.
    
    指定者:
    
    getMatchingHeaders 在接口中 Part
    
    覆盖:
    
    getMatchingHeaders 在类中 MimeMessage
    
    参数:
    
    names - the headers to match
    
    返回:
    
    enumeration of Header objects
    
    抛出:
    
    MessagingException - for failures
  - getNonMatchingHeaders
```
public Enumeration<Header> getNonMatchingHeaders(String[] names)
                                          throws MessagingException
```
    Get non-matching headers.
    
    指定者:
    
    getNonMatchingHeaders 在接口中 Part
    
    覆盖:
    
    getNonMatchingHeaders 在类中 MimeMessage
    
    参数:
    
    names - the headers to not match
    
    返回:
    
    enumeration of Header objects
    
    抛出:
    
    MessagingException - for failures
  - addHeaderLine
```
public void addHeaderLine(String line)
                   throws MessagingException
```
    从类复制的说明: MimeMessage
    
    Add a raw RFC 822 header-line.
    
    指定者:
    
    addHeaderLine 在接口中 MimePart
    
    覆盖:
    
    addHeaderLine 在类中 MimeMessage
    
    参数:
    
    line - the line to add
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
  - getAllHeaderLines
```
public Enumeration<String> getAllHeaderLines()
                                      throws MessagingException
```
    Get all header-lines.
    
    指定者:
    
    getAllHeaderLines 在接口中 MimePart
    
    覆盖:
    
    getAllHeaderLines 在类中 MimeMessage
    
    返回:
    
    an Enumeration of Strings
    
    抛出:
    
    MessagingException - for failures
  - getMatchingHeaderLines
```
public Enumeration<String> getMatchingHeaderLines(String[] names)
                                           throws MessagingException
```
    Get all matching header-lines.
    
    指定者:
    
    getMatchingHeaderLines 在接口中 MimePart
    
    覆盖:
    
    getMatchingHeaderLines 在类中 MimeMessage
    
    参数:
    
    names - the headers to return
    
    返回:
    
    an Enumeration of Strings
    
    抛出:
    
    MessagingException - for failures
  - getNonMatchingHeaderLines
```
public Enumeration<String> getNonMatchingHeaderLines(String[] names)
                                              throws MessagingException
```
    Get all non-matching headerlines.
    
    指定者:
    
    getNonMatchingHeaderLines 在接口中 MimePart
    
    覆盖:
    
    getNonMatchingHeaderLines 在类中 MimeMessage
    
    参数:
    
    names - the headers to not return
    
    返回:
    
    an Enumeration of Strings
    
    抛出:
    
    MessagingException - for failures
  - getFlags
```
public Flags getFlags()
               throws MessagingException
```
    Get the Flags for this message.
    
    覆盖:
    
    getFlags 在类中 MimeMessage
    
    返回:
    
    Flags object containing the flags for this message
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    Flags
  - isSet
```
public boolean isSet(Flags.Flag flag)
              throws MessagingException
```
    Test if the given Flags are set in this message.
    
    覆盖:
    
    isSet 在类中 MimeMessage
    
    参数:
    
    flag - the flag
    
    返回:
    
    value of the specified flag for this message
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    Flags.Flag, Flags.Flag.ANSWERED, Flags.Flag.DELETED, Flags.Flag.DRAFT, Flags.Flag.FLAGGED, Flags.Flag.RECENT, Flags.Flag.SEEN
  - setFlags
```
public void setFlags(Flags flag,
                     boolean set)
              throws MessagingException
```
    Set/Unset the given flags in this message.
    
    覆盖:
    
    setFlags 在类中 MimeMessage
    
    参数:
    
    flag - Flags object containing the flags to be set
    
    set - the value to be set
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
    
    另请参阅:
    
    MessageChangedEvent
  - setPeek
```
public void setPeek(boolean peek)
```
    Set whether or not to use the PEEK variant of FETCH when fetching message content. This overrides the default value from the "mail.imap.peek" property.
    
    参数:
    
    peek - the peek flag
    
    从以下版本开始:
    
    JavaMail 1.3.3
  - getPeek
```
public boolean getPeek()
```
    Get whether or not to use the PEEK variant of FETCH when fetching message content.
    
    返回:
    
    the peek flag
    
    从以下版本开始:
    
    JavaMail 1.3.3
  - invalidateHeaders
```
public void invalidateHeaders()
```
    Invalidate cached header and envelope information for this message. Subsequent accesses of this information will cause it to be fetched from the server.
    
    从以下版本开始:
    
    JavaMail 1.3.3
  - handleFetchItem
```
protected boolean handleFetchItem(Item item,
                                  String[] hdrs,
                                  boolean allHeaders)
                           throws MessagingException
```
    Apply the data in the FETCH item to this message. ASSERT: Must hold the messageCacheLock.
    
    参数:
    
    item - the fetch item
    
    hdrs - the headers we're asking for
    
    allHeaders - load all headers?
    
    返回:
    
    did we handle this fetch item?
    
    抛出:
    
    MessagingException - for failures
    
    从以下版本开始:
    
    JavaMail 1.4.6
  - handleExtensionFetchItems
```
protected void handleExtensionFetchItems(Map<String,Object> extensionItems)
```
    Apply the data in the extension FETCH items to this message. This method adds all the items to the items map. Subclasses may override this method to call super and then also copy the data to a more convenient form. ASSERT: Must hold the messageCacheLock.
    
    参数:
    
    extensionItems - the Map to add fetch items to
    
    从以下版本开始:
    
    JavaMail 1.4.6
  - fetchItem
```
protected Object fetchItem(FetchItem fitem)
                    throws MessagingException
```
    Fetch an individual item for the current message. Note that handleExtensionFetchItems will have been called to store this item in the message before this method returns.
    
    参数:
    
    fitem - the FetchItem
    
    返回:
    
    the data associated with the FetchItem
    
    抛出:
    
    MessagingException - for failures
    
    从以下版本开始:
    
    JavaMail 1.4.6
  - getItem
```
public Object getItem(FetchItem fitem)
               throws MessagingException
```
    Return the data associated with the FetchItem. If the data hasn't been fetched, call the fetchItem method to fetch it. Returns null if there is no data for the FetchItem.
    
    参数:
    
    fitem - the FetchItem
    
    返回:
    
    the data associated with the FetchItem
    
    抛出:
    
    MessagingException - for failures
    
    从以下版本开始:
    
    JavaMail 1.4.6

类 IMAPMessage

嵌套类概要

从类继承的嵌套类/接口 javax.mail.internet.MimeMessage

字段概要

从类继承的字段 javax.mail.internet.MimeMessage

从类继承的字段 javax.mail.Message

从接口继承的字段 javax.mail.Part

构造器概要

方法概要

从类继承的方法 javax.mail.internet.MimeMessage

从类继承的方法 javax.mail.Message

从类继承的方法 java.lang.Object

字段详细资料

bs

envelope

items

sectionId

构造器详细资料

IMAPMessage

IMAPMessage

方法详细资料

getProtocol

isREV1

getMessageCacheLock

getSequenceNumber

setMessageNumber

getUID

setUID

getModSeq

setExpunged

checkExpunged

forceCheckExpunged

getFetchBlockSize

ignoreBodyStructureSize

getFrom

setFrom

addFrom

getSender

setSender

getRecipients

setRecipients

addRecipients

getReplyTo

setReplyTo

getSubject

setSubject

getSentDate

setSentDate

getReceivedDate

getSize

getSizeLong

getLineCount

getContentLanguage

setContentLanguage

getInReplyTo

getContentType

getDisposition

setDisposition

getEncoding

getContentID

setContentID

getContentMD5

setContentMD5

getDescription

setDescription

getMessageID

getFileName

setFileName

getContentStream

getDataHandler

setDataHandler

getMimeStream

writeTo

getHeader

getHeader

setHeader

addHeader

removeHeader

getAllHeaders

getMatchingHeaders