Jakarta EE 11.0.0 · jakarta.mail.internet.MimeBodyPart

Modifier and Type	Class and Description
private static class	MimeBodyPart.EncodedFileDataSource A FileDataSource class that allows us to specify the Content-Type and Content-Transfer-Encoding.
pack-priv static class	MimeBodyPart.MimePartDataHandler A special DataHandler used only as a marker to indicate that the source of the data is a MimePart (that is, a byte array or a stream).

Modifier and Type	Field and Description
private static final boolean	allowutf8
protected Object	cachedContent If our content is a Multipart of Message object, we save it the first time it's created by parsing a stream so that changes to the contained objects will not be lost.
pack-priv static final boolean	cacheMultipart
protected byte[]	content Byte array that holds the bytes of the content of this Part.
protected InputStream	contentStream If the data for this body part was supplied by an InputStream that implements the SharedInputStream interface, `contentStream` is another such stream representing the content of this body part.
private static final boolean	decodeFileName
protected DataHandler	dh The DataHandler object representing this Part's content.
private static final boolean	encodeFileName
protected InternetHeaders	headers The InternetHeaders object that stores all the headers of this body part.
private static final boolean	ignoreMultipartEncoding
private static final boolean	setContentTypeFileName
private static final boolean	setDefaultTextCharset

Access	Constructor and Description
public	MimeBodyPart() An empty MimeBodyPart object is created.
public	MimeBodyPart(InputStream the body part Input Stream is) Constructs a MimeBodyPart by reading and parsing the data from the specified input stream.
public	MimeBodyPart(InternetHeaders The header of this part headers, byte[] bytes representing the body of this part. content) Constructs a MimeBodyPart using the given header and content bytes.

Method Summary

Modifier and Type	Method and Description
public void	addHeader(String header name name, String header value value) Implements jakarta.mail.Part.addHeader. Add this value to the existing values for this header_name.
public void	addHeaderLine(String the line to add line) Implements jakarta.mail.internet.MimePart.addHeaderLine. Add a header line to this body part
public void	attachFile(File the File object to attach file) Use the specified file to provide the data for this part.
public void	attachFile(String the name of the file to attach file) Use the specified file to provide the data for this part.
public void	attachFile(File the File object to attach file, String the Content-Type, or null contentType, String the Content-Transfer-Encoding, or null encoding) Use the specified file with the specified Content-Type and Content-Transfer-Encoding to provide the data for this part.
public void	attachFile(String the name of the file file, String the Content-Type, or null contentType, String the Content-Transfer-Encoding, or null encoding) Use the specified file with the specified Content-Type and Content-Transfer-Encoding to provide the data for this part.
public Enumeration<String>	getAllHeaderLines() Implements jakarta.mail.internet.MimePart.getAllHeaderLines. Get all header lines as an Enumeration of Strings.
public Enumeration<Header>	getAllHeaders() Implements jakarta.mail.Part.getAllHeaders. Return all the headers from this Message as an Enumeration of Header objects.
public Object	Returns: Object getContent() Implements jakarta.mail.Part.getContent. Return the content as a Java object.
public String	getContentID() Implements jakarta.mail.internet.MimePart.getContentID. Returns the value of the "Content-ID" header field.
public String[]	getContentLanguage() Implements jakarta.mail.internet.MimePart.getContentLanguage. Get the languages specified in the Content-Language header of this MimePart.
pack-priv static String[]	getContentLanguage(MimePart part)
public String	getContentMD5() Implements jakarta.mail.internet.MimePart.getContentMD5. Return the value of the "Content-MD5" header field.
protected InputStream	Returns: an InputStream containing the raw bytes getContentStream() Produce the raw bytes of the content.
public String	Returns: Content-Type of this body part getContentType() Implements jakarta.mail.Part.getContentType. Returns the value of the RFC 822 "Content-Type" header field.
public DataHandler	getDataHandler() Implements jakarta.mail.Part.getDataHandler. Return a DataHandler for this body part's content.
public String	Returns: content description getDescription() Implements jakarta.mail.Part.getDescription. Returns the "Content-Description" header field of this body part.
pack-priv static String	getDescription(MimePart part)
public String	getDisposition() Implements jakarta.mail.Part.getDisposition. Returns the disposition from the "Content-Disposition" header field.
pack-priv static String	getDisposition(MimePart part)
public String	getEncoding() Implements jakarta.mail.internet.MimePart.getEncoding. Returns the content transfer encoding from the "Content-Transfer-Encoding" header field.
pack-priv static String	getEncoding(MimePart part)
public String	Returns: filename getFileName() Implements jakarta.mail.Part.getFileName. Get the filename associated with this body part.
pack-priv static String	getFileName(MimePart part)
public String[]	Returns: array of headers getHeader(String name of header name) Implements jakarta.mail.Part.getHeader. Get all the headers for this header_name.
public String	Returns: the value fields for all headers with this name getHeader(String the name of this header name, String delimiter between fields in returned string delimiter) Implements jakarta.mail.internet.MimePart.getHeader. Get all the headers for this header name, returned as a single String, with headers separated by the delimiter.
public InputStream	Returns: an InputStream getInputStream() Implements jakarta.mail.Part.getInputStream. Return a decoded input stream for this body part's "content".
public int	Returns: number of lines, or -1 if not known getLineCount() Implements jakarta.mail.Part.getLineCount. Return the number of lines for the content of this Part.
public Enumeration<String>	getMatchingHeaderLines(String[] the headers to return names) Implements jakarta.mail.internet.MimePart.getMatchingHeaderLines. Get matching header lines as an Enumeration of Strings.
public Enumeration<Header>	getMatchingHeaders(String[] the headers to match names) Implements jakarta.mail.Part.getMatchingHeaders. Return matching headers from this Message as an Enumeration of Header objects.
public Enumeration<String>	getNonMatchingHeaderLines(String[] the headers to not return names) Implements jakarta.mail.internet.MimePart.getNonMatchingHeaderLines. Get non-matching header lines as an Enumeration of Strings.
public Enumeration<Header>	getNonMatchingHeaders(String[] the headers to not match names) Implements jakarta.mail.Part.getNonMatchingHeaders. Return non-matching headers from this Message as an Enumeration of Header objects.
public InputStream	Returns: an InputStream containing the raw bytes getRawInputStream() Return an InputStream to the raw data with any Content-Transfer-Encoding intact.
public int	Returns: size in bytes, or -1 if not known getSize() Implements jakarta.mail.Part.getSize. Return the size of the content of this body part in bytes.
pack-priv static void	invalidateContentHeaders(MimePart part)
public boolean	isMimeType(String the MIME type to test mimeType) Implements jakarta.mail.Part.isMimeType. Is this Part of the specified MIME type?
pack-priv static boolean	isMimeType(MimePart part, String mimeType)
public void	removeHeader(String the name of this header name) Implements jakarta.mail.Part.removeHeader. Remove all headers with this name.
pack-priv static String	restrictEncoding(MimePart part, String encoding) Restrict the encoding to values allowed for the Content-Type of the specified MimePart.
public void	saveFile(File the File object to write to file) Save the contents of this part in the specified file.
public void	saveFile(String the name of the file to write to file) Save the contents of this part in the specified file.
public void	setContent(Object the content object o, String Mime type of the object type) Implements jakarta.mail.Part.setContent. A convenience method for setting this body part's content.
public void	setContent(Multipart The multipart object that is the Message's content mp) Implements jakarta.mail.Part.setContent. This method sets the body part's content to a Multipart object.
public void	setContentID(String the Content-ID cid) Set the "Content-ID" header field of this body part.
public void	setContentLanguage(String[] array of language tags languages) Implements jakarta.mail.internet.MimePart.setContentLanguage. Set the Content-Language header of this MimePart.
pack-priv static void	setContentLanguage(MimePart part, String[] languages)
public void	setContentMD5(String the MD5 value md5) Implements jakarta.mail.internet.MimePart.setContentMD5. Set the "Content-MD5" header field of this body part.
public void	setDataHandler(DataHandler The DataHandler for the content dh) Implements jakarta.mail.Part.setDataHandler. This method provides the mechanism to set this body part's content.
public void	setDescription(String content description description) Implements jakarta.mail.Part.setDescription. Set the "Content-Description" header field for this body part.
public void	setDescription(String Description description, String Charset for encoding charset) Set the "Content-Description" header field for this body part.
pack-priv static void	setDescription(MimePart part, String description, String charset)
public void	setDisposition(String disposition of this part disposition) Implements jakarta.mail.Part.setDisposition. Set the disposition in the "Content-Disposition" header field of this body part.
pack-priv static void	setDisposition(MimePart part, String disposition)
pack-priv static void	setEncoding(MimePart part, String encoding)
public void	setFileName(String the file name filename) Implements jakarta.mail.Part.setFileName. Set the filename associated with this body part, if possible.
pack-priv static void	setFileName(MimePart part, String name)
public void	setHeader(String header name name, String header value value) Implements jakarta.mail.Part.setHeader. Set the value for this header_name.
public void	setText(String the text content to set text) Implements jakarta.mail.internet.MimePart.setText, jakarta.mail.Part.setText. Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".
public void	setText(String the text content to set text, String the charset to use for the text charset) Implements jakarta.mail.internet.MimePart.setText. Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset.
public void	setText(String the text content to set text, String the charset to use for the text charset, String the MIME subtype to use (e.g., "html") subtype) Implements jakarta.mail.internet.MimePart.setText. Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype.
pack-priv static void	setText(MimePart part, String text, String charset, String subtype)
protected void	updateHeaders() Examine the content of this body part and update the appropriate MIME headers.
pack-priv static void	updateHeaders(MimePart part)
public void	writeTo(OutputStream the stream to write to os) Implements jakarta.mail.Part.writeTo. Output the body part as an RFC 822 format stream.
pack-priv static void	writeTo(MimePart part, OutputStream os, String[] ignoreList)

Inherited from jakarta.mail.BodyPart:: getParent

public Class MimeBodyPart

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary