<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<!-- Generated by javadoc (build 1.6.0_10) on Tue Nov 17 12:13:42 PST 2009 -->
<
META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
POP3Store (JavaMail API documentation)
<
META NAME="date" CONTENT="2009-11-17">
<
LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<
SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="POP3Store (JavaMail API documentation)";
}
}
<
BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<
A NAME="navbar_top"><!-- --><
/A>
<
A HREF="#skip-navbar_top" title="Skip navigation links"><
/A>
<
TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<
TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<
A NAME="navbar_top_firstrow"><!-- --><
/A>
<
TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<
TR ALIGN="center" VALIGN="top">
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../../overview-summary.html"><
FONT CLASS="NavBarFont1"><
B>Overview<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="package-summary.html"><
FONT CLASS="NavBarFont1"><
B>Package<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <
FONT CLASS="NavBarFont1Rev"><
B>Class<
/B><
/FONT> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="class-use/POP3Store.html"><
FONT CLASS="NavBarFont1"><
B>Use<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="package-tree.html"><
FONT CLASS="NavBarFont1"><
B>Tree<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../../deprecated-list.html"><
FONT CLASS="NavBarFont1"><
B>Deprecated<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../../index-files/index-1.html"><
FONT CLASS="NavBarFont1"><
B>Index<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../../help-doc.html"><
FONT CLASS="NavBarFont1"><
B>Help<
/B><
/FONT><
/A> <
/TD>
<
TD ALIGN="right" VALIGN="top" ROWSPAN=3><
EM>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../../../com/sun/mail/pop3/POP3SSLStore.html" title="class in com.sun.mail.pop3"><
B>PREV CLASS<
/B><
/A>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../../../index.html?com/sun/mail/pop3/POP3Store.html" target="_top"><
B>FRAMES<
/B><
/A>
<
A HREF="POP3Store.html" target="_top"><
B>NO FRAMES<
/B><
/A>
<
SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
<
A HREF="../../../../allclasses-noframe.html"><
B>All Classes<
/B><
/A>
<
TD VALIGN="top" CLASS="NavBarCell3"><
FONT SIZE="-2">
SUMMARY: NESTED | <
A HREF="#fields_inherited_from_class_javax.mail.Service">FIELD<
/A> | <
A HREF="#constructor_summary">CONSTR<
/A> | <
A HREF="#method_summary">METHOD<
/A><
/FONT><
/TD>
<
TD VALIGN="top" CLASS="NavBarCell3"><
FONT SIZE="-2">
DETAIL: FIELD | <
A HREF="#constructor_detail">CONSTR<
/A> | <
A HREF="#method_detail">METHOD<
/A><
/FONT><
/TD>
<
A NAME="skip-navbar_top"><
/A>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.
lang.Object<
/A>
<
IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><
A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">javax.mail.Service<
/A>
<
IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><
A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">javax.mail.Store<
/A>
<
IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><
B>com.sun.mail.pop3.POP3Store<
/B>
<
DT><
B>Direct Known Subclasses:<
/B> <
DD><
A HREF="../../../../com/sun/mail/pop3/POP3SSLStore.html" title="class in com.sun.mail.pop3">POP3SSLStore<
/A><
/DD>
<
DT><
PRE>public
class <
B>POP3Store<
/B><
DT>extends <
A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">Store<
/A><
/DL>
A POP3 Message Store. Contains only one folder, "INBOX".
See the <
a href="package-summary.html">com.sun.mail.pop3<
/a> package
documentation
for further information on the POP3 protocol provider. <
p>
<!-- =========== FIELD SUMMARY =========== -->
<
A NAME="field_summary"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<
TH ALIGN="left" COLSPAN="2"><
FONT SIZE="+2">
<
A NAME="fields_inherited_from_class_javax.mail.Service"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<
TH ALIGN="left"><
B>Fields inherited from
class javax.mail.<
A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service<
/A><
/B><
/TH>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
A HREF="../../../../javax/mail/Service.html#debug">debug<
/A>, <
A HREF="../../../../javax/mail/Service.html#session">session<
/A>, <
A HREF="../../../../javax/mail/Service.html#url">url<
/A><
/CODE><
/TD>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<
A NAME="constructor_summary"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<
TH ALIGN="left" COLSPAN="2"><
FONT SIZE="+2">
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/pop3/POP3Store.html#POP3Store(javax.mail.Session, javax.mail.URLName)">POP3Store<
/A><
/B>
(<
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>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/pop3/POP3Store.html#POP3Store(javax.mail.Session, javax.mail.URLName, java.lang.String, boolean)">POP3Store<
/A><
/B>
(<
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,
<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A>
name,
boolean isSSL
)<
/CODE>
<
/TD>
<!-- ========== METHOD SUMMARY =========== -->
<
A NAME="method_summary"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<
TH ALIGN="left" COLSPAN="2"><
FONT SIZE="+2">
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/pop3/POP3Store.html#capabilities()">capabilities<
/A><
/B>
()<
/CODE>
Return a Map of the capabilities the server provided,
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/pop3/POP3Store.html#close()">close<
/A><
/B>
()<
/CODE>
Close this service and terminate its connection.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/pop3/POP3Store.html#finalize()">finalize<
/A><
/B>
()<
/CODE>
Stop the event dispatcher thread so the queue can be garbage collected.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/pop3/POP3Store.html#getDefaultFolder()">getDefaultFolder<
/A><
/B>
()<
/CODE>
Returns a Folder object that represents the 'root' of
the default namespace presented to the user by the Store.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/pop3/POP3Store.html#getFolder(java.lang.String)">getFolder<
/A><
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A>
name)<
/CODE>
Only the
name "INBOX" is supported.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/pop3/POP3Store.html#getFolder(javax.mail.URLName)">getFolder<
/A><
/B>
(<
A HREF="../../../../javax/mail/URLName.html" title="class in javax.mail">URLName<
/A> url
)<
/CODE>
Return a closed Folder object, corresponding to the given
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/pop3/POP3Store.html#isConnected()">isConnected<
/A><
/B>
()<
/CODE>
Check whether this store is connected.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/pop3/POP3Store.html#protocolConnect(java.lang.String, int, java.lang.String, java.lang.String)">protocolConnect<
/A><
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A> host,
int portNum,
<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A> user,
<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A> passwd
)<
/CODE>
The service implementation should override this method to
perform the actual protocol-specific connection attempt.<
/TD>
<
A NAME="methods_inherited_from_class_javax.mail.Store"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<
TH ALIGN="left"><
B>Methods inherited from
class javax.mail.<
A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">Store<
/A><
/B><
/TH>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
A HREF="../../../../javax/mail/Store.html#addFolderListener(javax.mail.event.FolderListener)">addFolderListener<
/A>, <
A HREF="../../../../javax/mail/Store.html#addStoreListener(javax.mail.event.StoreListener)">addStoreListener<
/A>, <
A HREF="../../../../javax/mail/Store.html#getPersonalNamespaces()">getPersonalNamespaces<
/A>, <
A HREF="../../../../javax/mail/Store.html#getSharedNamespaces()">getSharedNamespaces<
/A>, <
A HREF="../../../../javax/mail/Store.html#getUserNamespaces(java.lang.String)">getUserNamespaces<
/A>, <
A HREF="../../../../javax/mail/Store.html#notifyFolderListeners(int, javax.mail.Folder)">notifyFolderListeners<
/A>, <
A HREF="../../../../javax/mail/Store.html#notifyFolderRenamedListeners(javax.mail.Folder, javax.mail.Folder)">notifyFolderRenamedListeners<
/A>, <
A HREF="../../../../javax/mail/Store.html#notifyStoreListeners(int, java.lang.String)">notifyStoreListeners<
/A>, <
A HREF="../../../../javax/mail/Store.html#removeFolderListener(javax.mail.event.FolderListener)">removeFolderListener<
/A>, <
A HREF="../../../../javax/mail/Store.html#removeStoreListener(javax.mail.event.StoreListener)">removeStoreListener<
/A><
/CODE><
/TD>
<
A NAME="methods_inherited_from_class_javax.mail.Service"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<
TH ALIGN="left"><
B>Methods inherited from
class javax.mail.<
A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service<
/A><
/B><
/TH>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
A HREF="../../../../javax/mail/Service.html#addConnectionListener(javax.mail.event.ConnectionListener)">addConnectionListener<
/A>, <
A HREF="../../../../javax/mail/Service.html#connect()">connect<
/A>, <
A HREF="../../../../javax/mail/Service.html#connect(java.lang.String, int, java.lang.String, java.lang.String)">connect<
/A>, <
A HREF="../../../../javax/mail/Service.html#connect(java.lang.String, java.lang.String)">connect<
/A>, <
A HREF="../../../../javax/mail/Service.html#connect(java.lang.String, java.lang.String, java.lang.String)">connect<
/A>, <
A HREF="../../../../javax/mail/Service.html#getURLName()">getURLName<
/A>, <
A HREF="../../../../javax/mail/Service.html#notifyConnectionListeners(int)">notifyConnectionListeners<
/A>, <
A HREF="../../../../javax/mail/Service.html#queueEvent(javax.mail.event.MailEvent, java.util.Vector)">queueEvent<
/A>, <
A HREF="../../../../javax/mail/Service.html#removeConnectionListener(javax.mail.event.ConnectionListener)">removeConnectionListener<
/A>, <
A HREF="../../../../javax/mail/Service.html#setConnected(boolean)">setConnected<
/A>, <
A HREF="../../../../javax/mail/Service.html#setURLName(javax.mail.URLName)">setURLName<
/A>, <
A HREF="../../../../javax/mail/Service.html#toString()">toString<
/A><
/CODE><
/TD>
<
A NAME="methods_inherited_from_class_java.lang.Object"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<
TH ALIGN="left"><
B>Methods inherited from
class java.
lang.<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object<
/A><
/B><
/TH>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait<
/A><
/CODE><
/TD>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<
A NAME="constructor_detail"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<
TH ALIGN="left" COLSPAN="1"><
FONT SIZE="+2">
<
A NAME="POP3Store(javax.mail.Session, javax.mail.URLName)"><!-- --><
/A><
H3>
public <
B>POP3Store<
/B>
(<
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>
<
A NAME="POP3Store(javax.mail.Session, javax.mail.URLName, java.lang.String, boolean)"><!-- --><
/A><
H3>
public <
B>POP3Store<
/B>
(<
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,
<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A>
name,
boolean isSSL
)<
/PRE>
<!-- ============ METHOD DETAIL ========== -->
<
A NAME="method_detail"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<
TH ALIGN="left" COLSPAN="1"><
FONT SIZE="+2">
<
A NAME="protocolConnect(java.lang.String, int, java.lang.String, java.lang.String)"><!-- --><
/A><
H3>
protected boolean <
B>protocolConnect<
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A> host,
int portNum,
<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A> user,
<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A> passwd
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD><
B>Description copied from
class: <
CODE><
A HREF="../../../../javax/mail/Service.html#protocolConnect(java.lang.String, int, java.lang.String, java.lang.String)">Service<
/A><
/CODE><
/B><
/DD>
<
DD>The service implementation should override this
method to
perform the actual protocol-specific connection attempt.
The default implementation of the <
code>connect<
/code>
method
calls this
method as needed. <
p>
The <
code>protocolConnect<
/code>
method should return
<
code>false<
/code> if a user
name or password is required
for authentication but the corresponding parameter is null;
the <
code>connect<
/code>
method will
prompt the user when
needed to supply missing information. This method may
also return <
code>false<
/code> if authentication fails
for
the supplied user name or password. Alternatively, this method
may throw an AuthenticationFailedException when authentication
fails. This exception may include a String message with more
detail about the failure. <
p>
The <
code>protocolConnect<
/code>
method should throw an
exception to report failures not related to authentication,
such as an invalid host name or port number, loss of a
connection during the authentication process, unavailability
of the server, etc.
<
DT><
B>Overrides:<
/B><
DD><
CODE><
A HREF="../../../../javax/mail/Service.html#protocolConnect(java.lang.String, int, java.lang.String, java.lang.String)">protocolConnect<
/A><
/CODE> in
class <
CODE><
A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service<
/A><
/CODE><
/DL>
<
DT><
B>Parameters:<
/B><
DD><
CODE>host<
/CODE> - the
name of the host to connect to<
DD><
CODE>portNum<
/CODE> - the port to use
(-
1 means use default port
)<
DD><
CODE>user<
/CODE> - the
name of the user to login as<
DD><
CODE>passwd<
/CODE> - the user
's password
<DT><B>Returns:</B><DD>true if connection successful, false if authentication failed
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/AuthenticationFailedException.html" title="class in javax.mail">AuthenticationFailedException</A></CODE> - for authentication failures
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - for non-authentication failures</DL>
</DD>
</DL>
<HR>
<A NAME="isConnected()"><!-- --></A><H3>
isConnected</H3>
<PRE>
public boolean <B>isConnected</B>()</PRE>
<DL>
<DD>Check whether this store is connected. Override superclass
method, to actually ping our server connection. <p>
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Service.html#isConnected()">isConnected</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the service is connected, false if it is not connected</DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Service.html#close()">Service</A></CODE></B></DD>
<DD>Close this service and terminate its connection. A close
ConnectionEvent is delivered to any ConnectionListeners. Any
Messaging components (Folders, Messages, etc.) belonging to this
service are invalid after this service is closed. Note that the service
is closed even if this method terminates abnormally by throwing
a MessagingException. <p>
This implementation uses <code>setConnected(false)</code> to set
this service's connected state to <
code>false<
/code>. It will then
send a close ConnectionEvent to any registered ConnectionListeners.
Subclasses overriding this method to do implementation specific
cleanup should call this method as a last step to insure event
notification, probably by including a call to <
code>super.close
()<
/code>
<
DT><
B>Overrides:<
/B><
DD><
CODE><
A HREF="../../../../javax/mail/Service.html#close()">close<
/A><
/CODE> in
class <
CODE><
A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service<
/A><
/CODE><
/DL>
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE> -
for errors while closing<
DT><
B>See Also:<
/B><
DD><
A HREF="../../../../javax/mail/event/ConnectionEvent.html" title="class in javax.mail.event"><
CODE>ConnectionEvent<
/CODE><
/A><
/DL>
<
A NAME="getDefaultFolder()"><!-- --><
/A><
H3>
public <
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A> <
B>getDefaultFolder<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD><
B>Description copied from
class: <
CODE><
A HREF="../../../../javax/mail/Store.html#getDefaultFolder()">Store<
/A><
/CODE><
/B><
/DD>
<
DD>Returns a Folder
object that represents the
'root' of
the default namespace presented to the user by the Store.
<
DT><
B>Specified by:<
/B><
DD><
CODE><
A HREF="../../../../javax/mail/Store.html#getDefaultFolder()">getDefaultFolder<
/A><
/CODE> in
class <
CODE><
A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">Store<
/A><
/CODE><
/DL>
<
DT><
B>Returns:<
/B><
DD>the root Folder
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="getFolder(java.lang.String)"><!-- --><
/A><
H3>
public <
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A> <
B>getFolder<
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A>
name)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Only the
name "INBOX" is supported.
<
DT><
B>Specified by:<
/B><
DD><
CODE><
A HREF="../../../../javax/mail/Store.html#getFolder(java.lang.String)">getFolder<
/A><
/CODE> in
class <
CODE><
A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">Store<
/A><
/CODE><
/DL>
<
DT><
B>Parameters:<
/B><
DD><
CODE>name<
/CODE> - The
name of the Folder. In some Stores,
name can
be an absolute path if it starts with the
hierarchy delimiter. Else it is interpreted
relative to the 'root' of this namespace.
<
DT><
B>Returns:<
/B><
DD>Folder
object
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
DT><
B>See Also:<
/B><
DD><
A HREF="../../../../javax/mail/Folder.html#exists()"><
CODE>Folder.exists
()<
/CODE><
/A>,
<
A HREF="../../../../javax/mail/Folder.html#create(int)"><
CODE>Folder.create
(int
)<
/CODE><
/A><
/DL>
<
A NAME="getFolder(javax.mail.URLName)"><!-- --><
/A><
H3>
public <
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A> <
B>getFolder<
/B>
(<
A HREF="../../../../javax/mail/URLName.html" title="class in javax.mail">URLName<
/A> url
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD><
B>Description copied from
class: <
CODE><
A HREF="../../../../javax/mail/Store.html#getFolder(javax.mail.URLName)">Store<
/A><
/CODE><
/B><
/DD>
<
DD>Return a closed Folder
object, corresponding to the given
URLName. The store specified in the given URLName should
refer to this Store
object. <
p>
Implementations of this method may obtain the name of the
actual folder using the <
code>getFile
()<
/code>
method on
URLName, and use that name to create the folder.
<
DT><
B>Specified by:<
/B><
DD><
CODE><
A HREF="../../../../javax/mail/Store.html#getFolder(javax.mail.URLName)">getFolder<
/A><
/CODE> in
class <
CODE><
A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">Store<
/A><
/CODE><
/DL>
<
DT><
B>Parameters:<
/B><
DD><
CODE>url<
/CODE> - URLName that denotes a folder
<
DT><
B>Returns:<
/B><
DD>Folder
object
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
DT><
B>See Also:<
/B><
DD><
A HREF="../../../../javax/mail/URLName.html" title="class in javax.mail"><
CODE>URLName<
/CODE><
/A><
/DL>
<
A NAME="capabilities()"><!-- --><
/A><
H3>
public <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map<
/A> <
B>capabilities<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Return a Map of the capabilities the server provided,
as per RFC 2449. If the server doesn't support RFC 2449,
an emtpy Map is returned. The returned Map can not be modified.
The key to the Map is the upper case capability name as
a String. The value of the entry is the entire String
capability line returned by the server. <p>
For example, to check if the server supports the STLS capability, use:
<code>if (store.capabilities().containsKey("STLS")) ...</code>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>Map of capabilities
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
<DD>JavaMail 1.4.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="finalize()"><!-- --></A><H3>
finalize</H3>
<PRE>
protected void <B>finalize</B>()
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A></PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Service.html#finalize()">Service</A></CODE></B></DD>
<DD>Stop the event dispatcher thread so the queue can be garbage collected.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Service.html#finalize()">finalize</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/POP3Store.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/sun/mail/pop3/POP3SSLStore.html" title="class in com.sun.mail.pop3"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/sun/mail/pop3/POP3Store.html" target="_top"><B>FRAMES</B></A>
<A HREF="POP3Store.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<
A HREF="../../../../allclasses-noframe.html"><
B>All Classes<
/B><
/A>
');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_javax.mail.Service">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
</BODY>
</HTML>