This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


com.sun.mail.imap
class IMAPBodyPart

javax.mail.BodyPart extended by javax.mail.internet.MimeBodyPart extended by com.sun.mail.imap.IMAPBodyPart
All Implemented Interfaces:
Part, MimePart

public class IMAPBodyPart
extends MimeBodyPart

This class


Field Summary
 
Fields inherited from class javax.mail.internet.MimeBodyPart
content, contentStream, dh, headers
 
Fields inherited from class javax.mail.BodyPart
parent
 
Constructor Summary
protected

          
 
Method Summary
 void
addHeader(String name, String value)

          Add this value to the existing values for this header_name.
 void

          Add a header line to this body part
 Enumeration

          Get all header lines as an Enumeration of Strings.
 Enumeration

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

          Returns the value of the "Content-ID" header field.
 String

          Return the value of the "Content-MD5" header field.
protected InputStream

          Produce the raw bytes of the content.
 String

          Returns the value of the RFC 822 "Content-Type" header field.
 DataHandler

          Return a DataHandler for this body part's content.
 String

          Returns the "Content-Description" header field of this body part.
 String

          Returns the value of the "Content-Disposition" header field.
 String

          Returns the content transfer encoding from the "Content-Transfer-Encoding" header field.
 String

          Get the filename associated with this body part.
 String[]

          Get all the headers for this header_name.
 int

          Return the number of lines for the content of this Part.
 Enumeration

          Get matching header lines as an Enumeration of Strings.
 Enumeration

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

          Get non-matching header lines as an Enumeration of Strings.
 Enumeration

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

          Return the size of the content of this body part in bytes.
 void

          Remove all headers with this name.
 void

          A convenience method for setting this body part's content.
 void

          A convenience method for setting this body part's content.
 void

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

          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

          Examine the content of this body part and update the appropriate MIME headers.
 
Methods inherited from class javax.mail.internet.MimeBodyPart
addHeader, addHeaderLine, attachFile, attachFile, getAllHeaderLines, getAllHeaders, getContent, getContentID, getContentLanguage, getContentMD5, getContentStream, getContentType, getDataHandler, getDescription, getDisposition, getEncoding, getFileName, getHeader, getHeader, getInputStream, getLineCount, getMatchingHeaderLines, getMatchingHeaders, getNonMatchingHeaderLines, getNonMatchingHeaders, getRawInputStream, getSize, isMimeType, removeHeader, saveFile, saveFile, setContent, setContent, setContentID, setContentLanguage, setContentMD5, setDataHandler, setDescription, setDescription, setDisposition, setFileName, setHeader, setText, setText, setText, updateHeaders, writeTo
 
Methods inherited from class javax.mail.BodyPart
getParent
 

Constructor Detail

IMAPBodyPart

protected IMAPBodyPart(BODYSTRUCTURE bs,
                       String sid,
                       IMAPMessage message)
Parameters:
bs
sid
message
Method Detail

addHeader

public void addHeader(String name,
                      String value)
               throws MessagingException
Overrides:
addHeader in class MimeBodyPart
Parameters:
name
value
Throws:
MessagingException

addHeaderLine

public void addHeaderLine(String line)
                   throws MessagingException
Overrides:
addHeaderLine in class MimeBodyPart
Parameters:
line
Throws:
MessagingException

getAllHeaderLines

public Enumeration getAllHeaderLines()
                              throws MessagingException
Overrides:
getAllHeaderLines in class MimeBodyPart
Throws:
MessagingException

getAllHeaders

public Enumeration getAllHeaders()
                          throws MessagingException
Overrides:
getAllHeaders in class MimeBodyPart
Throws:
MessagingException

getContentID

public String getContentID()
                    throws MessagingException
Overrides:
getContentID in class MimeBodyPart
Throws:
MessagingException

getContentMD5

public String getContentMD5()
                     throws MessagingException
Overrides:
getContentMD5 in class MimeBodyPart
Throws:
MessagingException

getContentStream

protected InputStream getContentStream()
                                throws MessagingException
Overrides:
getContentStream in class MimeBodyPart
Throws:
MessagingException

getContentType

public String getContentType()
                      throws MessagingException
Overrides:
getContentType in class MimeBodyPart
Throws:
MessagingException

getDataHandler

public synchronized DataHandler getDataHandler()
                                        throws MessagingException
Overrides:
getDataHandler in class MimeBodyPart
Throws:
MessagingException

getDescription

public String getDescription()
                      throws MessagingException
Overrides:
getDescription in class MimeBodyPart
Throws:
MessagingException

getDisposition

public String getDisposition()
                      throws MessagingException
Overrides:
getDisposition in class MimeBodyPart
Throws:
MessagingException

getEncoding

public String getEncoding()
                   throws MessagingException
Overrides:
getEncoding in class MimeBodyPart
Throws:
MessagingException

getFileName

public String getFileName()
                   throws MessagingException
Overrides:
getFileName in class MimeBodyPart
Throws:
MessagingException

getHeader

public String[] getHeader(String name)
                   throws MessagingException
Overrides:
getHeader in class MimeBodyPart
Parameters:
name
Throws:
MessagingException

getLineCount

public int getLineCount()
                 throws MessagingException
Overrides:
getLineCount in class MimeBodyPart
Throws:
MessagingException

getMatchingHeaderLines

public Enumeration getMatchingHeaderLines(String[] names)
                                   throws MessagingException
Overrides:
getMatchingHeaderLines in class MimeBodyPart
Parameters:
names
Throws:
MessagingException

getMatchingHeaders

public Enumeration getMatchingHeaders(String[] names)
                               throws MessagingException
Overrides:
getMatchingHeaders in class MimeBodyPart
Parameters:
names
Throws:
MessagingException

getNonMatchingHeaderLines

public Enumeration getNonMatchingHeaderLines(String[] names)
                                      throws MessagingException
Overrides:
getNonMatchingHeaderLines in class MimeBodyPart
Parameters:
names
Throws:
MessagingException

getNonMatchingHeaders

public Enumeration getNonMatchingHeaders(String[] names)
                                  throws MessagingException
Overrides:
getNonMatchingHeaders in class MimeBodyPart
Parameters:
names
Throws:
MessagingException

getSize

public int getSize()
            throws MessagingException
Overrides:
getSize in class MimeBodyPart
Throws:
MessagingException

removeHeader

public void removeHeader(String name)
                  throws MessagingException
Overrides:
removeHeader in class MimeBodyPart
Parameters:
name
Throws:
MessagingException

setContent

public void setContent(Multipart mp)
                throws MessagingException
Overrides:
setContent in class MimeBodyPart
Parameters:
mp
Throws:
MessagingException

setContent

public void setContent(Object o,
                       String type)
                throws MessagingException
Overrides:
setContent in class MimeBodyPart
Parameters:
o
type
Throws:
MessagingException

setContentMD5

public void setContentMD5(String md5)
                   throws MessagingException
Overrides:
setContentMD5 in class MimeBodyPart
Parameters:
md5
Throws:
MessagingException

setDataHandler

public void setDataHandler(DataHandler content)
                    throws MessagingException
Overrides:
setDataHandler in class MimeBodyPart
Parameters:
content
Throws:
MessagingException

setDescription

public void setDescription(String description,
                           String charset)
                    throws MessagingException
Overrides:
setDescription in class MimeBodyPart
Parameters:
description
charset
Throws:
MessagingException

setDisposition

public void setDisposition(String disposition)
                    throws MessagingException
Overrides:
setDisposition in class MimeBodyPart
Parameters:
disposition
Throws:
MessagingException

setFileName

public void setFileName(String filename)
                 throws MessagingException
Overrides:
setFileName in class MimeBodyPart
Parameters:
filename
Throws:
MessagingException

setHeader

public void setHeader(String name,
                      String value)
               throws MessagingException
Overrides:
setHeader in class MimeBodyPart
Parameters:
name
value
Throws:
MessagingException

updateHeaders

protected void updateHeaders()
Overrides:
updateHeaders in class MimeBodyPart


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention. The official Sun™ documentation can be found here at http://java.sun.com/products/javamail/javadocs/index.html.