com.sun.mail.imap
Class IMAPBodyPart

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

All Implemented Interfaces:

javax.mail.internet.MimePart, javax.mail.Part

public class IMAPBodyPart
extends javax.mail.internet.MimeBodyPart

An IMAP body part.

Field Summary

Fields inherited from class javax.mail.internet.MimeBodyPart

content, contentStream, dh, headers

Fields inherited from class javax.mail.BodyPart

parent

Fields inherited from interface javax.mail.Part

ATTACHMENT, INLINE

Constructor Summary

protected

IMAPBodyPart(BODYSTRUCTURE bs, java.lang.String sid, IMAPMessage message)

Method Summary

void	addHeader(java.lang.String name, java.lang.String value) Add this value to the existing values for this header_name.
void	addHeaderLine(java.lang.String line) Add a header line to this body part
java.util.Enumeration	getAllHeaderLines() Get all header lines as an Enumeration of Strings.
java.util.Enumeration	getAllHeaders() Return all the headers from this Message as an Enumeration of Header objects.
java.lang.String	getContentID() Returns the value of the "Content-ID" header field.
java.lang.String	getContentMD5() Return the value of the "Content-MD5" header field.
protected java.io.InputStream	getContentStream() Produce the raw bytes of the content.
java.lang.String	getContentType() Returns the value of the RFC 822 "Content-Type" header field.
javax.activation.DataHandler	getDataHandler() Return a DataHandler for this body part's content.
java.lang.String	getDescription() Returns the "Content-Description" header field of this body part.
java.lang.String	getDisposition() Returns the value of the "Content-Disposition" header field.
java.lang.String	getEncoding() Returns the content transfer encoding from the "Content-Transfer-Encoding" header field.
java.lang.String	getFileName() Get the filename associated with this body part.
java.lang.String[]	getHeader(java.lang.String name) Get all the headers for this header_name.
int	getLineCount() Return the number of lines for the content of this Part.
java.util.Enumeration	getMatchingHeaderLines(java.lang.String[] names) Get matching header lines as an Enumeration of Strings.
java.util.Enumeration	getMatchingHeaders(java.lang.String[] names) Return matching headers from this Message as an Enumeration of Header objects.
java.util.Enumeration	getNonMatchingHeaderLines(java.lang.String[] names) Get non-matching header lines as an Enumeration of Strings.
java.util.Enumeration	getNonMatchingHeaders(java.lang.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(java.lang.String name) Remove all headers with this name.
void	setContent(javax.mail.Multipart mp) This method sets the body part's content to a Multipart object.
void	setContent(java.lang.Object o, java.lang.String type) A convenience method for setting this body part's content.
void	setContentMD5(java.lang.String md5) Set the "Content-MD5" header field of this body part.
void	setDataHandler(javax.activation.DataHandler content) This method provides the mechanism to set this body part's content.
void	setDescription(java.lang.String description, java.lang.String charset) Set the "Content-Description" header field for this body part.
void	setDisposition(java.lang.String disposition) Set the "Content-Disposition" header field of this body part.
void	setFileName(java.lang.String filename) Set the filename associated with this body part, if possible.
void	setHeader(java.lang.String name, java.lang.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.

Methods inherited from class javax.mail.internet.MimeBodyPart

attachFile, attachFile, getContent, getContentLanguage, getHeader, getInputStream, getRawInputStream, isMimeType, saveFile, saveFile, setContentID, setContentLanguage, setDescription, setText, setText, setText, writeTo

Methods inherited from class javax.mail.BodyPart

getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IMAPBodyPart

protected IMAPBodyPart(BODYSTRUCTURE bs,
                       java.lang.String sid,
                       IMAPMessage message)

Method Detail

updateHeaders

protected void updateHeaders()

Description copied from class: javax.mail.internet.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.

Overrides:

updateHeaders in class javax.mail.internet.MimeBodyPart

getSize

public int getSize()
            throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getSize in interface javax.mail.Part

Overrides:

getSize in class javax.mail.internet.MimeBodyPart

Returns:

size in bytes, or -1 if not known

Throws:

javax.mail.MessagingException

getLineCount

public int getLineCount()
                 throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getLineCount in interface javax.mail.Part

Overrides:

getLineCount in class javax.mail.internet.MimeBodyPart

Returns:

number of lines, or -1 if not known

Throws:

javax.mail.MessagingException

getContentType

public java.lang.String getContentType()
                                throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getContentType in interface javax.mail.Part

Overrides:

getContentType in class javax.mail.internet.MimeBodyPart

Returns:

Content-Type of this body part

Throws:

javax.mail.MessagingException

See Also:

DataHandler

getDisposition

public java.lang.String getDisposition()
                                throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getDisposition in interface javax.mail.Part

Overrides:

getDisposition in class javax.mail.internet.MimeBodyPart

Returns:

disposition of this part, or null if unknown

Throws:

javax.mail.MessagingException

See Also:

MimeBodyPart.headers

setDisposition

public void setDisposition(java.lang.String disposition)
                    throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.MimeBodyPart

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

Specified by:

setDisposition in interface javax.mail.Part

Overrides:

setDisposition in class javax.mail.internet.MimeBodyPart

Parameters:

disposition - disposition of this part

Throws:

javax.mail.MessagingException

See Also:

Part.ATTACHMENT, Part.INLINE, Part.setFileName(java.lang.String)

getEncoding

public java.lang.String getEncoding()
                             throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getEncoding in interface javax.mail.internet.MimePart

Overrides:

getEncoding in class javax.mail.internet.MimeBodyPart

Returns:

content-transfer-encoding

Throws:

javax.mail.MessagingException

See Also:

MimeBodyPart.headers

getContentID

public java.lang.String getContentID()
                              throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getContentID in interface javax.mail.internet.MimePart

Overrides:

getContentID in class javax.mail.internet.MimeBodyPart

Returns:

content-ID

Throws:

javax.mail.MessagingException

getContentMD5

public java.lang.String getContentMD5()
                               throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getContentMD5 in interface javax.mail.internet.MimePart

Overrides:

getContentMD5 in class javax.mail.internet.MimeBodyPart

Returns:

content-MD5

Throws:

javax.mail.MessagingException

setContentMD5

public void setContentMD5(java.lang.String md5)
                   throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.MimeBodyPart

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

Specified by:

setContentMD5 in interface javax.mail.internet.MimePart

Overrides:

setContentMD5 in class javax.mail.internet.MimeBodyPart

Parameters:

md5 - the MD5 value

Throws:

javax.mail.IllegalWriteException - if the underlying implementation does not support modification

javax.mail.MessagingException

getDescription

public java.lang.String getDescription()
                                throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getDescription in interface javax.mail.Part

Overrides:

getDescription in class javax.mail.internet.MimeBodyPart

Returns:

content description

Throws:

javax.mail.MessagingException

setDescription

public void setDescription(java.lang.String description,
                           java.lang.String charset)
                    throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Overrides:

setDescription in class javax.mail.internet.MimeBodyPart

Parameters:

description - Description

charset - Charset for encoding

Throws:

javax.mail.IllegalWriteException - if the underlying implementation does not support modification

javax.mail.MessagingException - otherwise; an UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.

getFileName

public java.lang.String getFileName()
                             throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getFileName in interface javax.mail.Part

Overrides:

getFileName in class javax.mail.internet.MimeBodyPart

Returns:

filename

Throws:

javax.mail.MessagingException

setFileName

public void setFileName(java.lang.String filename)
                 throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

setFileName in interface javax.mail.Part

Overrides:

setFileName in class javax.mail.internet.MimeBodyPart

Parameters:

filename - Filename to associate with this part

Throws:

javax.mail.MessagingException

getContentStream

protected java.io.InputStream getContentStream()
                                        throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Overrides:

getContentStream in class javax.mail.internet.MimeBodyPart

Throws:

javax.mail.MessagingException

See Also:

MimeBodyPart.content, MimeMessage.getContentStream()

getDataHandler

public javax.activation.DataHandler getDataHandler()
                                            throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.MimeBodyPart

Return a DataHandler for this body part's content.

The implementation provided here works just like the the implementation in MimeMessage.

Specified by:

getDataHandler in interface javax.mail.Part

Overrides:

getDataHandler in class javax.mail.internet.MimeBodyPart

Returns:

DataHandler for the content

Throws:

javax.mail.MessagingException

See Also:

MimeMessage.getDataHandler()

setDataHandler

public void setDataHandler(javax.activation.DataHandler content)
                    throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.MimeBodyPart

This method provides the mechanism to set this body part's content. The given DataHandler object should wrap the actual content.

Specified by:

setDataHandler in interface javax.mail.Part

Overrides:

setDataHandler in class javax.mail.internet.MimeBodyPart

Parameters:

content - The DataHandler for the content

Throws:

javax.mail.MessagingException

setContent

public void setContent(java.lang.Object o,
                       java.lang.String type)
                throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

setContent in interface javax.mail.Part

Overrides:

setContent in class javax.mail.internet.MimeBodyPart

Parameters:

o - the content object

type - Mime type of the object

Throws:

javax.mail.MessagingException

setContent

public void setContent(javax.mail.Multipart mp)
                throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.MimeBodyPart

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

Specified by:

setContent in interface javax.mail.Part

Overrides:

setContent in class javax.mail.internet.MimeBodyPart

Parameters:

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

Throws:

javax.mail.MessagingException

getHeader

public java.lang.String[] getHeader(java.lang.String name)
                             throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getHeader in interface javax.mail.Part

Overrides:

getHeader in class javax.mail.internet.MimeBodyPart

Parameters:

name - name of header

Returns:

array of headers

Throws:

javax.mail.MessagingException

See Also:

MimeUtility

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)
               throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

setHeader in interface javax.mail.Part

Overrides:

setHeader in class javax.mail.internet.MimeBodyPart

Parameters:

name - header name

value - header value

Throws:

javax.mail.MessagingException

See Also:

MimeUtility

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)
               throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

addHeader in interface javax.mail.Part

Overrides:

addHeader in class javax.mail.internet.MimeBodyPart

Parameters:

name - header name

value - header value

Throws:

javax.mail.MessagingException

See Also:

MimeUtility

removeHeader

public void removeHeader(java.lang.String name)
                  throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.MimeBodyPart

Remove all headers with this name.

Specified by:

removeHeader in interface javax.mail.Part

Overrides:

removeHeader in class javax.mail.internet.MimeBodyPart

Parameters:

name - the name of this header

Throws:

javax.mail.MessagingException

getAllHeaders

public java.util.Enumeration getAllHeaders()
                                    throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.MimeBodyPart

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

Specified by:

getAllHeaders in interface javax.mail.Part

Overrides:

getAllHeaders in class javax.mail.internet.MimeBodyPart

Returns:

enumeration of Header objects

Throws:

javax.mail.MessagingException

getMatchingHeaders

public java.util.Enumeration getMatchingHeaders(java.lang.String[] names)
                                         throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.MimeBodyPart

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

Specified by:

getMatchingHeaders in interface javax.mail.Part

Overrides:

getMatchingHeaders in class javax.mail.internet.MimeBodyPart

Returns:

enumeration of Header objects

Throws:

javax.mail.MessagingException

getNonMatchingHeaders

public java.util.Enumeration getNonMatchingHeaders(java.lang.String[] names)
                                            throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.MimeBodyPart

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

Specified by:

getNonMatchingHeaders in interface javax.mail.Part

Overrides:

getNonMatchingHeaders in class javax.mail.internet.MimeBodyPart

Returns:

enumeration of Header objects

Throws:

javax.mail.MessagingException

addHeaderLine

public void addHeaderLine(java.lang.String line)
                   throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.MimeBodyPart

Add a header line to this body part

Specified by:

addHeaderLine in interface javax.mail.internet.MimePart

Overrides:

addHeaderLine in class javax.mail.internet.MimeBodyPart

Throws:

javax.mail.IllegalWriteException - if the underlying implementation does not support modification

javax.mail.MessagingException

getAllHeaderLines

public java.util.Enumeration getAllHeaderLines()
                                        throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getAllHeaderLines in interface javax.mail.internet.MimePart

Overrides:

getAllHeaderLines in class javax.mail.internet.MimeBodyPart

Throws:

javax.mail.MessagingException

getMatchingHeaderLines

public java.util.Enumeration getMatchingHeaderLines(java.lang.String[] names)
                                             throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getMatchingHeaderLines in interface javax.mail.internet.MimePart

Overrides:

getMatchingHeaderLines in class javax.mail.internet.MimeBodyPart

Throws:

javax.mail.MessagingException

getNonMatchingHeaderLines

public java.util.Enumeration getNonMatchingHeaderLines(java.lang.String[] names)
                                                throws javax.mail.MessagingException

Description copied from class: javax.mail.internet.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.

Specified by:

getNonMatchingHeaderLines in interface javax.mail.internet.MimePart

Overrides:

getNonMatchingHeaderLines in class javax.mail.internet.MimeBodyPart

Throws:

javax.mail.MessagingException