IMAPBodyPart (XJavaMail API 0.1.6 API)

java.lang.Object
- javax.mail.BodyPart
- - javax.mail.internet.MimeBodyPart
  - - net.iotgw.mail.imap.IMAPBodyPart

所有已实现的接口:

MimePart, Part, ReadableMime
```
public class IMAPBodyPart
extends MimeBodyPart
implements ReadableMime
```
An IMAP body part.

作者:

John Mani, Bill Shannon

字段概要
- 从类继承的字段 javax.mail.internet.MimeBodyPart
  cachedContent, content, contentStream, dh, headers
- 从类继承的字段 javax.mail.BodyPart
  parent
- 从接口继承的字段 javax.mail.Part
  ATTACHMENT, INLINE

构造器概要

构造器
限定符构造器和说明

protected IMAPBodyPart(BODYSTRUCTURE bs, String sid, IMAPMessage message)

构造器
限定符	构造器和说明
`protected`	`IMAPBodyPart(BODYSTRUCTURE bs, String sid, IMAPMessage message)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addHeader(String name, String value)` Add this value to the existing values for this header_name.
`void`	`addHeaderLine(String line)` Add a header line to this body part
`Enumeration<String>`	`getAllHeaderLines()` Get all header lines as an Enumeration of Strings.
`Enumeration<Header>`	`getAllHeaders()` Return all the headers from this Message as an Enumeration of Header objects.
`String`	`getContentID()` Returns the value of the "Content-ID" header field.
`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 body part's content.
`String`	`getDescription()` Returns the "Content-Description" header field of this body part.
`String`	`getDisposition()` Returns the disposition from 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 body part.
`String[]`	`getHeader(String name)` Get all the headers for this header_name.
`int`	`getLineCount()` Return the number of lines for the content of this Part.
`Enumeration<String>`	`getMatchingHeaderLines(String[] names)` Get matching header lines as an Enumeration of Strings.
`Enumeration<Header>`	`getMatchingHeaders(String[] names)` Return matching headers from this Message as an Enumeration of Header objects.
`InputStream`	`getMimeStream()` Return the MIME format stream corresponding to this message part.
`Enumeration<String>`	`getNonMatchingHeaderLines(String[] names)` Get non-matching header lines as an Enumeration of Strings.
`Enumeration<Header>`	`getNonMatchingHeaders(String[] names)` Return non-matching headers from this Message as an Enumeration of Header objects.
`int`	`getSize()` Return the size of the content of this body part in bytes.
`void`	`removeHeader(String name)` Remove all headers with this name.
`void`	`setContent(Multipart mp)` This method sets the body part's content to a Multipart object.
`void`	`setContent(Object o, String type)` A convenience method for setting this body part's content.
`void`	`setContentMD5(String md5)` Set the "Content-MD5" header field of this body part.
`void`	`setDataHandler(DataHandler content)` This method provides the mechanism to set this body part's content.
`void`	`setDescription(String description, String charset)` Set the "Content-Description" header field for this body part.
`void`	`setDisposition(String disposition)` Set the disposition in the "Content-Disposition" header field of this body part.
`void`	`setFileName(String filename)` Set the filename associated with this body part, if possible.
`void`	`setHeader(String name, String value)` Set the value for this header_name.
`protected void`	`updateHeaders()` Examine the content of this body part and update the appropriate MIME headers.

从类继承的方法 javax.mail.internet.MimeBodyPart
attachFile, attachFile, attachFile, attachFile, getContent, getContentLanguage, getHeader, getInputStream, getRawInputStream, isMimeType, saveFile, saveFile, setContentID, setContentLanguage, setDescription, setText, setText, setText, writeTo

从类继承的方法 javax.mail.BodyPart
getParent

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

- 构造器详细资料
  - IMAPBodyPart
```
protected IMAPBodyPart(BODYSTRUCTURE bs,
                       String sid,
                       IMAPMessage message)
```
- 方法详细资料
  - updateHeaders
```
protected void updateHeaders()
```
    从类复制的说明: MimeBodyPart
    
    Examine the content of this body part and update the appropriate MIME headers. Typical headers that get set here are Content-Type and Content-Transfer-Encoding. Headers might need to be updated in two cases:
    - A message being crafted by a mail application will certainly need to activate this method at some point to fill up its internal headers.
    - A message read in from a Store will have obtained all its headers from the store, and so doesn't need this. However, if this message is editable and if any edits have been made to either the content or message structure, we might need to resync our headers.
    In both cases this method is typically called by the Message.saveChanges method.
    If the MimeBodyPart.cachedContent field is not null (that is, it references a Multipart or Message object), then that object is used to set a new DataHandler, any stream data used to create this object is discarded, and the MimeBodyPart.cachedContent field is cleared.
    
    覆盖:
    
    updateHeaders 在类中 MimeBodyPart
  - getSize
```
public int getSize()
            throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Return the size of the content of this body part 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.
    
    指定者:
    
    getSize 在接口中 Part
    
    覆盖:
    
    getSize 在类中 MimeBodyPart
    
    返回:
    
    size in bytes, or -1 if not known
    
    抛出:
    
    MessagingException - for failures
  - getLineCount
```
public int getLineCount()
                 throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Return the number of lines for the content of this Part. 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.
    
    指定者:
    
    getLineCount 在接口中 Part
    
    覆盖:
    
    getLineCount 在类中 MimeBodyPart
    
    返回:
    
    number of lines, or -1 if not known
    
    抛出:
    
    MessagingException - for failures
  - getContentType
```
public String getContentType()
                      throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Returns the value of the RFC 822 "Content-Type" header field. This represents the content type of the content of this body part. This value must not be null. If this field is unavailable, "text/plain" should be returned.
    This implementation uses getHeader(name) to obtain the requisite header field.
    
    指定者:
    
    getContentType 在接口中 Part
    
    覆盖:
    
    getContentType 在类中 MimeBodyPart
    
    返回:
    
    Content-Type of this body part
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    DataHandler
  - getDisposition
```
public String getDisposition()
                      throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Returns the disposition from 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 getHeader(name) to obtain the requisite header field.
    
    指定者:
    
    getDisposition 在接口中 Part
    
    覆盖:
    
    getDisposition 在类中 MimeBodyPart
    
    返回:
    
    disposition of this part, or null if unknown
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeBodyPart.headers
  - setDisposition
```
public void setDisposition(String disposition)
                    throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    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 在类中 MimeBodyPart
    
    参数:
    
    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
```
    从类复制的说明: MimeBodyPart
    
    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 getHeader(name) to obtain the requisite header field.
    
    指定者:
    
    getEncoding 在接口中 MimePart
    
    覆盖:
    
    getEncoding 在类中 MimeBodyPart
    
    返回:
    
    content-transfer-encoding
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeBodyPart.headers
  - getContentID
```
public String getContentID()
                    throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Returns the value of the "Content-ID" header field. Returns null if the field is unavailable or its value is absent.
    This implementation uses getHeader(name) to obtain the requisite header field.
    
    指定者:
    
    getContentID 在接口中 MimePart
    
    覆盖:
    
    getContentID 在类中 MimeBodyPart
    
    返回:
    
    content-ID
    
    抛出:
    
    MessagingException - for failures
  - getContentMD5
```
public String getContentMD5()
                     throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Return the value of the "Content-MD5" header field. Returns null if this field is unavailable or its value is absent.
    This implementation uses getHeader(name) to obtain the requisite header field.
    
    指定者:
    
    getContentMD5 在接口中 MimePart
    
    覆盖:
    
    getContentMD5 在类中 MimeBodyPart
    
    返回:
    
    content-MD5
    
    抛出:
    
    MessagingException - for failures
  - setContentMD5
```
public void setContentMD5(String md5)
                   throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Set the "Content-MD5" header field of this body part.
    
    指定者:
    
    setContentMD5 在接口中 MimePart
    
    覆盖:
    
    setContentMD5 在类中 MimeBodyPart
    
    参数:
    
    md5 - the MD5 value
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException
  - getDescription
```
public String getDescription()
                      throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Returns the "Content-Description" header field of this body part. 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 getHeader(name) to obtain the requisite header field.
    
    指定者:
    
    getDescription 在接口中 Part
    
    覆盖:
    
    getDescription 在类中 MimeBodyPart
    
    返回:
    
    content description
    
    抛出:
    
    MessagingException - for failures
  - setDescription
```
public void setDescription(String description,
                           String charset)
                    throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Set the "Content-Description" header field for this body part. 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 在类中 MimeBodyPart
    
    参数:
    
    description - Description
    
    charset - Charset for encoding
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - otherwise; an UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.
  - getFileName
```
public String getFileName()
                   throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Get the filename associated with this body part.
    Returns the value of the "filename" parameter from the "Content-Disposition" header field of this body part. If its not available, returns the value of the "name" parameter from the "Content-Type" header field of this body part. Returns null if both are absent.
    If the mail.mime.decodefilename 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.
    
    指定者:
    
    getFileName 在接口中 Part
    
    覆盖:
    
    getFileName 在类中 MimeBodyPart
    
    返回:
    
    filename
    
    抛出:
    
    MessagingException - for failures
  - setFileName
```
public void setFileName(String filename)
                 throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Set the filename associated with this body part, if possible.
    Sets the "filename" parameter of the "Content-Disposition" header field of this body part. For compatibility with older mailers, the "name" parameter of the "Content-Type" header is also set.
    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 在类中 MimeBodyPart
    
    参数:
    
    filename - the file name
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification
    
    MessagingException - for other failures
  - getContentStream
```
protected InputStream getContentStream()
                                throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Produce the raw bytes of the content. This method is used when creating a DataHandler object for the content. Subclasses that can provide a separate input stream for just the Part content might want to override this method.
    
    覆盖:
    
    getContentStream 在类中 MimeBodyPart
    
    返回:
    
    an InputStream containing the raw bytes
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeBodyPart.content, MimeMessage.getContentStream()
  - getMimeStream
```
public InputStream getMimeStream()
                          throws MessagingException
```
    Return the MIME format stream corresponding to this message part.
    
    指定者:
    
    getMimeStream 在接口中 ReadableMime
    
    返回:
    
    the MIME format stream
    
    抛出:
    
    MessagingException - for failures
    
    从以下版本开始:
    
    JavaMail 1.4.5
  - getDataHandler
```
public DataHandler getDataHandler()
                           throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Return a DataHandler for this body part's content.
    The implementation provided here works just like the the implementation in MimeMessage.
    
    指定者:
    
    getDataHandler 在接口中 Part
    
    覆盖:
    
    getDataHandler 在类中 MimeBodyPart
    
    返回:
    
    DataHandler for the content
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeMessage.getDataHandler()
  - setDataHandler
```
public void setDataHandler(DataHandler content)
                    throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    This method provides the mechanism to set this body part's content. The given DataHandler object should wrap the actual content.
    
    指定者:
    
    setDataHandler 在接口中 Part
    
    覆盖:
    
    setDataHandler 在类中 MimeBodyPart
    
    参数:
    
    content - The DataHandler for the content
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
  - setContent
```
public void setContent(Object o,
                       String type)
                throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    A convenience method for setting this body part'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. That is, 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.
    
    指定者:
    
    setContent 在接口中 Part
    
    覆盖:
    
    setContent 在类中 MimeBodyPart
    
    参数:
    
    o - the content object
    
    type - Mime type of the object
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
  - setContent
```
public void setContent(Multipart mp)
                throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    This method sets the body part's content to a Multipart object.
    
    指定者:
    
    setContent 在接口中 Part
    
    覆盖:
    
    setContent 在类中 MimeBodyPart
    
    参数:
    
    mp - The multipart object that is the Message's content
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
  - getHeader
```
public String[] getHeader(String name)
                   throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    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.
    
    指定者:
    
    getHeader 在接口中 Part
    
    覆盖:
    
    getHeader 在类中 MimeBodyPart
    
    参数:
    
    name - name of header
    
    返回:
    
    array of headers
    
    抛出:
    
    MessagingException - for failures
    
    另请参阅:
    
    MimeUtility
  - setHeader
```
public void setHeader(String name,
                      String value)
               throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    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 be encoded as per the rules of RFC 2047.
    
    指定者:
    
    setHeader 在接口中 Part
    
    覆盖:
    
    setHeader 在类中 MimeBodyPart
    
    参数:
    
    name - header name
    
    value - header value
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
    
    另请参阅:
    
    MimeUtility
  - addHeader
```
public void addHeader(String name,
                      String value)
               throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    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 be encoded as per the rules of RFC 2047.
    
    指定者:
    
    addHeader 在接口中 Part
    
    覆盖:
    
    addHeader 在类中 MimeBodyPart
    
    参数:
    
    name - header name
    
    value - header value
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
    
    另请参阅:
    
    MimeUtility
  - removeHeader
```
public void removeHeader(String name)
                  throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Remove all headers with this name.
    
    指定者:
    
    removeHeader 在接口中 Part
    
    覆盖:
    
    removeHeader 在类中 MimeBodyPart
    
    参数:
    
    name - the name of this header
    
    抛出:
    
    IllegalWriteException - if the underlying implementation does not support modification of existing values
    
    MessagingException - for other failures
  - getAllHeaders
```
public Enumeration<Header> getAllHeaders()
                                  throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Return all the headers from this Message as an Enumeration of Header objects.
    
    指定者:
    
    getAllHeaders 在接口中 Part
    
    覆盖:
    
    getAllHeaders 在类中 MimeBodyPart
    
    返回:
    
    enumeration of Header objects
    
    抛出:
    
    MessagingException - for failures
  - getMatchingHeaders
```
public Enumeration<Header> getMatchingHeaders(String[] names)
                                       throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Return matching headers from this Message as an Enumeration of Header objects.
    
    指定者:
    
    getMatchingHeaders 在接口中 Part
    
    覆盖:
    
    getMatchingHeaders 在类中 MimeBodyPart
    
    参数:
    
    names - the headers to match
    
    返回:
    
    enumeration of Header objects
    
    抛出:
    
    MessagingException - for failures
  - getNonMatchingHeaders
```
public Enumeration<Header> getNonMatchingHeaders(String[] names)
                                          throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Return non-matching headers from this Message as an Enumeration of Header objects.
    
    指定者:
    
    getNonMatchingHeaders 在接口中 Part
    
    覆盖:
    
    getNonMatchingHeaders 在类中 MimeBodyPart
    
    参数:
    
    names - the headers to not match
    
    返回:
    
    enumeration of Header objects
    
    抛出:
    
    MessagingException - for failures
  - addHeaderLine
```
public void addHeaderLine(String line)
                   throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Add a header line to this body part
    
    指定者:
    
    addHeaderLine 在接口中 MimePart
    
    覆盖:
    
    addHeaderLine 在类中 MimeBodyPart
    
    参数:
    
    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
```
    从类复制的说明: MimeBodyPart
    
    Get all header lines as an Enumeration of Strings. A Header line is a raw RFC 822 header line, containing both the "name" and "value" field.
    
    指定者:
    
    getAllHeaderLines 在接口中 MimePart
    
    覆盖:
    
    getAllHeaderLines 在类中 MimeBodyPart
    
    返回:
    
    an Enumeration of Strings
    
    抛出:
    
    MessagingException - for failures
  - getMatchingHeaderLines
```
public Enumeration<String> getMatchingHeaderLines(String[] names)
                                           throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    Get 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.
    
    指定者:
    
    getMatchingHeaderLines 在接口中 MimePart
    
    覆盖:
    
    getMatchingHeaderLines 在类中 MimeBodyPart
    
    参数:
    
    names - the headers to return
    
    返回:
    
    an Enumeration of Strings
    
    抛出:
    
    MessagingException - for failures
  - getNonMatchingHeaderLines
```
public Enumeration<String> getNonMatchingHeaderLines(String[] names)
                                              throws MessagingException
```
    从类复制的说明: MimeBodyPart
    
    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.
    
    指定者:
    
    getNonMatchingHeaderLines 在接口中 MimePart
    
    覆盖:
    
    getNonMatchingHeaderLines 在类中 MimeBodyPart
    
    参数:
    
    names - the headers to not return
    
    返回:
    
    an Enumeration of Strings
    
    抛出:
    
    MessagingException - for failures

类 IMAPBodyPart

字段概要

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

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

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

构造器概要

方法概要

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

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

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

构造器详细资料

IMAPBodyPart

方法详细资料

updateHeaders

getSize

getLineCount

getContentType

getDisposition

setDisposition

getEncoding

getContentID

getContentMD5

setContentMD5

getDescription

setDescription

getFileName

setFileName

getContentStream

getMimeStream

getDataHandler

setDataHandler

setContent

setContent

getHeader

setHeader

addHeader

removeHeader

getAllHeaders

getMatchingHeaders

getNonMatchingHeaders

addHeaderLine

getAllHeaderLines

getMatchingHeaderLines

getNonMatchingHeaderLines