javax.mail
public interface Part
The content of a part is available in various forms:
getDataHandler
method.
getInputStream
method.
getContent
method.
writeTo
method can be used to write the part to a
byte stream in mail-safe form suitable for transmission.
In MIME terms, Part models an Entity (RFC 2045, Section 2.4).
Version: 1.4
Field Summary | |
---|---|
String | ATTACHMENT
This part should be presented as an attachment. |
String | INLINE
This part should be presented inline. |
Method Summary | |
---|---|
void | addHeader(String name, String value)
Adds the specified value to the existing values for this header name. |
Enumeration | getAllHeaders()
Returns all the headers from this part. |
Object | getContent()
Returns the content of this part as a Java object.
|
String | getContentType()
Returns the content-type of the content of this part, or
null if the content-type could not be determined.
|
DataHandler | getDataHandler()
Returns a data handler for the content of this part. |
String | getDescription()
Returns the description of this part. |
String | getDisposition()
Returns the disposition of this part.
|
String | getFileName()
Returns the filename associated with this part, if available. |
String[] | getHeader(String name)
Returns all the values for the specified header name, or
null if no such headers are available. |
InputStream | getInputStream()
Returns an input stream for reading the content of this part.
|
int | getLineCount()
Returns the number of lines in the content of this part, or -1 if the
number cannot be determined.
|
Enumeration | getMatchingHeaders(String[] names)
Returns the matching headers from this part. |
Enumeration | getNonMatchingHeaders(String[] names)
Returns the non-matching headers from this part. |
int | getSize()
Returns the size of the content of this part in bytes, or -1 if the
size cannot be determined.
|
boolean | isMimeType(String mimeType)
Is this part of the specified MIME type?
|
void | removeHeader(String name)
Removes all headers of the specified name. |
void | setContent(Object obj, String type)
Sets the content of this part using the specified object. |
void | setContent(Multipart mp)
Sets the multipart content of this part. |
void | setDataHandler(DataHandler dh)
Sets the content of this part using the specified data handler. |
void | setDescription(String description)
Sets the description of this part. |
void | setDisposition(String disposition)
Sets the disposition of this part. |
void | setFileName(String filename)
Sets the filename associated with this part. |
void | setHeader(String name, String value)
Sets the value for the specified header name. |
void | setText(String text)
Sets the textual content of this part, using a MIME type of
text/plain . |
void | writeTo(OutputStream os)
Writes this part to the specified byte stream. |
Parameters: name the header name value the value to add
Throws: IllegalWriteException if the underlying implementation does not support modification of this header IllegalStateException if this part is obtained from a READ_ONLY folder
Returns: an enumeration of Header
Throws: IOException when a data handler error occurs
null
if the content-type could not be determined.
The MIME typing system is used to name content-types.
null
if no such headers are available.Parameters: name the header name
Throws: IOException when a data handler error occurs
Parameters: names the header names to match
Returns: an enumeration of Header
Parameters: names the header names to ignore
Returns: an enumeration of Header
Note that the size may not be an exact measure of the content size, but will be suitable for display in a user interface to give the user an idea of the size of this part.
If the subtype of mimeType
is the special character '*',
then the subtype is ignored during the comparison.
Parameters: name the header name
Throws: IllegalWriteException if the underlying implementation does not support modification of this header IllegalStateException if this part is obtained from a READ_ONLY folder
Parameters: obj a Java object type the MIME content-type of this object
Throws: IllegalWriteException if the underlying implementation does not support modification IllegalStateException if this part is obtained from a READ_ONLY folder
Parameters: mp the multipart content
Throws: IllegalWriteException if the underlying implementation does not support modification IllegalStateException if this part is obtained from a READ_ONLY folder
Parameters: dh the data handler for the content
Throws: IllegalWriteException if the underlying implementation does not support modification IllegalStateException if this part is obtained from a READ_ONLY folder
Parameters: description the description of this part
Throws: IllegalWriteException if the underlying implementation does not support modification of this header IllegalStateException if this Part is obtained from a READ_ONLY folder
Parameters: disposition the disposition of this part
Throws: IllegalWriteException if the underlying implementation does not support modification of this header IllegalStateException if this part is obtained from a READ_ONLY folder
Parameters: filename the filename to associate with this part
Throws: IllegalWriteException if the underlying implementation does not support modification of this header IllegalStateException if this Part is obtained from a READ_ONLY folder
Parameters: name the header name value the new value
Throws: IllegalWriteException if the underlying implementation does not support modification of this header IllegalStateException if this part is obtained from a READ_ONLY folder
text/plain
.Parameters: text the textual content
Throws: IllegalWriteException if the underlying implementation does not support modification IllegalStateException if this part is obtained from a READ_ONLY folder
Throws: IOException if an error occurs writing to the stream or if an error occurs in the data handler system. MessagingException if an error occurs fetching the data to be written