Interface MimePart
-
- All Superinterfaces:
Part
- All Known Implementing Classes:
MimeBodyPart
,MimeMessage
,PreencodedMimeBodyPart
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 headersRFC822 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
, andaddHeaderLine
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.- Author:
- John Mani
- See Also:
MimeUtility
,Part
-
-
Field Summary
-
Fields inherited from interface jakarta.mail.Part
ATTACHMENT, INLINE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addHeaderLine(String line)
Add a raw RFC822 header-line.Enumeration<String>
getAllHeaderLines()
Get all header lines as an Enumeration of Strings.String
getContentID()
Get the Content-ID of this part.String[]
getContentLanguage()
Get the language tags specified in the Content-Language header of this MimePart.String
getContentMD5()
Get the Content-MD5 digest of this part.String
getEncoding()
Get the transfer encoding of this part.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.Enumeration<String>
getMatchingHeaderLines(String[] names)
Get matching header lines as an Enumeration of Strings.Enumeration<String>
getNonMatchingHeaderLines(String[] names)
Get non-matching header lines as an Enumeration of Strings.void
setContentLanguage(String[] languages)
Set the Content-Language header of this MimePart.void
setContentMD5(String md5)
Set the Content-MD5 of this part.void
setText(String text)
Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".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.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.-
Methods inherited from interface jakarta.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 name, 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 isnull
, only the first value is returned.- Parameters:
name
- the name of this headerdelimiter
- delimiter between fields in returned string- Returns:
- the value fields for all headers with this name
- Throws:
MessagingException
- for failures
-
addHeaderLine
void addHeaderLine(String line) throws MessagingException
Add a raw RFC822 header-line.- Parameters:
line
- the line to add- Throws:
IllegalWriteException
- if the underlying implementation does not support modificationIllegalStateException
- if this Part is obtained from a READ_ONLY folderMessagingException
- for other failures
-
getAllHeaderLines
Enumeration<String> 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.- Returns:
- an Enumeration of Strings
- Throws:
MessagingException
- for failures
-
getMatchingHeaderLines
Enumeration<String> getMatchingHeaderLines(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.- Parameters:
names
- the headers to return- Returns:
- an Enumeration of Strings
- Throws:
MessagingException
- for failures
-
getNonMatchingHeaderLines
Enumeration<String> getNonMatchingHeaderLines(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.- Parameters:
names
- the headers to not return- Returns:
- an Enumeration of Strings
- Throws:
MessagingException
- for failures
-
getEncoding
String getEncoding() throws MessagingException
Get the transfer encoding of this part.- Returns:
- content-transfer-encoding
- Throws:
MessagingException
- for failures
-
getContentID
String getContentID() throws MessagingException
Get the Content-ID of this part. Returns null if none present.- Returns:
- content-ID
- Throws:
MessagingException
- for failures
-
getContentMD5
String getContentMD5() throws MessagingException
Get the Content-MD5 digest of this part. Returns null if none present.- Returns:
- content-MD5
- Throws:
MessagingException
- for failures
-
setContentMD5
void setContentMD5(String md5) throws MessagingException
Set the Content-MD5 of this part.- Parameters:
md5
- the MD5 value- Throws:
IllegalWriteException
- if the underlying implementation does not support modificationIllegalStateException
- if this Part is obtained from a READ_ONLY folderMessagingException
-
getContentLanguage
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. Returnsnull
if this header is not available.- Returns:
- array of content language strings
- Throws:
MessagingException
- for failures
-
setContentLanguage
void setContentLanguage(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 modificationIllegalStateException
- if this Part is obtained from a READ_ONLY folderMessagingException
-
setText
void setText(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
method that takes the charset parameter.- Specified by:
setText
in interfacePart
- Parameters:
text
- the text content to set- Throws:
MessagingException
- if an error occurs- See Also:
setText(String text, String charset)
-
setText
void setText(String text, 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.- Parameters:
text
- the text content to setcharset
- the charset to use for the text- Throws:
MessagingException
- if an error occurs
-
setText
void setText(String text, String charset, String subtype) throws MessagingException
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 setcharset
- the charset to use for the textsubtype
- the MIME subtype to use (e.g., "html")- Throws:
MessagingException
- if an error occurs- Since:
- JavaMail 1.4
-
-