|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.mail.BodyPart
javax.mail.internet.MimeBodyPart
com.sun.mail.imap.IMAPBodyPart
public class IMAPBodyPart
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 |
---|
protected IMAPBodyPart(BODYSTRUCTURE bs, java.lang.String sid, IMAPMessage message)
Method Detail |
---|
protected void updateHeaders()
javax.mail.internet.MimeBodyPart
Content-Type
and Content-Transfer-Encoding
.
Headers might need to be updated in two cases:
Message.saveChanges
method.
updateHeaders
in class javax.mail.internet.MimeBodyPart
public int getSize() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
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.
getSize
in interface javax.mail.Part
getSize
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
public int getLineCount() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
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.
getLineCount
in interface javax.mail.Part
getLineCount
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
public java.lang.String getContentType() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
This implementation uses getHeader(name)
to obtain the requisite header field.
getContentType
in interface javax.mail.Part
getContentType
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
DataHandler
public java.lang.String getDisposition() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
If the Content-Disposition field is unavailable, null is returned.
This implementation uses getHeader(name)
to obtain the requisite header field.
getDisposition
in interface javax.mail.Part
getDisposition
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
MimeBodyPart.headers
public void setDisposition(java.lang.String disposition) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
setDisposition
in interface javax.mail.Part
setDisposition
in class javax.mail.internet.MimeBodyPart
disposition
- disposition of this part
javax.mail.MessagingException
Part.ATTACHMENT
,
Part.INLINE
,
Part.setFileName(java.lang.String)
public java.lang.String getEncoding() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
null
if the header is unavailable
or its value is absent.
This implementation uses getHeader(name)
to obtain the requisite header field.
getEncoding
in interface javax.mail.internet.MimePart
getEncoding
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
MimeBodyPart.headers
public java.lang.String getContentID() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
null
if the field is unavailable or its value is
absent.
This implementation uses getHeader(name)
to obtain the requisite header field.
getContentID
in interface javax.mail.internet.MimePart
getContentID
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
public java.lang.String getContentMD5() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
null
if this field is unavailable or its value
is absent.
This implementation uses getHeader(name)
to obtain the requisite header field.
getContentMD5
in interface javax.mail.internet.MimePart
getContentMD5
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
public void setContentMD5(java.lang.String md5) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
setContentMD5
in interface javax.mail.internet.MimePart
setContentMD5
in class javax.mail.internet.MimeBodyPart
md5
- the MD5 value
javax.mail.IllegalWriteException
- if the underlying
implementation does not support modification
javax.mail.MessagingException
public java.lang.String getDescription() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
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.
getDescription
in interface javax.mail.Part
getDescription
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
public void setDescription(java.lang.String description, java.lang.String charset) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
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.
setDescription
in class javax.mail.internet.MimeBodyPart
description
- Descriptioncharset
- Charset for encoding
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.public java.lang.String getFileName() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
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.
getFileName
in interface javax.mail.Part
getFileName
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
public void setFileName(java.lang.String filename) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
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.
setFileName
in interface javax.mail.Part
setFileName
in class javax.mail.internet.MimeBodyPart
filename
- Filename to associate with this part
javax.mail.MessagingException
protected java.io.InputStream getContentStream() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
getContentStream
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
MimeBodyPart.content
,
MimeMessage.getContentStream()
public javax.activation.DataHandler getDataHandler() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
The implementation provided here works just like the the implementation in MimeMessage.
getDataHandler
in interface javax.mail.Part
getDataHandler
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
MimeMessage.getDataHandler()
public void setDataHandler(javax.activation.DataHandler content) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
setDataHandler
in interface javax.mail.Part
setDataHandler
in class javax.mail.internet.MimeBodyPart
content
- The DataHandler for the content
javax.mail.MessagingException
public void setContent(java.lang.Object o, java.lang.String type) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
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.
setContent
in interface javax.mail.Part
setContent
in class javax.mail.internet.MimeBodyPart
o
- the content objecttype
- Mime type of the object
javax.mail.MessagingException
public void setContent(javax.mail.Multipart mp) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
setContent
in interface javax.mail.Part
setContent
in class javax.mail.internet.MimeBodyPart
mp
- The multipart object that is the Message's content
javax.mail.MessagingException
public java.lang.String[] getHeader(java.lang.String name) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
getHeader
in interface javax.mail.Part
getHeader
in class javax.mail.internet.MimeBodyPart
name
- name of header
javax.mail.MessagingException
MimeUtility
public void setHeader(java.lang.String name, java.lang.String value) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
setHeader
in interface javax.mail.Part
setHeader
in class javax.mail.internet.MimeBodyPart
name
- header namevalue
- header value
javax.mail.MessagingException
MimeUtility
public void addHeader(java.lang.String name, java.lang.String value) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
addHeader
in interface javax.mail.Part
addHeader
in class javax.mail.internet.MimeBodyPart
name
- header namevalue
- header value
javax.mail.MessagingException
MimeUtility
public void removeHeader(java.lang.String name) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
removeHeader
in interface javax.mail.Part
removeHeader
in class javax.mail.internet.MimeBodyPart
name
- the name of this header
javax.mail.MessagingException
public java.util.Enumeration getAllHeaders() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
getAllHeaders
in interface javax.mail.Part
getAllHeaders
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
public java.util.Enumeration getMatchingHeaders(java.lang.String[] names) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
getMatchingHeaders
in interface javax.mail.Part
getMatchingHeaders
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
public java.util.Enumeration getNonMatchingHeaders(java.lang.String[] names) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
getNonMatchingHeaders
in interface javax.mail.Part
getNonMatchingHeaders
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
public void addHeaderLine(java.lang.String line) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
addHeaderLine
in interface javax.mail.internet.MimePart
addHeaderLine
in class javax.mail.internet.MimeBodyPart
javax.mail.IllegalWriteException
- if the underlying
implementation does not support modification
javax.mail.MessagingException
public java.util.Enumeration getAllHeaderLines() throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
getAllHeaderLines
in interface javax.mail.internet.MimePart
getAllHeaderLines
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
public java.util.Enumeration getMatchingHeaderLines(java.lang.String[] names) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
getMatchingHeaderLines
in interface javax.mail.internet.MimePart
getMatchingHeaderLines
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
public java.util.Enumeration getNonMatchingHeaderLines(java.lang.String[] names) throws javax.mail.MessagingException
javax.mail.internet.MimeBodyPart
getNonMatchingHeaderLines
in interface javax.mail.internet.MimePart
getNonMatchingHeaderLines
in class javax.mail.internet.MimeBodyPart
javax.mail.MessagingException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |