com.sun.mail.pop3

Class POP3Store

java.lang.Object

Store

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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.util.Map	capabilities() Return a Map of the capabilities the server provided, as per RFC 2449.
void	close()
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?

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, 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

isConnected

public boolean isConnected()

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

close

public void close()
           throws MessagingException

Throws:

MessagingException

getDefaultFolder

public Folder getDefaultFolder()
                        throws MessagingException

Throws:

MessagingException

getFolder

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

Only the name "INBOX" is supported.

Throws:

MessagingException

getFolder

public Folder getFolder(URLName url)
                 throws MessagingException

Throws:

MessagingException

capabilities

public java.util.Map 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

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