Module com.sun.mail.pop3

Package com.sun.mail.pop3

Class POP3Store

java.lang.Object

javax.mail.Service

javax.mail.Store

com.sun.mail.pop3.POP3Store

All Implemented Interfaces:

java.lang.AutoCloseable

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.

Author:

Bill Shannon, John Mani

Field Summary

Fields inherited from class javax.mail.Service

debug, session, url

Constructor Summary

Constructors

Constructor	Description
POP3Store(Session session, URLName url)
POP3Store(Session session, URLName url, java.lang.String name, boolean isSSL)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	capabilities()	Return a Map of the capabilities the server provided, as per RFC 2449.
void	close()
protected void	finalize()
Folder	getDefaultFolder()
Folder	getFolder(java.lang.String name)	Only the name "INBOX" is supported.
Folder	getFolder(URLName url)
boolean	isConnected()	Check whether this store is connected.
boolean	isSSL()	Is this POP3Store using SSL to connect to the server?
protected boolean	protocolConnect(java.lang.String host, int portNum, java.lang.String user, java.lang.String passwd)

Methods inherited from class javax.mail.Store

addFolderListener, addStoreListener, getPersonalNamespaces, getSharedNamespaces, getUserNamespaces, notifyFolderListeners, notifyFolderRenamedListeners, notifyStoreListeners, removeFolderListener, removeStoreListener

Methods inherited from class javax.mail.Service

addConnectionListener, connect, connect, connect, connect, getURLName, notifyConnectionListeners, queueEvent, removeConnectionListener, setConnected, setURLName, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

POP3Store

public POP3Store(Session session,
                 URLName url)

POP3Store

public POP3Store(Session session,
                 URLName url,
                 java.lang.String name,
                 boolean isSSL)

Method Detail

protocolConnect

protected boolean protocolConnect(java.lang.String host,
                                  int portNum,
                                  java.lang.String user,
                                  java.lang.String passwd)
                           throws MessagingException

Overrides:

protocolConnect in class Service

Throws:

MessagingException

isConnected

public boolean isConnected()

Check whether this store is connected. Override superclass method, to actually ping our server connection.

Overrides:

isConnected in class Service

close

public void close()
           throws MessagingException

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class Service

Throws:

MessagingException

getDefaultFolder

public Folder getDefaultFolder()
                        throws MessagingException

Specified by:

getDefaultFolder in class Store

Throws:

MessagingException

getFolder

public Folder getFolder(java.lang.String name)
                 throws MessagingException

Only the name "INBOX" is supported.

Specified by:

getFolder in class Store

Throws:

MessagingException

getFolder

public Folder getFolder(URLName url)
                 throws MessagingException

Specified by:

getFolder in class Store

Throws:

MessagingException

capabilities

public java.util.Map<java.lang.String,java.lang.String> capabilities()
                                                                    throws MessagingException

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.

For example, to check if the server supports the STLS capability, use: if (store.capabilities().containsKey("STLS")) ...

Returns:

Map of capabilities

Throws:

MessagingException - for failures

Since:

JavaMail 1.4.3

isSSL

public boolean isSSL()

Is this POP3Store using SSL to connect to the server?

Returns:

true if using SSL

Since:

JavaMail 1.4.6

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class Service

Throws:

java.lang.Throwable