javax.mail.internet

Interface MimePart

All Superinterfaces:
Part
Known Implementing Classes:
IMAPBodyPart, IMAPMessage, MaildirMessage, MboxMessage, MimeBodyPart, MimeMessage, NNTPMessage, POP3Message

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

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, setText, writeTo

Method Details

addHeaderLine

public void addHeaderLine(String line)
            throws MessagingException
Adds an RFC822 header-line.

getAllHeaderLines

public Enumeration getAllHeaderLines()
            throws MessagingException
Returns all the header-lines.
Returns:
an Enumeration of Strings

getContentID

public String getContentID()
            throws MessagingException
Returns the value of the Content-ID header field of this part.

getContentLanguage

public 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.

getContentMD5

public String getContentMD5()
            throws MessagingException
Returns the value of the Content-MD5 header field of this part.

getEncoding

public String getEncoding()
            throws MessagingException
Returns the value of the Content-Transfer-Encoding header field of this part.

getHeader

public 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

getMatchingHeaderLines

public Enumeration getMatchingHeaderLines(String[] names)
            throws MessagingException
Returns all the header-lines with any of the given names.
Returns:
an Enumeration of Strings

getNonMatchingHeaderLines

public Enumeration getNonMatchingHeaderLines(String[] names)
            throws MessagingException
Returns all the header-lines without any of the given names.
Returns:
an Enumeration of Strings

setContentLanguage

public void setContentLanguage(String[] languages)
            throws MessagingException
Sets the Content-Language header of this part.
Parameters:
languages - the array of language tags

setContentMD5

public void setContentMD5(String md5)
            throws MessagingException
Sets the Content-MD5 header value for this part.
Parameters:

setText

public 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

setText

public 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

setText

public 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")
Since:
JavaMail 1.4

© Copyright 2003, 2004 The Free Software Foundation, All rights reserved