public class

IMAPBodyPart

extends MimeBodyPart
java.lang.Object
   ↳ com.google.code.javax.mail.BodyPart
     ↳ com.google.code.javax.mail.internet.MimeBodyPart
       ↳ com.google.code.com.sun.mail.imap.IMAPBodyPart

Class Overview

An IMAP body part.

Summary

[Expand]
Inherited Constants
From interface com.google.code.javax.mail.Part
Fields
private BODYSTRUCTURE bs
private static final boolean decodeFileName
private String description
private boolean headersLoaded
private IMAPMessage message
private String sectionId
private String type
[Expand]
Inherited Fields
From class com.google.code.javax.mail.internet.MimeBodyPart
From class com.google.code.javax.mail.BodyPart
Protected Constructors
IMAPBodyPart(BODYSTRUCTURE bs, String sid, IMAPMessage message)
Public Methods
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.
String getContentType()
Returns the value of the RFC 822 "Content-Type" header field.
synchronized 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(Object o, String type)
A convenience method for setting this body part's content.
void setContent(Multipart mp)
This method sets the body part's content to a Multipart object.
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 Methods
InputStream getContentStream()
Produce the raw bytes of the content.
void updateHeaders()
Examine the content of this body part and update the appropriate MIME headers.
[Expand]
Inherited Methods
From class com.google.code.javax.mail.internet.MimeBodyPart
From class com.google.code.javax.mail.BodyPart
From class java.lang.Object
From interface com.google.code.javax.mail.HasRawInputStream
From interface com.google.code.javax.mail.Part
From interface com.google.code.javax.mail.internet.MimePart

Fields

private BODYSTRUCTURE bs

private static final boolean decodeFileName

private String description

private boolean headersLoaded

private IMAPMessage message

private String sectionId

private String type

Protected Constructors

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

Parameters
bs
sid
message

Public Methods

public void addHeader (String name, String value)

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.

Parameters
name Header name
value Header value
Throws
MessagingException

public void addHeaderLine (String line)

Add a header line to this body part

Parameters
line
Throws
MessagingException

public Enumeration getAllHeaderLines ()

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.

Throws
MessagingException

public Enumeration getAllHeaders ()

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

Returns
  • enumeration of Header objects
Throws
MessagingException

public String getContentID ()

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.

Returns
  • content-ID
Throws
MessagingException

public String getContentMD5 ()

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.

Returns
  • content-MD5
Throws
MessagingException

public String getContentType ()

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.

Returns
  • Content-Type of this body part
Throws
MessagingException

public synchronized DataHandler getDataHandler ()

Return a DataHandler for this body part's content.

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

Returns
  • DataHandler for the content
Throws
MessagingException

public String getDescription ()

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.

Returns
  • content description
Throws
MessagingException

public String getDisposition ()

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.

Returns
  • disposition of this part, or null if unknown
Throws
MessagingException

public String getEncoding ()

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.

Returns
  • content-transfer-encoding
Throws
MessagingException

public String getFileName ()

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.

Returns
  • filename
Throws
MessagingException

public String[] getHeader (String name)

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.

Parameters
name Name of header
Returns
  • array of headers
Throws
MessagingException

public int getLineCount ()

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.

Returns
  • number of lines, or -1 if not known
Throws
MessagingException

public Enumeration getMatchingHeaderLines (String[] names)

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.

Parameters
names
Throws
MessagingException

public Enumeration getMatchingHeaders (String[] names)

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

Parameters
names
Returns
  • enumeration of Header objects
Throws
MessagingException

public Enumeration getNonMatchingHeaderLines (String[] names)

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.

Parameters
names
Throws
MessagingException

public Enumeration getNonMatchingHeaders (String[] names)

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

Parameters
names
Returns
  • enumeration of Header objects
Throws
MessagingException

public int getSize ()

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.

Returns
  • size in bytes, or -1 if not known
Throws
MessagingException

public void removeHeader (String name)

Remove all headers with this name.

Parameters
name The name of this header
Throws
MessagingException

public void setContent (Object o, String type)

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.

Parameters
o The content object
type Mime type of the object
Throws
MessagingException

public void setContent (Multipart mp)

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

Parameters
mp The multipart object that is the Message's content
Throws
MessagingException

public void setContentMD5 (String md5)

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

Parameters
md5 The MD5 value
Throws
MessagingException

public void setDataHandler (DataHandler content)

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

Parameters
content The DataHandler for the content
Throws
MessagingException

public void setDescription (String description, String charset)

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.

Parameters
description Description
charset Charset for encoding
Throws
MessagingException

public void setDisposition (String disposition)

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

Parameters
disposition Disposition of this part
Throws
MessagingException

public void setFileName (String filename)

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.

Parameters
filename Filename to associate with this part
Throws
MessagingException

public void setHeader (String name, String value)

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.

Parameters
name Header name
value Header value
Throws
MessagingException

Protected Methods

protected InputStream getContentStream ()

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.

Throws
MessagingException

protected void updateHeaders ()

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.