This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

com.sun.mail.pop3
class POP3Store

javax.mail.Service extended by javax.mail.Store extended by com.sun.mail.pop3.POP3Store
Direct Known Subclasses:
POP3SSLStore
public class POP3Store
extends Store

A POP3 Message Store. Contains only one folder, "INBOX". See the com.sun.mail.pop3 package documentation for further information on the POP3 protocol provider.

Field Summary
 
Fields inherited from class javax.mail.Service
debug, session, url
 
Constructor Summary
POP3Store(Session session, URLName url)

          
POP3Store(Session session, URLName url, String name, int defaultPort, boolean isSSL)

          
 
Method Summary
 void
close()

          Close this service and terminate its connection.
protected void
finalize()

          Stop the event dispatcher thread so the queue can be garbage collected.
 Folder
getDefaultFolder()

          Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store.
 Folder
getFolder(String name)

          Only the name "INBOX" is supported.
 Folder
getFolder(URLName url)

          Return the Folder object corresponding to the given name.
 boolean
isConnected()

          Check whether this store is connected.
protected boolean
protocolConnect(String host, int portNum, String user, String passwd)

          The service implementation should override this method to perform the actual protocol-specific connection attempt.
 
Methods inherited from class javax.mail.Store
addFolderListener, addStoreListener, getDefaultFolder, getFolder, getFolder, getPersonalNamespaces, getSharedNamespaces, getUserNamespaces, notifyFolderListeners, notifyFolderRenamedListeners, notifyStoreListeners, removeFolderListener, removeStoreListener
 
Methods inherited from class javax.mail.Service
addConnectionListener, close, connect, connect, connect, connect, finalize, getURLName, isConnected, notifyConnectionListeners, protocolConnect, queueEvent, removeConnectionListener, setConnected, setURLName, toString
 

Constructor Detail

POP3Store

public POP3Store(Session session,
                 URLName url)
Parameters:
session
url

POP3Store

public POP3Store(Session session,
                 URLName url,
                 String name,
                 int defaultPort,
                 boolean isSSL)
Parameters:
session
url
name
defaultPort
isSSL
Method Detail

close

public synchronized void close()
                        throws MessagingException
Overrides:
close in class Service
Throws:
MessagingException

finalize

protected void finalize()
                 throws Throwable
Overrides:
finalize in class Service
Throws:
Throwable

getDefaultFolder

public Folder getDefaultFolder()
                        throws MessagingException
Overrides:
getDefaultFolder in class Store
Throws:
MessagingException

getFolder

public Folder getFolder(String name)
                 throws MessagingException
Only the name "INBOX" is supported.

Overrides:
getFolder in class Store
Parameters:
name
Throws:
MessagingException

getFolder

public Folder getFolder(URLName url)
                 throws MessagingException
Overrides:
getFolder in class Store
Parameters:
url
Throws:
MessagingException

isConnected

public synchronized boolean isConnected()
Check whether this store is connected. Override superclass method, to actually ping our server connection.

Overrides:
isConnected in class Service

protocolConnect

protected synchronized boolean protocolConnect(String host,
                                               int portNum,
                                               String user,
                                               String passwd)
                                        throws MessagingException
Overrides:
protocolConnect in class Service
Parameters:
host
portNum
user
passwd
Throws:
MessagingException
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention. The official Sun™ documentation can be found here at http://java.sun.com/products/javamail/javadocs/index.html.