|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /usr/share/javadoc/javamail/javax/mail/ |
Upload File : |
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>Multipart (GNU JavaMail API documentation)</title><script src="../../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="javax.mail.Multipart class"/><meta name="keywords" content="parts"/><meta name="keywords" content="contentType"/><meta name="keywords" content="parent"/><meta name="keywords" content="setMultipartDataSource()"/><meta name="keywords" content="getContentType()"/><meta name="keywords" content="getCount()"/><meta name="keywords" content="getBodyPart()"/><meta name="keywords" content="removeBodyPart()"/><meta name="keywords" content="addBodyPart()"/><meta name="keywords" content="writeTo()"/><meta name="keywords" content="getParent()"/><meta name="keywords" content="setParent()"/><link rel="stylesheet" type="text/css" href="../../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="Multipart-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../about.html">About</a></span></div></td></tr><tr><td class="navi"><a href="../../javax/mail/MethodNotSupportedException.html">Prev Class</a> | <a href="../../javax/mail/MultipartDataSource.html">Next Class</a></td><td class="navi"><a href="../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="Multipart.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | <a href="#summary-fields">Field</a> | <a href="#summary-methods">Method</a> | <a href="#summary-constructors">Constr</a></td><td class="navi">Detail: Nested | <a href="#detail-fields">Field</a> | <a href="#detail-methods">Method</a> | <a href="#detail-constructors">Constr</a></td></tr></table><div class="class title outer"><h3 class="class title-package">javax.mail</h3><h1 class="class title-class">Class Multipart</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code><a href="file:/usr/share/javadoc/java/java/lang/Object.html">java.lang.Object</a></code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>javax.mail.Multipart</code></li><li></li></ul></li></ul></div><dl class="class subclasses"><dt class="class subclasses header"><b>Known Direct Subclasses:</b></dt><dd class="class subclasses header"><a href="../../javax/mail/internet/MimeMultipart.html" title="Class in javax.mail.internet">MimeMultipart</a></dd></b></dt></dl><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public abstract class <b class="class synopsis name">Multipart</b></code></div><div class="class synopsis superclass"><code>extends <a href="file:/usr/share/javadoc/java/java/lang/Object.html" title="Class in ">Object</a></code></div></div><hr/><div class="class description"> Multipart is a container that holds multiple body parts.
Multipart provides methods to retrieve and set its subparts.
<p/>
Multipart also acts as the base class for the content object returned by
most Multipart DataContentHandlers. For example, invoking
<code>getContent()</code> on a DataHandler whose source is a
"multipart/signed" data source may return an appropriate subclass
of Multipart.
<p/>
Some messaging systems provide different subtypes of Multiparts.
For example, MIME specifies a set of subtypes that include
"alternative", "mixed", "related", "parallel", "signed", etc.
<p/>
Multipart is an abstract class. Subclasses provide actual implementations.
</div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Author:</b></dt><dd class="tag item"><a href="mailto:dog@gnu.org">Chris Burdess</a></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><a name="summary-fields" id="summary-fields"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Field Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#contentType">contentType</a></code></dt><dd class="description"> This field specifies the content-type of this multipart object.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected <a href="../../javax/mail/Part.html" title="Interface in javax.mail">Part</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#parent">parent</a></code></dt><dd class="description"> The Part containing this Multipart, if known.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected List</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#parts">parts</a></code></dt><dd class="description"> List of BodyPart objects.</dd></dl></td></tr></table></dd></dl><a name="summary-constructors" id="summary-constructors"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Constructor Summary</h2></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#Multipart()">Multipart</a>()</code></dt><dd class="description"> Default constructor.</dd></dl></td></tr></table></dd></dl><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#addBodyPart(javax.mail.BodyPart)">addBodyPart</a>(<a href="../../javax/mail/BodyPart.html" title="Class in javax.mail">BodyPart</a> part)</code></dt><dd class="description"> Adds a Part to the multipart.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#addBodyPart(javax.mail.BodyPart,int)">addBodyPart</a>(<a href="../../javax/mail/BodyPart.html" title="Class in javax.mail">BodyPart</a> part, int index)</code></dt><dd class="description"> Adds a BodyPart at position index.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../../javax/mail/BodyPart.html" title="Class in javax.mail">BodyPart</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getBodyPart(int)">getBodyPart</a>(int index)</code></dt><dd class="description"> Get the specified Part.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getContentType()">getContentType</a>()</code></dt><dd class="description"> Return the content-type of this Multipart.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getCount()">getCount</a>()</code></dt><dd class="description"> Return the number of enclosed BodyPart objects.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../../javax/mail/Part.html" title="Interface in javax.mail">Part</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getParent()">getParent</a>()</code></dt><dd class="description"> Return the Part that contains this Multipart object, or null if not known.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#removeBodyPart(int)">removeBodyPart</a>(int index)</code></dt><dd class="description"> Remove the part at specified location (starting from 0).</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#removeBodyPart(javax.mail.BodyPart)">removeBodyPart</a>(<a href="../../javax/mail/BodyPart.html" title="Class in javax.mail">BodyPart</a> part)</code></dt><dd class="description"> Remove the specified part from the multipart message.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setMultipartDataSource(javax.mail.MultipartDataSource)">setMultipartDataSource</a>(<a href="../../javax/mail/MultipartDataSource.html" title="Interface in javax.mail">MultipartDataSource</a> mp)</code></dt><dd class="description"> Setup this Multipart object from the given MultipartDataSource.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setParent(javax.mail.Part)">setParent</a>(<a href="../../javax/mail/Part.html" title="Interface in javax.mail">Part</a> part)</code></dt><dd class="description"> Set the parent of this Multipart to be the specified Part.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">abstract void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#writeTo(OutputStream)">writeTo</a>(OutputStream os)</code></dt><dd class="description"> Output an appropriately encoded bytestream to the given OutputStream.</dd></dl></td></tr></table></dd></dl><a name="detail-fields" id="detail-fields"/><h2 class="section header">Field Details</h2><div class="section"><a name="contentType" id="contentType"/><div class="member detail outer"><h3 class="member detail name">contentType</h3><pre class="member detail synopsis">protected String contentType</pre><blockquote class="member detail name"><div class="member detail description"> This field specifies the content-type of this multipart object.
It defaults to "multipart/mixed".
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="parent" id="parent"/><div class="member detail outer"><h3 class="member detail name">parent</h3><pre class="member detail synopsis">protected <a href="../../javax/mail/Part.html" title="Interface in javax.mail">Part</a> parent</pre><blockquote class="member detail name"><div class="member detail description"> The Part containing this Multipart, if known.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="parts" id="parts"/><div class="member detail outer"><h3 class="member detail name">parts</h3><pre class="member detail synopsis">protected List parts</pre><blockquote class="member detail name"><div class="member detail description"> List of BodyPart objects.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-constructors" id="detail-constructors"/><h2 class="section header">Constructor Details</h2><div class="section"><a name="Multipart()" id="Multipart()"/><div class="member detail outer"><h3 class="member detail name">Multipart</h3><pre class="member detail synopsis">protected Multipart()</pre><blockquote class="member detail name"><div class="member detail description"> Default constructor. An empty Multipart object is created.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="addBodyPart(javax.mail.BodyPart)" id="addBodyPart(javax.mail.BodyPart)"/><div class="member detail outer"><h3 class="member detail name">addBodyPart</h3><pre class="member detail synopsis">public void addBodyPart(<a href="../../javax/mail/BodyPart.html" title="Class in javax.mail">BodyPart</a> part)
throws <a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Adds a Part to the multipart.
The BodyPart is appended to the list of existing Parts.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">part</code><span class="separator"> - </span><span class="description">The Part to be appended</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="addBodyPart(javax.mail.BodyPart,int)" id="addBodyPart(javax.mail.BodyPart,int)"/><div class="member detail outer"><h3 class="member detail name">addBodyPart</h3><pre class="member detail synopsis">public void addBodyPart(<a href="../../javax/mail/BodyPart.html" title="Class in javax.mail">BodyPart</a> part,
int index)
throws <a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Adds a BodyPart at position index.
If index is not the last one in the list, the subsequent parts
are shifted up. If index is larger than the number of parts present,
the BodyPart is appended to the end.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">part</code><span class="separator"> - </span><span class="description">The BodyPart to be inserted</span></dd><dd class="item"><code class="name">index</code><span class="separator"> - </span><span class="description">Location where to insert the part</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getBodyPart(int)" id="getBodyPart(int)"/><div class="member detail outer"><h3 class="member detail name">getBodyPart</h3><pre class="member detail synopsis">public <a href="../../javax/mail/BodyPart.html" title="Class in javax.mail">BodyPart</a> getBodyPart(int index)
throws <a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Get the specified Part.
Parts are numbered starting at 0.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">index</code><span class="separator"> - </span><span class="description">the index of the desired Part</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getContentType()" id="getContentType()"/><div class="member detail outer"><h3 class="member detail name">getContentType</h3><pre class="member detail synopsis">public String getContentType()</pre><blockquote class="member detail name"><div class="member detail description"> Return the content-type of this Multipart.
<p/>
This implementation just returns the value of the
<code>contentType</code> field.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getCount()" id="getCount()"/><div class="member detail outer"><h3 class="member detail name">getCount</h3><pre class="member detail synopsis">public int getCount()
throws <a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Return the number of enclosed BodyPart objects.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getParent()" id="getParent()"/><div class="member detail outer"><h3 class="member detail name">getParent</h3><pre class="member detail synopsis">public <a href="../../javax/mail/Part.html" title="Interface in javax.mail">Part</a> getParent()</pre><blockquote class="member detail name"><div class="member detail description"> Return the Part that contains this Multipart object, or null if not known.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="removeBodyPart(int)" id="removeBodyPart(int)"/><div class="member detail outer"><h3 class="member detail name">removeBodyPart</h3><pre class="member detail synopsis">public void removeBodyPart(int index)
throws <a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Remove the part at specified location (starting from 0).
Shifts all the parts after the removed part down one.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">index</code><span class="separator"> - </span><span class="description">Index of the part to remove</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="removeBodyPart(javax.mail.BodyPart)" id="removeBodyPart(javax.mail.BodyPart)"/><div class="member detail outer"><h3 class="member detail name">removeBodyPart</h3><pre class="member detail synopsis">public boolean removeBodyPart(<a href="../../javax/mail/BodyPart.html" title="Class in javax.mail">BodyPart</a> part)
throws <a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Remove the specified part from the multipart message.
Shifts all the parts after the removed part down one.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">part</code><span class="separator"> - </span><span class="description">The part to remove</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">true if part removed, false otherwise</dd></dl></div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Throws:</b></dt><dd class="member detail thrown item"><code class="name"><a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></code><span class="separator"> - </span><span class="description">if no such Part exists</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setMultipartDataSource(javax.mail.MultipartDataSource)" id="setMultipartDataSource(javax.mail.MultipartDataSource)"/><div class="member detail outer"><h3 class="member detail name">setMultipartDataSource</h3><pre class="member detail synopsis">protected void setMultipartDataSource(<a href="../../javax/mail/MultipartDataSource.html" title="Interface in javax.mail">MultipartDataSource</a> mp)
throws <a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Setup this Multipart object from the given MultipartDataSource.
<p/>
The method adds the MultipartDataSource's BodyPart objects into this
Multipart. This Multipart's <code>contentType</code> is set to that of
the MultipartDataSource.
<p/>
This method is typically used in those cases where one has a multipart
data source that has already been pre-parsed into the individual body
parts (for example, an IMAP datasource), but needs to create an
appropriate Multipart subclass that represents a specific multipart
subtype.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">mp</code><span class="separator"> - </span><span class="description">Multipart datasource</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setParent(javax.mail.Part)" id="setParent(javax.mail.Part)"/><div class="member detail outer"><h3 class="member detail name">setParent</h3><pre class="member detail synopsis">public void setParent(<a href="../../javax/mail/Part.html" title="Interface in javax.mail">Part</a> part)</pre><blockquote class="member detail name"><div class="member detail description"> Set the parent of this Multipart to be the specified Part.
Normally called by the Message or BodyPart
<code>setContent(Multipart)</code> method. parent may be null if
the Multipart is being removed from its containing Part.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="writeTo(OutputStream)" id="writeTo(OutputStream)"/><div class="member detail outer"><h3 class="member detail name">writeTo</h3><pre class="member detail synopsis">public abstract void writeTo(OutputStream os)
throws IOException,
<a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Output an appropriately encoded bytestream to the given OutputStream.
The implementation subclass decides the appropriate encoding algorithm
to be used. The bytestream is typically used for sending.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="Multipart-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../about.html">About</a></span></div></td></tr></table><hr/>© Copyright 2003, 2004
The Free Software Foundation, All rights reserved</body></html>