com.sun.mail.imap
类 IMAPBodyPart

java.lang.Object
  javax.mail.BodyPart
      javax.mail.internet.MimeBodyPart
          com.sun.mail.imap.IMAPBodyPart

所有已实现的接口：

MimePart, Part

public class IMAPBodyPart
extends MimeBodyPart

This class

版本：

1.4, 97/12/09

作者：

John Mani

字段摘要

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

content, contentStream, dh, headers

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

parent

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

ATTACHMENT, INLINE

构造方法摘要

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	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.
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 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 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	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.
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.
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 "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, 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.

覆盖：

类 MimeBodyPart 中的 updateHeaders

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.

指定者：

接口 Part 中的 getSize

覆盖：

类 MimeBodyPart 中的 getSize

返回：

size in bytes, or -1 if not known

抛出：

MessagingException

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.

指定者：

接口 Part 中的 getLineCount

覆盖：

类 MimeBodyPart 中的 getLineCount

返回：

number of lines, or -1 if not known

抛出：

MessagingException

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.

指定者：

接口 Part 中的 getContentType

覆盖：

类 MimeBodyPart 中的 getContentType

返回：

Content-Type of this body part

抛出：

MessagingException

另请参见：

DataHandler

getDisposition

public String getDisposition()
                      throws MessagingException

从类 MimeBodyPart 复制的描述

Returns the value of the "Content-Disposition" header field. This represents the disposition of this part. The disposition describes how the part should be presented to the user.

If the Content-Disposition field is unavailable, null is returned.

This implementation uses getHeader(name) to obtain the requisite header field.

指定者：

接口 Part 中的 getDisposition

覆盖：

类 MimeBodyPart 中的 getDisposition

返回：

disposition of this part, or null if unknown

抛出：

MessagingException

另请参见：

MimeBodyPart.headers

setDisposition

public void setDisposition(String disposition)
                    throws MessagingException

从类 MimeBodyPart 复制的描述

Set the "Content-Disposition" header field of this body part. If the disposition is null, any existing "Content-Disposition" header field is removed.

指定者：

接口 Part 中的 setDisposition

覆盖：

类 MimeBodyPart 中的 setDisposition

参数：

disposition - disposition of this part

抛出：

MessagingException

IllegalWriteException - if the underlying implementation does not support modification of this header

另请参见：

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.

指定者：

接口 MimePart 中的 getEncoding

覆盖：

类 MimeBodyPart 中的 getEncoding

返回：

content-transfer-encoding

抛出：

MessagingException

另请参见：

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.

指定者：

接口 MimePart 中的 getContentID

覆盖：

类 MimeBodyPart 中的 getContentID

返回：

content-ID

抛出：

MessagingException

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.

指定者：

接口 MimePart 中的 getContentMD5

覆盖：

类 MimeBodyPart 中的 getContentMD5

返回：

content-MD5

抛出：

MessagingException

setContentMD5

public void setContentMD5(String md5)
                   throws MessagingException

从类 MimeBodyPart 复制的描述

Set the "Content-MD5" header field of this body part.

指定者：

接口 MimePart 中的 setContentMD5

覆盖：

类 MimeBodyPart 中的 setContentMD5

参数：

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.

指定者：

接口 Part 中的 getDescription

覆盖：

类 MimeBodyPart 中的 getDescription

返回：

content description

抛出：

MessagingException

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.

覆盖：

类 MimeBodyPart 中的 setDescription

参数：

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.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 中的 getFileName

覆盖：

类 MimeBodyPart 中的 getFileName

返回：

filename

抛出：

MessagingException

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.

指定者：

接口 Part 中的 setFileName

覆盖：

类 MimeBodyPart 中的 setFileName

参数：

filename - Filename to associate with this part

抛出：

IllegalWriteException - if the underlying implementation does not support modification of this header

MessagingException

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.

覆盖：

类 MimeBodyPart 中的 getContentStream

抛出：

MessagingException

另请参见：

MimeBodyPart.content, MimeMessage.getContentStream()

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.

指定者：

接口 Part 中的 getDataHandler

覆盖：

类 MimeBodyPart 中的 getDataHandler

返回：

DataHandler for the content

抛出：

MessagingException

另请参见：

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.

指定者：

接口 Part 中的 setDataHandler

覆盖：

类 MimeBodyPart 中的 setDataHandler

参数：

content - The DataHandler for the content

抛出：

MessagingException

IllegalWriteException - if the underlying implementation does not support modification of existing values

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.

指定者：

接口 Part 中的 setContent

覆盖：

类 MimeBodyPart 中的 setContent

参数：

o - the content object

type - Mime type of the object

抛出：

IllegalWriteException - if the underlying implementation does not support modification of existing values

MessagingException

setContent

public void setContent(Multipart mp)
                throws MessagingException

从类 MimeBodyPart 复制的描述

This method sets the body part's content to a Multipart object.

指定者：

接口 Part 中的 setContent

覆盖：

类 MimeBodyPart 中的 setContent

参数：

mp - The multipart object that is the Message's content

抛出：

IllegalWriteException - if the underlying implementation does not support modification of existing values

MessagingException

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.

指定者：

接口 Part 中的 getHeader

覆盖：

类 MimeBodyPart 中的 getHeader

参数：

name - name of header

返回：

array of headers

抛出：

MessagingException

另请参见：

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.

指定者：

接口 Part 中的 setHeader

覆盖：

类 MimeBodyPart 中的 setHeader

参数：

name - header name

value - header value

抛出：

MessagingException

IllegalWriteException - if the underlying implementation does not support modification of existing values

另请参见：

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.

指定者：

接口 Part 中的 addHeader

覆盖：

类 MimeBodyPart 中的 addHeader

参数：

name - header name

value - header value

抛出：

MessagingException

IllegalWriteException - if the underlying implementation does not support modification of existing values

另请参见：

MimeUtility

removeHeader

public void removeHeader(String name)
                  throws MessagingException

从类 MimeBodyPart 复制的描述

Remove all headers with this name.

指定者：

接口 Part 中的 removeHeader

覆盖：

类 MimeBodyPart 中的 removeHeader

参数：

name - the name of this header

抛出：

MessagingException

IllegalWriteException - if the underlying implementation does not support modification of existing values

getAllHeaders

public Enumeration getAllHeaders()
                          throws MessagingException

从类 MimeBodyPart 复制的描述

Return all the headers from this Message as an Enumeration of Header objects.

指定者：

接口 Part 中的 getAllHeaders

覆盖：

类 MimeBodyPart 中的 getAllHeaders

返回：

enumeration of Header objects

抛出：

MessagingException

getMatchingHeaders

public Enumeration getMatchingHeaders(String[] names)
                               throws MessagingException

从类 MimeBodyPart 复制的描述

Return matching headers from this Message as an Enumeration of Header objects.

指定者：

接口 Part 中的 getMatchingHeaders

覆盖：

类 MimeBodyPart 中的 getMatchingHeaders

返回：

enumeration of Header objects

抛出：

MessagingException

getNonMatchingHeaders

public Enumeration getNonMatchingHeaders(String[] names)
                                  throws MessagingException

从类 MimeBodyPart 复制的描述

Return non-matching headers from this Message as an Enumeration of Header objects.

指定者：

接口 Part 中的 getNonMatchingHeaders

覆盖：

类 MimeBodyPart 中的 getNonMatchingHeaders

返回：

enumeration of Header objects

抛出：

MessagingException

addHeaderLine

public void addHeaderLine(String line)
                   throws MessagingException

从类 MimeBodyPart 复制的描述

Add a header line to this body part

指定者：

接口 MimePart 中的 addHeaderLine

覆盖：

类 MimeBodyPart 中的 addHeaderLine

抛出：

IllegalWriteException - if the underlying implementation does not support modification

MessagingException

getAllHeaderLines

public Enumeration 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.

指定者：

接口 MimePart 中的 getAllHeaderLines

覆盖：

类 MimeBodyPart 中的 getAllHeaderLines

抛出：

MessagingException

getMatchingHeaderLines

public Enumeration 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.

指定者：

接口 MimePart 中的 getMatchingHeaderLines

覆盖：

类 MimeBodyPart 中的 getMatchingHeaderLines

抛出：

MessagingException

getNonMatchingHeaderLines

public Enumeration 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.

指定者：

接口 MimePart 中的 getNonMatchingHeaderLines

覆盖：

类 MimeBodyPart 中的 getNonMatchingHeaderLines

抛出：

MessagingException