站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > Java Platform, Enterprise Edition v1.3.1 API Specifications

Java 2 Platform EE v1.3: Interface MimePart - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

javax.mail.internet
Interface MimePart

All Superinterfaces:
Part
All Known Implementing Classes:
MimeMessage, MimeBodyPart
public interface MimePart
extends Part

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.

See Also:
MimeUtility, Part

Fields inherited from interface javax.mail.Part
ATTACHMENT, INLINE
 
Method Summary
 void addHeaderLine(java.lang.String line)
          Add a raw RFC822 header-line.
 java.util.Enumeration getAllHeaderLines()
          Get all header lines as an Enumeration of Strings.
 java.lang.String getContentID()
          Get the Content-ID of this part.
 java.lang.String[] getContentLanguage()
          Get the language tags specified in the Content-Language header of this MimePart.
 java.lang.String getContentMD5()
          Get the Content-MD5 digest of this part.
 java.lang.String getEncoding()
          Get the transfer encoding of this part.
 java.lang.String getHeader(java.lang.String header_name, java.lang.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.
 java.util.Enumeration getMatchingHeaderLines(java.lang.String[] names)
          Get matching header lines as an Enumeration of Strings.
 java.util.Enumeration getNonMatchingHeaderLines(java.lang.String[] names)
          Get non-matching header lines as an Enumeration of Strings.
 void setContentLanguage(java.lang.String[] languages)
          Set the Content-Language header of this MimePart.
 void setContentMD5(java.lang.String md5)
          Set the Content-MD5 of this part.
 void setText(java.lang.String text)
          Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".
 void setText(java.lang.String text, java.lang.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.
 
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

public java.lang.String getHeader(java.lang.String header_name,
                                  java.lang.String delimiter)
                           throws MessagingException
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:
header_name - the name of this header
Returns:
the value fields for all headers with this name
Throws:
MessagingException -  

addHeaderLine

public void addHeaderLine(java.lang.String line)
                   throws MessagingException
Add a raw RFC822 header-line.
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this Part is obtained from a READ_ONLY folder

getAllHeaderLines

public java.util.Enumeration getAllHeaderLines()
                                        throws MessagingException
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.

getMatchingHeaderLines

public java.util.Enumeration getMatchingHeaderLines(java.lang.String[] names)
                                             throws MessagingException
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.

getNonMatchingHeaderLines

public java.util.Enumeration getNonMatchingHeaderLines(java.lang.String[] names)
                                                throws MessagingException
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.

getEncoding

public java.lang.String getEncoding()
                             throws MessagingException
Get the transfer encoding of this part.
Returns:
content-transfer-encoding
Throws:
MessagingException -  

getContentID

public java.lang.String getContentID()
                              throws MessagingException
Get the Content-ID of this part. Returns null if none present.
Returns:
content-ID

getContentMD5

public java.lang.String getContentMD5()
                               throws MessagingException
Get the Content-MD5 digest of this part. Returns null if none present.
Returns:
content-MD5

setContentMD5

public void setContentMD5(java.lang.String md5)
                   throws MessagingException
Set the Content-MD5 of this part.
Parameters:
cid - content-id
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this Part is obtained from a READ_ONLY folder

getContentLanguage

public java.lang.String[] getContentLanguage()
                                      throws MessagingException
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.

setContentLanguage

public void setContentLanguage(java.lang.String[] languages)
                        throws MessagingException
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
java.lang.IllegalStateException - if this Part is obtained from a READ_ONLY folder

setText

public void setText(java.lang.String text)
             throws MessagingException
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() version that takes the charset parameter.

Specified by:
setText in interface Part
See Also:
setText(String text, String charset)

setText

public void setText(java.lang.String text,
                    java.lang.String charset)
             throws MessagingException
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.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

The CHM file was converted