FileDocCategorySizeDatePackage
MimeBodyPart.javaAPI DocGlassfish v2 API49035Mon May 14 15:28:50 BST 2007javax.mail.internet

MimeBodyPart

public class MimeBodyPart extends BodyPart implements MimePart
This class represents a MIME body part. It implements the BodyPart abstract class and the MimePart interface. MimeBodyParts are contained in MimeMultipart objects.

MimeBodyPart uses the InternetHeaders class to parse and store the headers of that body part.


A note on RFC 822 and MIME headers

RFC 822 header fields must contain only US-ASCII characters. MIME allows non ASCII characters to be present in certain portions of certain headers, by encoding those characters. RFC 2047 specifies the rules for doing this. 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.

author
John Mani
author
Bill Shannon
author
Kanwar Oberoi
see
javax.mail.Part
see
javax.mail.internet.MimePart
see
javax.mail.internet.MimeUtility

Fields Summary
private static boolean
setDefaultTextCharset
private static boolean
setContentTypeFileName
private static boolean
encodeFileName
private static boolean
decodeFileName
static boolean
cacheMultipart
protected DataHandler
dh
The DataHandler object representing this Part's content.
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. In this case, content will be null.
protected InternetHeaders
headers
The InternetHeaders object that stores all the headers of this body part.
private 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.
Constructors Summary
public MimeBodyPart()
An empty MimeBodyPart object is created. This body part maybe filled in by a client constructing a multipart message.

	super();
	headers = new InternetHeaders();
    
public MimeBodyPart(InputStream is)
Constructs a MimeBodyPart by reading and parsing the data from the specified input stream. The parser consumes data till the end of the given input stream. The input stream must start at the beginning of a valid MIME body part and must terminate at the end of that body part.

Note that the "boundary" string that delimits body parts must not be included in the input stream. The intention is that the MimeMultipart parser will extract each body part's bytes from a multipart stream and feed them into this constructor, without the delimiter strings.

param
is the body part Input Stream

	if (!(is instanceof ByteArrayInputStream) &&
	    !(is instanceof BufferedInputStream) &&
	    !(is instanceof SharedInputStream))
	    is = new BufferedInputStream(is);
	
	headers = new InternetHeaders(is);

	if (is instanceof SharedInputStream) {
	    SharedInputStream sis = (SharedInputStream)is;
	    contentStream = sis.newStream(sis.getPosition(), -1);
	} else {
	    try {
		content = ASCIIUtility.getBytes(is);
	    } catch (IOException ioex) {
		throw new MessagingException("Error reading input stream", ioex);
	    }
	}

    
public MimeBodyPart(InternetHeaders headers, byte[] content)
Constructs a MimeBodyPart using the given header and content bytes.

Used by providers.

param
headers The header of this part
param
content bytes representing the body of this part.

	super();
	this.headers = headers;
	this.content = content;
    
Methods Summary
public voidaddHeader(java.lang.String name, java.lang.String value)
Add this value to the existing values for this header_name. Note that RFC 822 headers must contain only US-ASCII characters, so a header that contains non US-ASCII characters must be encoded as per the rules of RFC 2047.

param
name header name
param
value header value
see
javax.mail.internet.MimeUtility

	headers.addHeader(name, value);    
    
public voidaddHeaderLine(java.lang.String line)
Add a header line to this body part

	headers.addHeaderLine(line);
    
public voidattachFile(java.io.File file)
Use the specified file to provide the data for this part. The simple file name is used as the file name for this part and the data in the file is used as the data for this part. The encoding will be chosen appropriately for the file data.

param
file the File object to attach
exception
IOException errors related to accessing the file
exception
MessagingException message related errors
since
JavaMail 1.4

    	FileDataSource fds = new FileDataSource(file);   	
        this.setDataHandler(new DataHandler(fds));
        this.setFileName(fds.getName());
    
public voidattachFile(java.lang.String file)
Use the specified file to provide the data for this part. The simple file name is used as the file name for this part and the data in the file is used as the data for this part. The encoding will be chosen appropriately for the file data.

param
file the name of the file to attach
exception
IOException errors related to accessing the file
exception
MessagingException message related errors
since
JavaMail 1.4

    	File f = new File(file);
    	attachFile(f);
    
public java.util.EnumerationgetAllHeaderLines()
Get all header lines as an Enumeration of Strings. A Header line is a raw RFC 822 header line, containing both the "name" and "value" field.

  	return headers.getAllHeaderLines(); 
    
public java.util.EnumerationgetAllHeaders()
Return all the headers from this Message as an Enumeration of Header objects.

	return headers.getAllHeaders();
    
public java.lang.ObjectgetContent()
Return the content as a Java object. The type of the object returned is of course dependent on the content itself. For example, the native format of a text/plain content is usually a String object. The native format for a "multipart" content is always a Multipart subclass. For content types that are unknown to the DataHandler system, an input stream is returned as the content.

This implementation obtains the content from the DataHandler. That is, it invokes getDataHandler().getContent(); If the content is a Multipart or Message object and was created by parsing a stream, the object is cached and returned in subsequent calls so that modifications to the content will not be lost.

return
Object
exception
MessagingException
exception
IOException this is typically thrown by the DataHandler. Refer to the documentation for javax.activation.DataHandler for more details.

	if (cachedContent != null)
	    return cachedContent;
	Object c;
	try {
	    c = getDataHandler().getContent();
	} catch (FolderClosedIOException fex) {
	    throw new FolderClosedException(fex.getFolder(), fex.getMessage());
	} catch (MessageRemovedIOException mex) {
	    throw new MessageRemovedException(mex.getMessage());
	}
	if (cacheMultipart &&
		(c instanceof Multipart || c instanceof Message) &&
		(content != null || contentStream != null)) {
	    cachedContent = c;
	}
	return c;
    
public java.lang.StringgetContentID()
Returns the value of the "Content-ID" header field. Returns null if the field is unavailable or its value is absent.

This implementation uses getHeader(name) to obtain the requisite header field.

	return getHeader("Content-Id", null);
    
public java.lang.String[]getContentLanguage()
Get the languages 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 or its value is absent.

This implementation uses getHeader(name) to obtain the requisite header field.

	return getContentLanguage(this);
    
static java.lang.String[]getContentLanguage(javax.mail.internet.MimePart part)

	String s = part.getHeader("Content-Language", null);

	if (s == null)
	    return null;

	// Tokenize the header to obtain the Language-tags (skip comments)
	HeaderTokenizer h = new HeaderTokenizer(s, HeaderTokenizer.MIME);
	Vector v = new Vector();

	HeaderTokenizer.Token tk;
	int tkType;

	while (true) {
	    tk = h.next(); // get a language-tag
	    tkType = tk.getType();
	    if (tkType == HeaderTokenizer.Token.EOF)
		break; // done
	    else if (tkType == HeaderTokenizer.Token.ATOM)
		v.addElement(tk.getValue());
	    else // invalid token, skip it.
		continue;
	}

	if (v.size() == 0)
	    return null;

	String[] language = new String[v.size()];
	v.copyInto(language);
	return language;	
    
public java.lang.StringgetContentMD5()
Return the value of the "Content-MD5" header field. Returns null if this field is unavailable or its value is absent.

This implementation uses getHeader(name) to obtain the requisite header field.

	return getHeader("Content-MD5", null);
    
protected java.io.InputStreamgetContentStream()
Produce the raw bytes of the content. This method is used when creating a DataHandler object for the content. Subclasses that can provide a separate input stream for just the Part content might want to override this method.

see
#content
see
MimeMessage#getContentStream

	if (contentStream != null)
	    return ((SharedInputStream)contentStream).newStream(0, -1);
	if (content != null)
	    return new ByteArrayInputStream(content);
	
	throw new MessagingException("No content");
    
public java.lang.StringgetContentType()
Returns the value of the RFC 822 "Content-Type" header field. This represents the content type of the content of this body part. This value must not be null. If this field is unavailable, "text/plain" should be returned.

This implementation uses getHeader(name) to obtain the requisite header field.

return
Content-Type of this body part

	String s = getHeader("Content-Type", null);
	if (s == null)
	    s = "text/plain";
	
	return s;
    
public javax.activation.DataHandlergetDataHandler()
Return a DataHandler for this body part's content.

The implementation provided here works just like the the implementation in MimeMessage.

see
MimeMessage#getDataHandler

	if (dh == null)
	    dh = new DataHandler(new MimePartDataSource(this));
	return dh;
    
public java.lang.StringgetDescription()
Returns the "Content-Description" header field of this body part. This typically associates some descriptive information with this part. Returns null if this field is unavailable or its value is absent.

If the Content-Description field is encoded as per RFC 2047, it is decoded and converted into Unicode. If the decoding or conversion fails, the raw data is returned as is.

This implementation uses getHeader(name) to obtain the requisite header field.

return
content description

	return getDescription(this);
    
static java.lang.StringgetDescription(javax.mail.internet.MimePart part)

	String rawvalue = part.getHeader("Content-Description", null);

	if (rawvalue == null)
	    return null;

	try {
	    return MimeUtility.decodeText(MimeUtility.unfold(rawvalue));
	} catch (UnsupportedEncodingException ex) {
	    return rawvalue;
	}
    
static java.lang.StringgetDisposition(javax.mail.internet.MimePart part)

	String s = part.getHeader("Content-Disposition", null);

	if (s == null)
	    return null;

	ContentDisposition cd = new ContentDisposition(s);
	return cd.getDisposition();
    
public java.lang.StringgetDisposition()
Returns the value of the "Content-Disposition" header field. This represents the disposition of this part. The disposition describes how the part should be presented to the user.

If the Content-Disposition field is unavailable, null is returned.

This implementation uses getHeader(name) to obtain the requisite header field.

see
#headers

	return getDisposition(this);
    
public java.lang.StringgetEncoding()
Returns the content transfer encoding from the "Content-Transfer-Encoding" header field. Returns null if the header is unavailable or its value is absent.

This implementation uses getHeader(name) to obtain the requisite header field.

see
#headers

	return getEncoding(this);
    
static java.lang.StringgetEncoding(javax.mail.internet.MimePart part)

	String s = part.getHeader("Content-Transfer-Encoding", null);

	if (s == null)
	    return null;

	s = s.trim();	// get rid of trailing spaces
	// quick check for known values to avoid unnecessary use
	// of tokenizer.
	if (s.equalsIgnoreCase("7bit") || s.equalsIgnoreCase("8bit") ||
		s.equalsIgnoreCase("quoted-printable") ||
		s.equalsIgnoreCase("binary") ||
		s.equalsIgnoreCase("base64"))
	    return s;

	// Tokenize the header to obtain the encoding (skip comments)
	HeaderTokenizer h = new HeaderTokenizer(s, HeaderTokenizer.MIME);

	HeaderTokenizer.Token tk;
	int tkType;

	for (;;) {
	    tk = h.next(); // get a token
	    tkType = tk.getType();
	    if (tkType == HeaderTokenizer.Token.EOF)
		break; // done
	    else if (tkType == HeaderTokenizer.Token.ATOM)
		return tk.getValue();
	    else // invalid token, skip it.
		continue;
	}
	return s;
    
public java.lang.StringgetFileName()
Get the filename associated with this body part.

Returns the value of the "filename" parameter from the "Content-Disposition" header field of this body part. If its not available, returns the value of the "name" parameter from the "Content-Type" header field of this body part. Returns null if both are absent.

If the mail.mime.encodefilename System property is set to true, the {@link MimeUtility#decodeText MimeUtility.decodeText} method will be used to decode the filename. While such encoding is not supported by the MIME spec, many mailers use this technique to support non-ASCII characters in filenames. The default value of this property is false.

return
filename

	return getFileName(this);
    
static java.lang.StringgetFileName(javax.mail.internet.MimePart part)

	String filename = null;
	String s = part.getHeader("Content-Disposition", null);

	if (s != null) {
	    // Parse the header ..
	    ContentDisposition cd = new ContentDisposition(s);
	    filename = cd.getParameter("filename");
	}
	if (filename == null) {
	    // Still no filename ? Try the "name" ContentType parameter
	    s = part.getHeader("Content-Type", null);
	    if (s != null) {
		try {
		    ContentType ct = new ContentType(s);
		    filename = ct.getParameter("name");
		} catch (ParseException pex) { }	// ignore it
	    }
	}
	if (decodeFileName && filename != null) {
	    try {
		filename = MimeUtility.decodeText(filename);
	    } catch (UnsupportedEncodingException ex) {
		throw new MessagingException("Can't decode filename", ex);
	    }
	}
	return filename;
    
public java.lang.String[]getHeader(java.lang.String name)
Get all the headers for this header_name. Note that certain headers may be encoded as per RFC 2047 if they contain non US-ASCII characters and these should be decoded.

param
name name of header
return
array of headers
see
javax.mail.internet.MimeUtility

	return headers.getHeader(name);
    
public java.lang.StringgetHeader(java.lang.String name, java.lang.String delimiter)
Get all the headers for this header name, returned as a single String, with headers separated by the delimiter. If the delimiter is null, only the first header is returned.

param
name the name of this header
param
delimiter delimiter between fields in returned string
return
the value fields for all headers with this name
exception
MessagingException

	return headers.getHeader(name, delimiter);
    
public java.io.InputStreamgetInputStream()
Return a decoded input stream for this body part's "content".

This implementation obtains the input stream from the DataHandler. That is, it invokes getDataHandler().getInputStream();

return
an InputStream
exception
MessagingException
exception
IOException this is typically thrown by the DataHandler. Refer to the documentation for javax.activation.DataHandler for more details.
see
#getContentStream
see
javax.activation.DataHandler#getInputStream

	return getDataHandler().getInputStream();
    
public intgetLineCount()
Return the number of lines for the content of this Part. Return -1 if this number cannot be determined.

Note that this number may not be an exact measure of the content length and may or may not account for any transfer encoding of the content.

This implementation returns -1.

return
number of lines, or -1 if not known

	return -1;
     
public java.util.EnumerationgetMatchingHeaderLines(java.lang.String[] names)
Get matching header lines as an Enumeration of Strings. A Header line is a raw RFC 822 header line, containing both the "name" and "value" field.

	return headers.getMatchingHeaderLines(names);
    
public java.util.EnumerationgetMatchingHeaders(java.lang.String[] names)
Return matching headers from this Message as an Enumeration of Header objects.

	return headers.getMatchingHeaders(names);
    
public java.util.EnumerationgetNonMatchingHeaderLines(java.lang.String[] names)
Get non-matching header lines as an Enumeration of Strings. A Header line is a raw RFC 822 header line, containing both the "name" and "value" field.

	return headers.getNonMatchingHeaderLines(names);
    
public java.util.EnumerationgetNonMatchingHeaders(java.lang.String[] names)
Return non-matching headers from this Message as an Enumeration of Header objects.

	return headers.getNonMatchingHeaders(names);
    
public java.io.InputStreamgetRawInputStream()
Return an InputStream to the raw data with any Content-Transfer-Encoding intact. This method is useful if the "Content-Transfer-Encoding" header is incorrect or corrupt, which would prevent the getInputStream method or getContent method from returning the correct data. In such a case the application may use this method and attempt to decode the raw data itself.

This implementation simply calls the getContentStream method.

see
#getInputStream
see
#getContentStream
since
JavaMail 1.2

	return getContentStream();
    
public intgetSize()
Return the size of the content of this body part in bytes. Return -1 if the size cannot be determined.

Note that this number may not be an exact measure of the content size and may or may not account for any transfer encoding of the content.

This implementation returns the size of the content array (if not null), or, if contentStream is not null, and the available method returns a positive number, it returns that number as the size. Otherwise, it returns -1.

return
size in bytes, or -1 if not known

	if (content != null)
	    return content.length;
	if (contentStream != null) {
	    try {
		int size = contentStream.available();
		// only believe the size if it's greate than zero, since zero
		// is the default returned by the InputStream class itself
		if (size > 0)
		    return size;
	    } catch (IOException ex) {
		// ignore it
	    }
	}
	return -1;
    
static voidinvalidateContentHeaders(javax.mail.internet.MimePart part)

	part.removeHeader("Content-Type");
	part.removeHeader("Content-Transfer-Encoding");
    
static booleanisMimeType(javax.mail.internet.MimePart part, java.lang.String mimeType)

	// XXX - lots of room for optimization here!
	try {
	    ContentType ct = new ContentType(part.getContentType());
	    return ct.match(mimeType);
	} catch (ParseException ex) {
	    return part.getContentType().equalsIgnoreCase(mimeType);
	}
    
public booleanisMimeType(java.lang.String mimeType)
Is this Part of the specified MIME type? This method compares only the primaryType and subType. The parameters of the content types are ignored.

For example, this method will return true when comparing a Part of content type "text/plain" with "text/plain; charset=foobar".

If the subType of mimeType is the special character '*', then the subtype is ignored during the comparison.

	return isMimeType(this, mimeType);
    
public voidremoveHeader(java.lang.String name)
Remove all headers with this name.

	headers.removeHeader(name);
    
public voidsaveFile(java.io.File file)
Save the contents of this part in the specified file. The content is decoded and saved, without any of the MIME headers.

param
file the File object to write to
exception
IOException errors related to accessing the file
exception
MessagingException message related errors
since
JavaMail 1.4

    	OutputStream out = null;
        InputStream in = null;
        try {
	    out = new BufferedOutputStream(new FileOutputStream(file));
	    in = this.getInputStream();
	    byte[] buf = new byte[8192];
	    int len;
	    while ((len = in.read(buf)) > 0)
		out.write(buf, 0, len); 
        } finally {
	    // close streams, but don't mask original exception, if any
	    try {
		if (in != null)
		    in.close();
	    } catch (IOException ex) { }
	    try {
		if (out != null)
		    out.close();
	    } catch (IOException ex) { }
        }
    
public voidsaveFile(java.lang.String file)
Save the contents of this part in the specified file. The content is decoded and saved, without any of the MIME headers.

param
file the name of the file to write to
exception
IOException errors related to accessing the file
exception
MessagingException message related errors
since
JavaMail 1.4

    	File f = new File(file);
    	saveFile(f);
    
public voidsetContent(java.lang.Object o, java.lang.String type)
A convenience method for setting this body part's content.

The content is wrapped in a DataHandler object. Note that a DataContentHandler class for the specified type should be available to the JavaMail implementation for this to work right. That is, to do setContent(foobar, "application/x-foobar"), a DataContentHandler for "application/x-foobar" should be installed. Refer to the Java Activation Framework for more information.

param
o the content object
param
type Mime type of the object
exception
IllegalWriteException if the underlying implementation does not support modification of existing values
exception
IllegalStateException if this body part is obtained from a READ_ONLY folder.

	if (o instanceof Multipart) {
	    setContent((Multipart)o);
	} else {
	    setDataHandler(new DataHandler(o, type));
	}
    
public voidsetContent(javax.mail.Multipart mp)
This method sets the body part's content to a Multipart object.

param
mp The multipart object that is the Message's content
exception
IllegalWriteException if the underlying implementation does not support modification of existing values.
exception
IllegalStateException if this body part is obtained from a READ_ONLY folder.

	setDataHandler(new DataHandler(mp, mp.getContentType()));
	mp.setParent(this);
    
public voidsetContentID(java.lang.String cid)
Set the "Content-ID" header field of this body part. If the cid parameter is null, any existing "Content-ID" is removed.

exception
IllegalWriteException if the underlying implementation does not support modification
exception
IllegalStateException if this body part is obtained from a READ_ONLY folder.
exception
MessagingException
since
JavaMail 1.3

	if (cid == null)
	    removeHeader("Content-ID");
	else
	    setHeader("Content-ID", cid);
    
public voidsetContentLanguage(java.lang.String[] languages)
Set the Content-Language header of this MimePart. The Content-Language header is defined by RFC 1766.

param
languages array of language tags

	setContentLanguage(this, languages);
    
static voidsetContentLanguage(javax.mail.internet.MimePart part, java.lang.String[] languages)

	StringBuffer sb = new StringBuffer(languages[0]);
	for (int i = 1; i < languages.length; i++)
	    sb.append(',").append(languages[i]);
	part.setHeader("Content-Language", sb.toString());
    
public voidsetContentMD5(java.lang.String md5)
Set the "Content-MD5" header field of this body part.

exception
IllegalWriteException if the underlying implementation does not support modification
exception
IllegalStateException if this body part is obtained from a READ_ONLY folder.

	setHeader("Content-MD5", md5);
    
public voidsetDataHandler(javax.activation.DataHandler dh)
This method provides the mechanism to set this body part's content. The given DataHandler object should wrap the actual content.

param
dh The DataHandler for the content
exception
IllegalWriteException if the underlying implementation does not support modification
exception
IllegalStateException if this body part is obtained from a READ_ONLY folder.

	this.dh = dh;
	cachedContent = null;
	MimeBodyPart.invalidateContentHeaders(this);
    
public voidsetDescription(java.lang.String description)
Set the "Content-Description" header field for this body part. If the description parameter is null, then any existing "Content-Description" fields are removed.

If the description contains non US-ASCII characters, it will be encoded using the platform's default charset. If the description contains only US-ASCII characters, no encoding is done and it is used as is.

Note that if the charset encoding process fails, a MessagingException is thrown, and an UnsupportedEncodingException is included in the chain of nested exceptions within the MessagingException.

param
description content description
exception
IllegalWriteException if the underlying implementation does not support modification
exception
IllegalStateException if this body part is obtained from a READ_ONLY folder.
exception
MessagingException otherwise; an UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.

	setDescription(description, null);
    
public voidsetDescription(java.lang.String description, java.lang.String charset)
Set the "Content-Description" header field for this body part. If the description parameter is null, then any existing "Content-Description" fields are removed.

If the description contains non US-ASCII characters, it will be encoded using the specified charset. If the description contains only US-ASCII characters, no encoding is done and it is used as is.

Note that if the charset encoding process fails, a MessagingException is thrown, and an UnsupportedEncodingException is included in the chain of nested exceptions within the MessagingException.

param
description Description
param
charset Charset for encoding
exception
IllegalWriteException if the underlying implementation does not support modification
exception
IllegalStateException if this body part is obtained from a READ_ONLY folder.
exception
MessagingException otherwise; an UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.

	setDescription(this, description, charset);
    
static voidsetDescription(javax.mail.internet.MimePart part, java.lang.String description, java.lang.String charset)

	if (description == null) {
	    part.removeHeader("Content-Description");
	    return;
	}
	
	try {
	    part.setHeader("Content-Description", MimeUtility.fold(21,
		MimeUtility.encodeText(description, charset, null)));
	} catch (UnsupportedEncodingException uex) {
	    throw new MessagingException("Encoding error", uex);
	}
    
static voidsetDisposition(javax.mail.internet.MimePart part, java.lang.String disposition)

	if (disposition == null)
	    part.removeHeader("Content-Disposition");
	else {
	    String s = part.getHeader("Content-Disposition", null);
	    if (s != null) { 
		/* A Content-Disposition header already exists ..
		 *
		 * Override disposition, but attempt to retain 
		 * existing disposition parameters
		 */
		ContentDisposition cd = new ContentDisposition(s);
		cd.setDisposition(disposition);
		disposition = cd.toString();
	    }
	    part.setHeader("Content-Disposition", disposition);
	}
    
public voidsetDisposition(java.lang.String disposition)
Set the "Content-Disposition" header field of this body part. If the disposition is null, any existing "Content-Disposition" header field is removed.

exception
IllegalWriteException if the underlying implementation does not support modification
exception
IllegalStateException if this body part is obtained from a READ_ONLY folder.

	setDisposition(this, disposition);
    
static voidsetEncoding(javax.mail.internet.MimePart part, java.lang.String encoding)

	part.setHeader("Content-Transfer-Encoding", encoding);
    
public voidsetFileName(java.lang.String filename)
Set the filename associated with this body part, if possible.

Sets the "filename" parameter of the "Content-Disposition" header field of this body part. For compatibility with older mailers, the "name" parameter of the "Content-Type" header is also set.

If the mail.mime.encodefilename System property is set to true, the {@link MimeUtility#encodeText MimeUtility.encodeText} method will be used to encode the filename. While such encoding is not supported by the MIME spec, many mailers use this technique to support non-ASCII characters in filenames. The default value of this property is false.

exception
IllegalWriteException if the underlying implementation does not support modification
exception
IllegalStateException if this body part is obtained from a READ_ONLY folder.

	setFileName(this, filename);
    
static voidsetFileName(javax.mail.internet.MimePart part, java.lang.String name)

	if (encodeFileName && name != null) {
	    try {
		name = MimeUtility.encodeText(name);
	    } catch (UnsupportedEncodingException ex) {
		throw new MessagingException("Can't encode filename", ex);
	    }
	}

	// Set the Content-Disposition "filename" parameter
	String s = part.getHeader("Content-Disposition", null);
	ContentDisposition cd = 
		new ContentDisposition(s == null ? Part.ATTACHMENT : s);
	cd.setParameter("filename", name);
	part.setHeader("Content-Disposition", cd.toString());

	/*
	 * Also attempt to set the Content-Type "name" parameter,
	 * to satisfy ancient MUAs.  XXX - This is not RFC compliant.
	 */
	if (setContentTypeFileName) {
	    s = part.getHeader("Content-Type", null);
	    if (s != null) {
		try {
		    ContentType cType = new ContentType(s);
		    cType.setParameter("name", name);
		    part.setHeader("Content-Type", cType.toString());
		} catch (ParseException pex) { }	// ignore it
	    }
	}
    
public voidsetHeader(java.lang.String name, java.lang.String value)
Set the value for this header_name. Replaces all existing header values with this new value. Note that RFC 822 headers must contain only US-ASCII characters, so a header that contains non US-ASCII characters must be encoded as per the rules of RFC 2047.

param
name header name
param
value header value
see
javax.mail.internet.MimeUtility

	headers.setHeader(name, value);
    
public voidsetText(java.lang.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.

param
text the text content to set
exception
MessagingException if an error occurs
see
#setText(String text, String charset)

	setText(text, null);
    
public voidsetText(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. The given Unicode string will be charset-encoded using the specified charset. The charset is also used to set the "charset" parameter.

param
text the text content to set
param
charset the charset to use for the text
exception
MessagingException if an error occurs

	setText(this, text, charset, "plain");
    
public voidsetText(java.lang.String text, java.lang.String charset, java.lang.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.

param
text the text content to set
param
charset the charset to use for the text
param
subtype the MIME subtype to use (e.g., "html")
exception
MessagingException if an error occurs
since
JavaMail 1.4

	setText(this, text, charset, subtype);
    
static voidsetText(javax.mail.internet.MimePart part, java.lang.String text, java.lang.String charset, java.lang.String subtype)

	if (charset == null) {
	    if (MimeUtility.checkAscii(text) != MimeUtility.ALL_ASCII)
		charset = MimeUtility.getDefaultMIMECharset();
	    else
		charset = "us-ascii";
	}
	// XXX - should at least ensure that subtype is an atom
	part.setContent(text, "text/" + subtype + "; charset=" +
			MimeUtility.quote(charset, HeaderTokenizer.MIME));
    
protected voidupdateHeaders()
Examine the content of this body part and update the appropriate MIME headers. Typical headers that get set here are Content-Type and Content-Transfer-Encoding. Headers might need to be updated in two cases:
- A message being crafted by a mail application will certainly need to activate this method at some point to fill up its internal headers.
- A message read in from a Store will have obtained all its headers from the store, and so doesn't need this. However, if this message is editable and if any edits have been made to either the content or message structure, we might need to resync our headers.
In both cases this method is typically called by the Message.saveChanges method.

	updateHeaders(this);
	/*
	 * If we've cached a Multipart or Message object then
	 * we're now committed to using this instance of the
	 * object and we discard any stream data used to create
	 * this object.
	 */
	if (cachedContent != null) {
	    dh = new DataHandler(cachedContent, getContentType());
	    cachedContent = null;
	    content = null;
	    if (contentStream != null) {
		try {
		    contentStream.close();
		} catch (IOException ioex) { }	// nothing to do
	    }
	    contentStream = null;
	}
    
static voidupdateHeaders(javax.mail.internet.MimePart part)

	DataHandler dh = part.getDataHandler();
	if (dh == null) // Huh ?
	    return;

	try {
	    String type = dh.getContentType();
	    boolean composite = false;
	    boolean needCTHeader = part.getHeader("Content-Type") == null;

	    ContentType cType = new ContentType(type);
	    if (cType.match("multipart/*")) {
		// If multipart, recurse
		composite = true;
		Object o;
		if (part instanceof MimeBodyPart) {
		    MimeBodyPart mbp = (MimeBodyPart)part;
		    o = mbp.cachedContent != null ?
				mbp.cachedContent : dh.getContent();
		} else if (part instanceof MimeMessage) {
		    MimeMessage msg = (MimeMessage)part;
		    o = msg.cachedContent != null ?
				msg.cachedContent : dh.getContent();
		} else
		    o = dh.getContent();
		if (o instanceof MimeMultipart)
		    ((MimeMultipart)o).updateHeaders();
		else
		    throw new MessagingException("MIME part of type \"" +
			type + "\" contains object of type " +
			o.getClass().getName() + " instead of MimeMultipart");
	    } else if (cType.match("message/rfc822")) {
		composite = true;
		// XXX - call MimeMessage.updateHeaders()?
	    }

	    // Content-Transfer-Encoding, but only if we don't
	    // already have one
	    if (!composite) {	// not allowed on composite parts
		if (part.getHeader("Content-Transfer-Encoding") == null)
		    setEncoding(part, MimeUtility.getEncoding(dh));

		if (needCTHeader && setDefaultTextCharset &&
			cType.match("text/*") &&
			cType.getParameter("charset") == null) {
		    /*
		     * Set a default charset for text parts.
		     * We really should examine the data to determine
		     * whether or not it's all ASCII, but that's too
		     * expensive so we make an assumption:  If we
		     * chose 7bit encoding for this data, it's probably
		     * ASCII.  (MimeUtility.getEncoding will choose
		     * 7bit only in this case, but someone might've
		     * set the Content-Transfer-Encoding header manually.)
		     */
		    String charset;
		    String enc = part.getEncoding();
		    if (enc != null && enc.equalsIgnoreCase("7bit"))
			charset = "us-ascii";
		    else
			charset = MimeUtility.getDefaultMIMECharset();
		    cType.setParameter("charset", charset);
		    type = cType.toString();
		}
	    }

	    // Now, let's update our own headers ...

	    // Content-type, but only if we don't already have one
	    if (needCTHeader) {
		/*
		 * Pull out "filename" from Content-Disposition, and
		 * use that to set the "name" parameter. This is to
		 * satisfy older MUAs (DtMail, Roam and probably
		 * a bunch of others).
		 */
		String s = part.getHeader("Content-Disposition", null);
		if (s != null) {
		    // Parse the header ..
		    ContentDisposition cd = new ContentDisposition(s);
		    String filename = cd.getParameter("filename");
		    if (filename != null) {
			cType.setParameter("name", filename);
			type = cType.toString();
		    }
		}
		
		part.setHeader("Content-Type", type);
	    }
	} catch (IOException ex) {
	    throw new MessagingException("IOException updating headers", ex);
	}
    
public voidwriteTo(java.io.OutputStream os)
Output the body part as an RFC 822 format stream.

exception
MessagingException
exception
IOException if an error occurs writing to the stream or if an error is generated by the javax.activation layer.
see
javax.activation.DataHandler#writeTo

	writeTo(this, os, null);
    
static voidwriteTo(javax.mail.internet.MimePart part, java.io.OutputStream os, java.lang.String[] ignoreList)


	// see if we already have a LOS
	LineOutputStream los = null;
	if (os instanceof LineOutputStream) {
	    los = (LineOutputStream) os;
	} else {
	    los = new LineOutputStream(os);
	}

	// First, write out the header
	Enumeration hdrLines = part.getNonMatchingHeaderLines(ignoreList);
	while (hdrLines.hasMoreElements())
	    los.writeln((String)hdrLines.nextElement());

	// The CRLF separator between header and content
	los.writeln();

	// Finally, the content. Encode if required.
	// XXX: May need to account for ESMTP ?
	os = MimeUtility.encode(os, part.getEncoding());
	part.getDataHandler().writeTo(os);
	os.flush(); // Needed to complete encoding