session.html

SUN的JAVA MAIL API

                              int port,
                              java.lang.String protocol,
                              java.lang.String prompt,
                              java.lang.String&nbsp;defaultUserName)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Call back to the application to get the needed user name and password.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#setDebug(boolean)">setDebug</A></B>(boolean&nbsp;debug)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the debug setting for this Session.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#setPasswordAuthentication(javax.mail.URLName, javax.mail.PasswordAuthentication)">setPasswordAuthentication</A></B>(<A HREF="../../javax/mail/URLName.html">URLName</A>&nbsp;url,
                          <A HREF="../../javax/mail/PasswordAuthentication.html">PasswordAuthentication</A>&nbsp;pw)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Save a PasswordAuthentication for this (store or transport) URLName.</TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#setProvider(javax.mail.Provider)">setProvider</A></B>(<A HREF="../../javax/mail/Provider.html">Provider</A>&nbsp;provider)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the passed Provider to be the default implementation
 for the protocol in Provider.protocol overriding any previous values.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" ID="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" ID="TableRowColor">
<TD><CODE>clone, 
equals, 
finalize, 
getClass, 
hashCode, 
notify, 
notifyAll, 
toString, 
wait, 
wait, 
wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->


<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" ID="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getInstance(java.util.Properties, javax.mail.Authenticator)"><!-- --></A><H3>
getInstance</H3>
<PRE>
public static <A HREF="../../javax/mail/Session.html">Session</A> <B>getInstance</B>(java.util.Properties&nbsp;props,
                                  <A HREF="../../javax/mail/Authenticator.html">Authenticator</A>&nbsp;authenticator)</PRE>
<DL>
<DD>Get a new Session object.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>props</CODE> - Properties object that hold relevant properties.<br>
                  It is expected that the client supplies values
                  for the properties listed in Appendix A of the
                  JavaMail spec (particularly  mail.store.protocol, 
                  mail.transport.protocol, mail.host, mail.user, 
                  and mail.from) as the defaults are unlikely to 
                  work in all cases.<DD><CODE>authenticator</CODE> - Authenticator object used to call back to
			the application when a user name and password is
			needed.<DT><B>Returns:</B><DD>a new Session object<DT><B>See Also: </B><DD><A HREF="../../javax/mail/Authenticator.html"><CODE>Authenticator</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultInstance(java.util.Properties, javax.mail.Authenticator)"><!-- --></A><H3>
getDefaultInstance</H3>
<PRE>
public static <A HREF="../../javax/mail/Session.html">Session</A> <B>getDefaultInstance</B>(java.util.Properties&nbsp;props,
                                         <A HREF="../../javax/mail/Authenticator.html">Authenticator</A>&nbsp;authenticator)</PRE>
<DL>
<DD>Get the default Session object. If a default has not yet been
 setup, a new Session object is created and installed as the 
 default. <p>

 Since the default session is potentially available to all
 code executing in the same Java virtual machine, and the session
 can contain security sensitive information such as user names
 and passwords, access to the default session is restricted.
 The Authenticator object, which must be created by the caller,
 is used indirectly to check access permission.  The Authenticator
 object passed in when the session is created is compared with
 the Authenticator object passed in to subsequent requests to
 get the default session.  If both objects are the same, or are
 from the same ClassLoader, the request is allowed.  Otherwise,
 it is denied.  <p>

 Note that if the Authenticator object used to create the session
 is null, anyone can get the default session by passing in null.  <p>

 In JDK 1.2, additional security Permission objects may be used to
 control access to the default session.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>props</CODE> - Properties object. Used only if a new Session
			object is created.<br>
                  It is expected that the client supplies values
                  for the properties listed in Appendix A of the
                  JavaMail spec (particularly  mail.store.protocol, 
                  mail.transport.protocol, mail.host, mail.user, 
                  and mail.from) as the defaults are unlikely to 
                  work in all cases.<DD><CODE>authenticator</CODE> - Authenticator object.  Used only if a
			new Session object is created.  Otherwise, 
			it must match the Authenticator used to create
			the Session.<DT><B>Returns:</B><DD>the default Session object</DL>
</DD>
</DL>
<HR>

<A NAME="setDebug(boolean)"><!-- --></A><H3>
setDebug</H3>
<PRE>
public void <B>setDebug</B>(boolean&nbsp;debug)</PRE>
<DL>
<DD>Set the debug setting for this Session.
 <p>
 Since debug can be turned on only after the Session 
 has been created, to turn on debugging in the Session
 constructor, set the property <code>mail.debug</code>
 to true. Subsequent calls to get/setDebug() have no
 affect on and override the <code>mail.debug</code>
 property.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>debug</CODE> - Debug setting</DL>
</DD>
</DL>
<HR>

<A NAME="getDebug()"><!-- --></A><H3>
getDebug</H3>
<PRE>
public boolean <B>getDebug</B>()</PRE>
<DL>
<DD>Get the debug setting for this Session.
 <p>
 Since debug can be turned on only after the Session 
 has been created, to turn on debugging in the Session
 constructor, set the property <code>mail.debug</code>
 to true. Subsequent calls to get/setDebug() have no
 affect on and override the <code>mail.debug</code>
 property.<DD><DL>
<DT><B>Returns:</B><DD>current debug setting</DL>
</DD>
</DL>
<HR>

<A NAME="getProviders()"><!-- --></A><H3>
getProviders</H3>
<PRE>
public <A HREF="../../javax/mail/Provider.html">Provider</A>[] <B>getProviders</B>()</PRE>
<DL>
<DD>This method returns an array of all the implementations installed 
 via the javamail.[default.]providers files that can
 be loaded using the ClassLoader available to this application.<DD><DL>
<DT><B>Returns:</B><DD>Array of configured providers</DL>
</DD>
</DL>
<HR>

<A NAME="getProvider(java.lang.String)"><!-- --></A><H3>
getProvider</H3>
<PRE>
public <A HREF="../../javax/mail/Provider.html">Provider</A> <B>getProvider</B>(java.lang.String&nbsp;protocol)
                     throws <A HREF="../../javax/mail/NoSuchProviderException.html">NoSuchProviderException</A></PRE>
<DL>
<DD>Returns the default Provider for the protocol
 specified. Checks mail.&ltprotocol&gt.class property
 first and if it exists, returns the Provider
 associated with this implementation. If it doesn't exist, 
 returns the Provider that appeared first in the 
 configuration files. If an implementation for the protocol 
 isn't found, throws NoSuchProviderException<DD><DL>
<DT><B>Parameters:</B><DD><CODE>protocol</CODE> - Configured protocol (i.e. smtp, imap, etc)<DT><B>Returns:</B><DD>Currently configured Provider for the specified protocol<DT><B>Throws:</B><DD><A HREF="../../javax/mail/NoSuchProviderException.html">NoSuchProviderException</A> - If a provider for the given
			protocol is not found.</DL>
</DD>
</DL>
<HR>

<A NAME="setProvider(javax.mail.Provider)"><!-- --></A><H3>
setProvider</H3>
<PRE>
public void <B>setProvider</B>(<A HREF="../../javax/mail/Provider.html">Provider</A>&nbsp;provider)
                 throws <A HREF="../../javax/mail/NoSuchProviderException.html">NoSuchProviderException</A></PRE>
<DL>
<DD>Set the passed Provider to be the default implementation
 for the protocol in Provider.protocol overriding any previous values.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>provider</CODE> - Currently configured Provider which will be 
 set as the default for the protocol<DT><B>Throws:</B><DD><A HREF="../../javax/mail/NoSuchProviderException.html">NoSuchProviderException</A> - If the provider passed in
			is invalid.</DL>
</DD>
</DL>
<HR>

<A NAME="getStore()"><!-- --></A><H3>
getStore</H3>
<PRE>
public <A HREF="../../javax/mail/Store.html">Store</A> <B>getStore</B>()
               throws <A HREF="../../javax/mail/NoSuchProviderException.html">NoSuchProviderException</A></PRE>
<DL>
<DD>Get a Store object that implements this user's desired Store
 protcol. The <i>mail.store.protocol</i> property specifies the desired
 protocol. If an appropriate Store object is not obtained, 
 NoSuchProviderException is thrown<DD><DL>
<DT><B>Returns:</B><DD>a Store object<DT><B>Throws:</B><DD><A HREF="../../javax/mail/NoSuchProviderException.html">NoSuchProviderException</A> - If a provider for the given
			protocol is not found.</DL>
</DD>
</DL>
<HR>

<A NAME="getStore(java.lang.String)"><!-- --></A><H3>
getStore</H3>
<PRE>
public <A HREF="../../javax/mail/Store.html">Store</A> <B>getStore</B>(java.lang.String&nbsp;protocol)
               throws <A HREF="../../javax/mail/NoSuchProviderException.html">NoSuchProviderException</A></PRE>
<DL>
<DD>Get a Store object that implements the specified protocol. If an
 appropriate Store object cannot be obtained, 
 NoSuchProviderException is thrown.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>protocol</CODE> - &nbsp;<DT><B>Returns:</B><DD>a Store object<DT><B>Throws:</B><DD><A HREF="../../javax/mail/NoSuchProviderException.html">NoSuchProviderException</A> - If a provider for the given
			protocol is not found.</DL>
</DD>
</DL>
<HR>

<A NAME="getStore(javax.mail.URLName)"><!-- --></A><H3>
getStore</H3>
<PRE>