public interface

MimePart

implements Part
com.google.code.javax.mail.internet.MimePart
Known Indirect Subclasses

Class Overview

The MimePart interface models an Entity as defined by MIME (RFC2045, Section 2.4).

MimePart extends the Part interface to add additional RFC822 and MIME specific semantics and attributes. It provides the base interface for the MimeMessage and MimeBodyPart classes

A note on RFC822 and MIME headers

RFC822 and MIME header fields must contain only US-ASCII characters. If a header contains non US-ASCII characters, it must be encoded as per the rules in RFC 2047. 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.

See Also

Summary

[Expand]
Inherited Constants
From interface com.google.code.javax.mail.Part
Public Methods
abstract void addHeaderLine(String line)
Add a raw RFC822 header-line.
abstract Enumeration getAllHeaderLines()
Get all header lines as an Enumeration of Strings.
abstract String getContentID()
Get the Content-ID of this part.
abstract String[] getContentLanguage()
Get the language tags specified in the Content-Language header of this MimePart.
abstract String getContentMD5()
Get the Content-MD5 digest of this part.
abstract String getEncoding()
Get the transfer encoding of this part.
abstract String getHeader(String name, String delimiter)
Get the values of all header fields available for this header, returned as a single String, with the values separated by the delimiter.
abstract Enumeration getMatchingHeaderLines(String[] names)
Get matching header lines as an Enumeration of Strings.
abstract Enumeration getNonMatchingHeaderLines(String[] names)
Get non-matching header lines as an Enumeration of Strings.
abstract void setContentLanguage(String[] languages)
Set the Content-Language header of this MimePart.
abstract void setContentMD5(String md5)
Set the Content-MD5 of this part.
abstract void setText(String text)
Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".
abstract void setText(String text, String charset, String subtype)
Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype.
abstract void setText(String text, String charset)
Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset.
[Expand]
Inherited Methods
From interface com.google.code.javax.mail.Part

Public Methods

public abstract void addHeaderLine (String line)

Add a raw RFC822 header-line.

Parameters
line
Throws
IllegalWriteException if the underlying implementation does not support modification
IllegalStateException if this Part is obtained from a READ_ONLY folder
MessagingException

public abstract Enumeration getAllHeaderLines ()

Get all header lines as an Enumeration of Strings. A Header line is a raw RFC822 header-line, containing both the "name" and "value" field.

Throws
MessagingException

public abstract String getContentID ()

Get the Content-ID of this part. Returns null if none present.

Returns
  • content-ID
Throws
MessagingException

public abstract String[] getContentLanguage ()

Get the language tags 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.

Throws
MessagingException

public abstract String getContentMD5 ()

Get the Content-MD5 digest of this part. Returns null if none present.

Returns
  • content-MD5
Throws
MessagingException

public abstract String getEncoding ()

Get the transfer encoding of this part.

Returns
  • content-transfer-encoding
Throws
MessagingException

public abstract String getHeader (String name, String delimiter)

Get the values of all header fields available for this header, returned as a single String, with the values separated by the delimiter. If the delimiter is null, only the first value is returned.

Parameters
name The name of this header
delimiter Delimiter between fields in returned string
Returns
  • the value fields for all headers with this name
Throws
MessagingException

public abstract Enumeration getMatchingHeaderLines (String[] names)

Get matching header lines as an Enumeration of Strings. A Header line is a raw RFC822 header-line, containing both the "name" and "value" field.

Parameters
names
Throws
MessagingException

public abstract Enumeration getNonMatchingHeaderLines (String[] names)

Get non-matching header lines as an Enumeration of Strings. A Header line is a raw RFC822 header-line, containing both the "name" and "value" field.

Parameters
names
Throws
MessagingException

public abstract void setContentLanguage (String[] languages)

Set the Content-Language header of this MimePart. The Content-Language header is defined by RFC1766.

Parameters
languages 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

public abstract void setContentMD5 (String md5)

Set the Content-MD5 of this part.

Parameters
md5 The MD5 value
Throws
IllegalWriteException if the underlying implementation does not support modification
IllegalStateException if this Part is obtained from a READ_ONLY folder
MessagingException

public abstract void setText (String text)

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.

Parameters
text The text content to set
Throws
MessagingException if an error occurs
See Also

public abstract void setText (String text, String charset, String subtype)

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.

Parameters
text The text content to set
charset The charset to use for the text
subtype The MIME subtype to use (e.g., "html")
Throws
MessagingException if an error occurs

public abstract void setText (String text, String charset)

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 "charset" parameter.

Parameters
text The text content to set
charset The charset to use for the text
Throws
MessagingException if an error occurs