Save This Page
Home » glassfish-v2ur2-b04-src » javax » mail » internet » [javadoc | source]
javax.mail.internet
public class: MimeBodyPart [javadoc | source]
java.lang.Object
   javax.mail.BodyPart
      javax.mail.internet.MimeBodyPart

All Implemented Interfaces:
    MimePart, Part

Direct Known Subclasses:
    PreencodedMimeBodyPart

This class represents a MIME body part. It implements the BodyPart abstract class and the MimePart interface. MimeBodyParts are contained in MimeMultipart objects.

MimeBodyPart uses the InternetHeaders class to parse and store the headers of that body part.


A note on RFC 822 and MIME headers

RFC 822 header fields must contain only US-ASCII characters. MIME allows non ASCII characters to be present in certain portions of certain headers, by encoding those characters. RFC 2047 specifies the rules for doing this. The MimeUtility class provided in this package can be used to to achieve this. Callers of the setHeader, addHeader, and addHeaderLine methods are responsible for enforcing the MIME requirements for the specified headers. In addition, these header fields must be folded (wrapped) before being sent if they exceed the line length limitation for the transport (1000 bytes for SMTP). Received headers may have been folded. The application is responsible for folding and unfolding headers as appropriate.

Field Summary
static  boolean cacheMultipart     
protected  DataHandler dh    The DataHandler object representing this Part's content. 
protected  byte[] content    Byte array that holds the bytes of the content of this Part. 
protected  InputStream contentStream    If the data for this body part was supplied by an InputStream that implements the SharedInputStream interface, contentStream is another such stream representing the content of this body part. In this case, content will be null.
    since: JavaMail - 1.2
 
protected  InternetHeaders headers    The InternetHeaders object that stores all the headers of this body part. 
Fields inherited from javax.mail.BodyPart:
parent
Constructor:
 public MimeBodyPart() 
 public MimeBodyPart(InputStream is) throws MessagingException 
    Constructs a MimeBodyPart by reading and parsing the data from the specified input stream. The parser consumes data till the end of the given input stream. The input stream must start at the beginning of a valid MIME body part and must terminate at the end of that body part.

    Note that the "boundary" string that delimits body parts must not be included in the input stream. The intention is that the MimeMultipart parser will extract each body part's bytes from a multipart stream and feed them into this constructor, without the delimiter strings.

    Parameters:
    is - the body part Input Stream
 public MimeBodyPart(InternetHeaders headers,
    byte[] content) throws MessagingException 
    Constructs a MimeBodyPart using the given header and content bytes.

    Used by providers.

    Parameters:
    headers - The header of this part
    content - bytes representing the body of this part.
Method from javax.mail.internet.MimeBodyPart Summary:
addHeader,   addHeaderLine,   attachFile,   attachFile,   getAllHeaderLines,   getAllHeaders,   getContent,   getContentID,   getContentLanguage,   getContentLanguage,   getContentMD5,   getContentStream,   getContentType,   getDataHandler,   getDescription,   getDescription,   getDisposition,   getDisposition,   getEncoding,   getEncoding,   getFileName,   getFileName,   getHeader,   getHeader,   getInputStream,   getLineCount,   getMatchingHeaderLines,   getMatchingHeaders,   getNonMatchingHeaderLines,   getNonMatchingHeaders,   getRawInputStream,   getSize,   invalidateContentHeaders,   isMimeType,   isMimeType,   removeHeader,   saveFile,   saveFile,   setContent,   setContent,   setContentID,   setContentLanguage,   setContentLanguage,   setContentMD5,   setDataHandler,   setDescription,   setDescription,   setDescription,   setDisposition,   setDisposition,   setEncoding,   setFileName,   setFileName,   setHeader,   setText,   setText,   setText,   setText,   updateHeaders,   updateHeaders,   writeTo,   writeTo
Methods from javax.mail.BodyPart:
getParent,   setParent
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.mail.internet.MimeBodyPart Detail:
 public  void addHeader(String name,
    String value) throws MessagingException 
    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.
 public  void addHeaderLine(String line) throws MessagingException 
    Add a header line to this body part
 public  void attachFile(File file) throws IOException, MessagingException 
    Use the specified file to provide the data for this part. The simple file name is used as the file name for this part and the data in the file is used as the data for this part. The encoding will be chosen appropriately for the file data.
 public  void attachFile(String file) throws IOException, MessagingException 
    Use the specified file to provide the data for this part. The simple file name is used as the file name for this part and the data in the file is used as the data for this part. The encoding will be chosen appropriately for the file data.
 public Enumeration getAllHeaderLines() throws MessagingException 
    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.
 public Enumeration getAllHeaders() throws MessagingException 
    Return all the headers from this Message as an Enumeration of Header objects.
 public Object getContent() throws IOException, MessagingException 
    Return the content as a Java object. The type of the object returned is of course dependent on the content itself. For example, the native format of a text/plain content is usually a String object. The native format for a "multipart" content is always a Multipart subclass. For content types that are unknown to the DataHandler system, an input stream is returned as the content.

    This implementation obtains the content from the DataHandler. That is, it invokes getDataHandler().getContent(); If the content is a Multipart or Message object and was created by parsing a stream, the object is cached and returned in subsequent calls so that modifications to the content will not be lost.

 public String getContentID() throws MessagingException 
    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.

 public String[] getContentLanguage() throws MessagingException 
    Get the languages specified in the Content-Language header of this MimePart. The Content-Language header is defined by RFC 1766. Returns null if this header is not available or its value is absent.

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

 static String[] getContentLanguage(MimePart part) throws MessagingException 
 public String getContentMD5() throws MessagingException 
    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.

 protected InputStream getContentStream() throws MessagingException 
    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.

 public String getContentType() throws MessagingException 
    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.

 public DataHandler getDataHandler() throws MessagingException 
    Return a DataHandler for this body part's content.

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

 public String getDescription() throws MessagingException 
    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.

 static String getDescription(MimePart part) throws MessagingException 
 public String getDisposition() throws MessagingException 
    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.

 static String getDisposition(MimePart part) throws MessagingException 
 public String getEncoding() throws MessagingException 
    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.

 static String getEncoding(MimePart part) throws MessagingException 
 public String getFileName() throws MessagingException 
    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.

 static String getFileName(MimePart part) throws MessagingException 
 public String[] getHeader(String name) throws MessagingException 
    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.
 public String getHeader(String name,
    String delimiter) throws MessagingException 
    Get all the headers for this header name, returned as a single String, with headers separated by the delimiter. If the delimiter is null, only the first header is returned.
 public InputStream getInputStream() throws IOException, MessagingException 
    Return a decoded input stream for this body part's "content".

    This implementation obtains the input stream from the DataHandler. That is, it invokes getDataHandler().getInputStream();

 public int getLineCount() throws MessagingException 
    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.

 public Enumeration getMatchingHeaderLines(String[] names) throws MessagingException 
    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.
 public Enumeration getMatchingHeaders(String[] names) throws MessagingException 
    Return matching headers from this Message as an Enumeration of Header objects.

 public Enumeration getNonMatchingHeaderLines(String[] names) throws MessagingException 
    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.
 public Enumeration getNonMatchingHeaders(String[] names) throws MessagingException 
    Return non-matching headers from this Message as an Enumeration of Header objects.
 public InputStream getRawInputStream() throws MessagingException 
    Return an InputStream to the raw data with any Content-Transfer-Encoding intact. This method is useful if the "Content-Transfer-Encoding" header is incorrect or corrupt, which would prevent the getInputStream method or getContent method from returning the correct data. In such a case the application may use this method and attempt to decode the raw data itself.

    This implementation simply calls the getContentStream method.

 public int getSize() throws MessagingException 
    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.

 static  void invalidateContentHeaders(MimePart part) throws MessagingException 
 public boolean isMimeType(String mimeType) throws MessagingException 
    Is this Part of the specified MIME type? This method compares only the primaryType and subType. The parameters of the content types are ignored.

    For example, this method will return true when comparing a Part of content type "text/plain" with "text/plain; charset=foobar".

    If the subType of mimeType is the special character '*', then the subtype is ignored during the comparison.

 static boolean isMimeType(MimePart part,
    String mimeType) throws MessagingException 
 public  void removeHeader(String name) throws MessagingException 
    Remove all headers with this name.
 public  void saveFile(File file) throws IOException, MessagingException 
    Save the contents of this part in the specified file. The content is decoded and saved, without any of the MIME headers.
 public  void saveFile(String file) throws IOException, MessagingException 
    Save the contents of this part in the specified file. The content is decoded and saved, without any of the MIME headers.
 public  void setContent(Multipart mp) throws MessagingException 
    This method sets the body part's content to a Multipart object.
 public  void setContent(Object o,
    String type) throws MessagingException 
    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.

 public  void setContentID(String cid) throws MessagingException 
    Set the "Content-ID" header field of this body part. If the cid parameter is null, any existing "Content-ID" is removed.
 public  void setContentLanguage(String[] languages) throws MessagingException 
    Set the Content-Language header of this MimePart. The Content-Language header is defined by RFC 1766.
 static  void setContentLanguage(MimePart part,
    String[] languages) throws MessagingException 
 public  void setContentMD5(String md5) throws MessagingException 
    Set the "Content-MD5" header field of this body part.
 public  void setDataHandler(DataHandler dh) throws MessagingException 
    This method provides the mechanism to set this body part's content. The given DataHandler object should wrap the actual content.
 public  void setDescription(String description) throws MessagingException 
    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 platform's default 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.

 public  void setDescription(String description,
    String charset) throws MessagingException 
    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.

 static  void setDescription(MimePart part,
    String description,
    String charset) throws MessagingException 
 public  void setDisposition(String disposition) throws MessagingException 
    Set the "Content-Disposition" header field of this body part. If the disposition is null, any existing "Content-Disposition" header field is removed.
 static  void setDisposition(MimePart part,
    String disposition) throws MessagingException 
 static  void setEncoding(MimePart part,
    String encoding) throws MessagingException 
 public  void setFileName(String filename) throws MessagingException 
    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.

 static  void setFileName(MimePart part,
    String name) throws MessagingException 
 public  void setHeader(String name,
    String value) throws MessagingException 
    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.
 public  void setText(String text) throws MessagingException 
    Convenience method that sets the given String as this part's content, with a MIME type of "text/plain". If the string contains non US-ASCII characters, it will be encoded using the platform's default charset. The charset is also used to set the "charset" parameter.

    Note that there may be a performance penalty if text is large, since this method may have to scan all the characters to determine what charset to use.

    If the charset is already known, use the setText method that takes the charset parameter.

 public  void setText(String text,
    String charset) throws MessagingException 
    Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset. The given Unicode string will be charset-encoded using the specified charset. The charset is also used to set the "charset" parameter.
 public  void setText(String text,
    String charset,
    String subtype) throws MessagingException 
    Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype. The given Unicode string will be charset-encoded using the specified charset. The charset is also used to set the "charset" parameter.
 static  void setText(MimePart part,
    String text,
    String charset,
    String subtype) throws MessagingException 
 protected  void updateHeaders() throws MessagingException 
    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.
 static  void updateHeaders(MimePart part) throws MessagingException 
 public  void writeTo(OutputStream os) throws IOException, MessagingException 
    Output the body part as an RFC 822 format stream.
 static  void writeTo(MimePart part,
    OutputStream os,
    String[] ignoreList) throws IOException, MessagingException