javax.mail.internet
Interface MimePart

All Superinterfaces:

Part

All Known Implementing Classes:

IMAPBodyPart, IMAPMessage, MaildirMessage, MboxMessage, MimeBodyPart, MimeMessage, NNTPMessage, POP3Message, gnu.mail.providers.ReadOnlyMessage

public interface MimePart
extends Part

A MIME part is an Entity as defined by MIME (RFC2045, Section 2.4).

The string representation of RFC822 and MIME header fields must contain only US-ASCII characters. Non US-ASCII characters must be encoded as per the rules in RFC 2047. This class does not enforce those rules; the caller is expected to use MimeUtility to ensure that header values are correctly encoded.

Version:

1.4

Author:

Chris Burdess

Field Summary

Fields inherited from interface javax.mail.Part

ATTACHMENT, INLINE

Method Summary

void	addHeaderLine(String line) Adds an RFC822 header-line.
Enumeration	getAllHeaderLines() Returns all the header-lines.
String	getContentID() Returns the value of the Content-ID header field of this part.
String[]	getContentLanguage() Returns the languages specified in the Content-Language header of this part, as defined by RFC 1766.
String	getContentMD5() Returns the value of the Content-MD5 header field of this part.
String	getEncoding() Returns the value of the Content-Transfer-Encoding header field of this part.
String	getHeader(String header_name, String delimiter) Returns the values of all header fields for the specified name, returned as a single String with the values separated by the given delimiter.
Enumeration	getMatchingHeaderLines(String[] names) Returns all the header-lines with any of the given names.
Enumeration	getNonMatchingHeaderLines(String[] names) Returns all the header-lines without any of the given names.
void	setContentLanguage(String[] languages) Sets the Content-Language header of this part.
void	setContentMD5(String md5) Sets the Content-MD5 header value for this part.
void	setText(String text) Sets the content of this message using the specified text, and with a MIME type of "text/plain".
void	setText(String text, String charset) Sets the content of this message using the specified text, and with a MIME type of "text/plain".
void	setText(String text, String charset, String subtype) Sets the content of this message using the specified text, and with a text MIME type of the specified subtype.

Methods inherited from interface javax.mail.Part

addHeader, getAllHeaders, getContent, getContentType, getDataHandler, getDescription, getDisposition, getFileName, getHeader, getInputStream, getLineCount, getMatchingHeaders, getNonMatchingHeaders, getSize, isMimeType, removeHeader, setContent, setContent, setDataHandler, setDescription, setDisposition, setFileName, setHeader, writeTo

Method Detail

getHeader

String getHeader(String header_name,
                 String delimiter)
                 throws MessagingException

Returns the values of all header fields for the specified name, returned as a single String with the values separated by the given delimiter. If the delimiter is null, only the first value is returned.

Parameters:

header_name - the header name

Throws:

MessagingException

addHeaderLine

void addHeaderLine(String line)
                   throws MessagingException

Adds an RFC822 header-line.

Throws:

IllegalWriteException - if the underlying implementation does not support modification

IllegalStateException - if this part is obtained from a READ_ONLY folder

MessagingException

getAllHeaderLines

Enumeration getAllHeaderLines()
                              throws MessagingException

Returns all the header-lines.

Returns:

an Enumeration of Strings

Throws:

MessagingException

getMatchingHeaderLines

Enumeration getMatchingHeaderLines(String[] names)
                                   throws MessagingException

Returns all the header-lines with any of the given names.

Returns:

an Enumeration of Strings

Throws:

MessagingException

getNonMatchingHeaderLines

Enumeration getNonMatchingHeaderLines(String[] names)
                                      throws MessagingException

Returns all the header-lines without any of the given names.

Returns:

an Enumeration of Strings

Throws:

MessagingException

getEncoding

String getEncoding()
                   throws MessagingException

Returns the value of the Content-Transfer-Encoding header field of this part.

Throws:

MessagingException

getContentID

String getContentID()
                    throws MessagingException

Returns the value of the Content-ID header field of this part.

Throws:

MessagingException

getContentMD5

String getContentMD5()
                     throws MessagingException

Returns the value of the Content-MD5 header field of this part.

Throws:

MessagingException

setContentMD5

void setContentMD5(String md5)
                   throws MessagingException

Sets the Content-MD5 header value for this part.

Parameters:

IllegalStateException - if this part is obtained from a READ_ONLY folder

Throws:

IllegalWriteException - if the underlying implementation does not support modification

MessagingException

getContentLanguage

String[] getContentLanguage()
                            throws MessagingException

Returns the languages specified in the Content-Language header of this part, as defined by RFC 1766. This method returns null if this header is not available.

Throws:

MessagingException

setContentLanguage

void setContentLanguage(String[] languages)
                        throws MessagingException

Sets the Content-Language header of this part.

Parameters:

languages - the array of language tags

Throws:

IllegalWriteException - if the underlying implementation does not support modification

IllegalStateException - if this Part is obtained from a READ_ONLY folder

MessagingException

setText

void setText(String text)
             throws MessagingException

Sets the content of this message using the specified text, and with a MIME type of "text/plain".

If the string contains non US-ASCII characters, it will be encoded using the platform default charset.

Specified by:

setText in interface Part

Parameters:

text - the text content

Throws:

IllegalWriteException - if the underlying implementation does not support modification

MessagingException

setText

void setText(String text,
             String charset)
             throws MessagingException

Sets the content of this message using the specified text, and with a MIME type of "text/plain".

If the string contains non US-ASCII characters, it will be encoded using the specified charset.

Parameters:

text - the text content

charset - the charset to use for any encoding

Throws:

MessagingException

setText

void setText(String text,
             String charset,
             String subtype)
             throws MessagingException

Sets the content of this message using the specified text, and with a text MIME type of the specified subtype.

If the string contains non US-ASCII characters, it will be encoded using the specified charset.

Parameters:

text - the text content

charset - the charset to use for any encoding

subtype - the MIME text subtype (e.g. "plain", "html")

Throws:

MessagingException

Since:

JavaMail 1.4