|
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>Transport (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.Transport class"/><meta name="keywords" content="send()"/><meta name="keywords" content="sendMessage()"/><meta name="keywords" content="addTransportListener()"/><meta name="keywords" content="removeTransportListener()"/><meta name="keywords" content="notifyTransportListeners()"/><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="Transport-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/StoreClosedException.html">Prev Class</a> | <a href="../../javax/mail/UIDFolder.html">Next Class</a></td><td class="navi"><a href="../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="Transport.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | Field | <a href="#summary-methods">Method</a> | <a href="#summary-constructors">Constr</a></td><td class="navi">Detail: Nested | Field | <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 Transport</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><a href="../../javax/mail/Service.html">javax.mail.Service</a></code></li><li><ul class="inheritance 2"><li class="inheritance 2"><code>javax.mail.Transport</code></li><li></li></ul></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="../../gnu/mail/providers/nntp/NNTPTransport.html" title="Class in gnu.mail.providers.nntp">NNTPTransport</a>, <a href="../../gnu/mail/providers/smtp/SMTPTransport.html" title="Class in gnu.mail.providers.smtp">SMTPTransport</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">Transport</b></code></div><div class="class synopsis superclass"><code>extends <a href="../../javax/mail/Service.html" title="Class in javax.mail">Service</a></code></div></div><hr/><div class="class description"> An abstract class that models a message transport.
Subclasses provide actual implementations.
<p/>
Note that Transport extends the Service class, which provides many common
methods for naming transports, connecting to transports, and listening to
connection events.
</div><div class="taglet"><dl class="tag list"></dl><dt class="tag section header"><b>Version:</b></dt><dd>1.3</dd></dl></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></table></dd></dl><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table sub header"><td colspan="2"><h3 class="table sub header">Fields inherited from class javax.mail.<a href="../../javax/mail/Service.html" title="Class in javax.mail">Service</a></h3></td></tr><tr><td class="inherited"><a href="../../javax/mail/Service.html#debug"><code class="member">debug</code></a>, <a href="../../javax/mail/Service.html#session"><code class="member">session</code></a>, <a href="../../javax/mail/Service.html#url"><code class="member">url</code></a></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="#Transport(javax.mail.Session,javax.mail.URLName)">Transport</a>(<a href="../../javax/mail/Session.html" title="Class in javax.mail">Session</a> session, <a href="../../javax/mail/URLName.html" title="Class in javax.mail">URLName</a> url)</code></dt><dd class="description"> 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="#addTransportListener(javax.mail.event.TransportListener)">addTransportListener</a>(<a href="../../javax/mail/event/TransportListener.html" title="Interface in javax.mail.event">TransportListener</a> l)</code></dt><dd class="description"> Add a listener for Transport events.</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="#notifyTransportListeners(int,javax.mail.Address[],javax.mail.Address[],javax.mail.Address[],javax.mail.Message)">notifyTransportListeners</a>(int type, <a href="../../javax/mail/Address.html" title="Class in javax.mail">Address</a>[] validSent, <a href="../../javax/mail/Address.html" title="Class in javax.mail">Address</a>[] validUnsent, <a href="../../javax/mail/Address.html" title="Class in javax.mail">Address</a>[] invalid, <a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a> msg)</code></dt><dd class="description"> Notify all TransportListeners.</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="#removeTransportListener(javax.mail.event.TransportListener)">removeTransportListener</a>(<a href="../../javax/mail/event/TransportListener.html" title="Interface in javax.mail.event">TransportListener</a> l)</code></dt><dd class="description"> Remove a listener for Transport events.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#send(javax.mail.Message)">send</a>(<a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a> msg)</code></dt><dd class="description"> Send a message.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#send(javax.mail.Message,javax.mail.Address[])">send</a>(<a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a> msg, <a href="../../javax/mail/Address.html" title="Class in javax.mail">Address</a>[] addresses)</code></dt><dd class="description"> Send the message to the specified addresses, ignoring any recipients
specified in the message itself.</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="#sendMessage(javax.mail.Message,javax.mail.Address[])">sendMessage</a>(<a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a> msg, <a href="../../javax/mail/Address.html" title="Class in javax.mail">Address</a>[] addresses)</code></dt><dd class="description"> Send the Message to the specified list of addresses.</dd></dl></td></tr></table></dd></dl><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table sub header"><td colspan="2"><h3 class="table sub header">Methods inherited from class javax.mail.<a href="../../javax/mail/Service.html" title="Class in javax.mail">Service</a></h3></td></tr><tr><td class="inherited"><a href="../../javax/mail/Service.html#addConnectionListener(javax.mail.event.ConnectionListener)" title="addConnectionListener(ConnectionListener)"><code class="member">addConnectionListener</code></a>, <a href="../../javax/mail/Service.html#close()" title="close()"><code class="member">close</code></a>, <a href="../../javax/mail/Service.html#connect()" title="connect()"><code class="member">connect</code></a>, <a href="../../javax/mail/Service.html#connect(String,String,String)" title="connect(String,String,String)"><code class="member">connect</code></a>, <a href="../../javax/mail/Service.html#connect(String,int,String,String)" title="connect(String,int,String,String)"><code class="member">connect</code></a>, <a href="../../javax/mail/Service.html#getURLName()" title="getURLName()"><code class="member">getURLName</code></a>, <a href="../../javax/mail/Service.html#isConnected()" title="isConnected()"><code class="member">isConnected</code></a>, <a href="../../javax/mail/Service.html#notifyConnectionListeners(int)" title="notifyConnectionListeners(int)"><code class="member">notifyConnectionListeners</code></a>, <a href="../../javax/mail/Service.html#protocolConnect(String,int,String,String)" title="protocolConnect(String,int,String,String)"><code class="member">protocolConnect</code></a>, <a href="../../javax/mail/Service.html#removeConnectionListener(javax.mail.event.ConnectionListener)" title="removeConnectionListener(ConnectionListener)"><code class="member">removeConnectionListener</code></a>, <a href="../../javax/mail/Service.html#setConnected(boolean)" title="setConnected(boolean)"><code class="member">setConnected</code></a>, <a href="../../javax/mail/Service.html#setURLName(javax.mail.URLName)" title="setURLName(URLName)"><code class="member">setURLName</code></a>, <a href="../../javax/mail/Service.html#toString()" title="toString()"><code class="member">toString</code></a></td></tr></table></dd></dl><a name="detail-constructors" id="detail-constructors"/><h2 class="section header">Constructor Details</h2><div class="section"><a name="Transport(javax.mail.Session,javax.mail.URLName)" id="Transport(javax.mail.Session,javax.mail.URLName)"/><div class="member detail outer"><h3 class="member detail name">Transport</h3><pre class="member detail synopsis">public Transport(<a href="../../javax/mail/Session.html" title="Class in javax.mail">Session</a> session,
<a href="../../javax/mail/URLName.html" title="Class in javax.mail">URLName</a> url)</pre><blockquote class="member detail name"><div class="member detail description"> Constructor.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">session</code><span class="separator"> - </span><span class="description">Session object for this Transport.</span></dd><dd class="item"><code class="name">url</code><span class="separator"> - </span><span class="description">URLName object to be used for this Transport</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></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="addTransportListener(javax.mail.event.TransportListener)" id="addTransportListener(javax.mail.event.TransportListener)"/><div class="member detail outer"><h3 class="member detail name">addTransportListener</h3><pre class="member detail synopsis">public void addTransportListener(<a href="../../javax/mail/event/TransportListener.html" title="Interface in javax.mail.event">TransportListener</a> l)</pre><blockquote class="member detail name"><div class="member detail description"> Add a listener for Transport events.
</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="notifyTransportListeners(int,javax.mail.Address[],javax.mail.Address[],javax.mail.Address[],javax.mail.Message)" id="notifyTransportListeners(int,javax.mail.Address[],javax.mail.Address[],javax.mail.Address[],javax.mail.Message)"/><div class="member detail outer"><h3 class="member detail name">notifyTransportListeners</h3><pre class="member detail synopsis">protected void notifyTransportListeners(int type,
<a href="../../javax/mail/Address.html" title="Class in javax.mail">Address</a>[] validSent,
<a href="../../javax/mail/Address.html" title="Class in javax.mail">Address</a>[] validUnsent,
<a href="../../javax/mail/Address.html" title="Class in javax.mail">Address</a>[] invalid,
<a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a> msg)</pre><blockquote class="member detail name"><div class="member detail description"> Notify all TransportListeners. Transport implementations are expected to
use this method to broadcast TransportEvents.
</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="removeTransportListener(javax.mail.event.TransportListener)" id="removeTransportListener(javax.mail.event.TransportListener)"/><div class="member detail outer"><h3 class="member detail name">removeTransportListener</h3><pre class="member detail synopsis">public void removeTransportListener(<a href="../../javax/mail/event/TransportListener.html" title="Interface in javax.mail.event">TransportListener</a> l)</pre><blockquote class="member detail name"><div class="member detail description"> Remove a listener for Transport events.
</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="send(javax.mail.Message)" id="send(javax.mail.Message)"/><div class="member detail outer"><h3 class="member detail name">send</h3><pre class="member detail synopsis">public static void send(<a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a> msg)
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"> Send a message.
The message will be sent to all recipient addresses specified in the
message (as returned from the Message method
<code>getAllRecipients</code>), using message transports appropriate to
each address. The <code>send</code> method calls the
<code>saveChanges</code> method on the message before sending it.
<p/>
If any of the recipient addresses is detected to be invalid by the
Transport during message submission, a SendFailedException is thrown.
Clients can get more detail about the failure by examining the exception.
Whether or not the message is still sent succesfully to any valid
addresses depends on the Transport implementation. See
SendFailedException for more details. Note also that success does not
imply that the message was delivered to the ultimate recipient, as
failures may occur in later stages of delivery. Once a Transport
accepts a message for delivery to a recipient, failures that occur
later should be reported to the user via another mechanism, such as
returning the undeliverable message.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">msg</code><span class="separator"> - </span><span class="description">the message to send</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="send(javax.mail.Message,javax.mail.Address[])" id="send(javax.mail.Message,javax.mail.Address[])"/><div class="member detail outer"><h3 class="member detail name">send</h3><pre class="member detail synopsis">public static void send(<a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a> msg,
<a href="../../javax/mail/Address.html" title="Class in javax.mail">Address</a>[] addresses)
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"> Send the message to the specified addresses, ignoring any recipients
specified in the message itself. The <code>send</code> method calls
the <code>saveChanges</code> method on the message before sending it.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">msg</code><span class="separator"> - </span><span class="description">the message to send</span></dd><dd class="item"><code class="name">addresses</code><span class="separator"> - </span><span class="description">the addresses to which to send the message</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="sendMessage(javax.mail.Message,javax.mail.Address[])" id="sendMessage(javax.mail.Message,javax.mail.Address[])"/><div class="member detail outer"><h3 class="member detail name">sendMessage</h3><pre class="member detail synopsis">public abstract void sendMessage(<a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a> msg,
<a href="../../javax/mail/Address.html" title="Class in javax.mail">Address</a>[] addresses)
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"> Send the Message to the specified list of addresses.
An appropriate TransportEvent indicating the delivery status is
delivered to any TransportListener registered on this Transport.
Also, if any of the addresses is invalid, a SendFailedException is
thrown. Note however, that the message is sent to the valid addresses.
<p/>
Unlike the static <code>send</code> method, the <code>sendMessage</code>
method does not call the <code>saveChanges</code> method on the message;
the caller should do so.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">msg</code><span class="separator"> - </span><span class="description">The Message to be sent</span></dd><dd class="item"><code class="name">addresses</code><span class="separator"> - </span><span class="description">List of addresses to send this message to</span></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 the connection is dead
or not in the connected state</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></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="Transport-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>