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.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	cacheWriteTo
private java.util.Map<java.lang.String,java.lang.String>	capabilities
private int	defaultPort
(package private) boolean	disableTop
(package private) java.io.File	fileCacheDir
(package private) boolean	finalizeCleanClose
(package private) boolean	forgetTopHeaders
private java.lang.String	host
private boolean	isSSL
(package private) boolean	keepMessageContent
private MailLogger	logger
(package private) java.lang.reflect.Constructor<?>	messageConstructor
private java.lang.String	name
private java.lang.String	passwd
private Protocol	port
private int	portNum
private POP3Folder	portOwner
private boolean	requireStartTLS
(package private) boolean	rsetBeforeQuit
(package private) boolean	supportsUidl
(package private) boolean	useFileCache
private java.lang.String	user
private boolean	useStartTLS
private boolean	usingSSL

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.
private void	checkConnected()
private static java.io.IOException	cleanupAndThrow(Protocol p, java.io.IOException ife)
void	close()	Close this service and terminate its connection.
(package private) void	close(boolean force)
(package private) void	closePort(POP3Folder owner)
protected void	finalize()	Stop the event dispatcher thread so the queue can be garbage collected.
private boolean	getBoolProp(java.lang.String prop)	Get the value of a boolean property.
Folder	getDefaultFolder()	Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store.
Folder	getFolder(java.lang.String name)	Only the name "INBOX" is supported.
Folder	getFolder(URLName url)	Return a closed Folder object, corresponding to the given URLName.
(package private) Protocol	getPort(POP3Folder owner)
(package private) Session	getSession()	Get a reference to the session.
boolean	isConnected()	Check whether this store is connected.
private static boolean	isRecoverable(java.lang.Throwable t)
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)	The service implementation should override this method to perform the actual protocol-specific connection attempt.

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

Field Detail

name

private java.lang.String name

defaultPort

private int defaultPort

isSSL

private boolean isSSL

port

private Protocol port

portOwner

private POP3Folder portOwner

host

private java.lang.String host

portNum

private int portNum

user

private java.lang.String user

passwd

private java.lang.String passwd

useStartTLS

private boolean useStartTLS

requireStartTLS

private boolean requireStartTLS

usingSSL

private boolean usingSSL

capabilities

private java.util.Map<java.lang.String,java.lang.String> capabilities

logger

private MailLogger logger

messageConstructor

volatile java.lang.reflect.Constructor<?> messageConstructor

rsetBeforeQuit

volatile boolean rsetBeforeQuit

disableTop

volatile boolean disableTop

forgetTopHeaders

volatile boolean forgetTopHeaders

supportsUidl

volatile boolean supportsUidl

cacheWriteTo

volatile boolean cacheWriteTo

useFileCache

volatile boolean useFileCache

fileCacheDir

volatile java.io.File fileCacheDir

keepMessageContent

volatile boolean keepMessageContent

finalizeCleanClose

volatile boolean finalizeCleanClose

Constructor Detail

POP3Store

public POP3Store(Session session,
                 URLName url)

POP3Store

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

Method Detail

getBoolProp

private final boolean getBoolProp(java.lang.String prop)

Get the value of a boolean property. Print out the value if logging is enabled.

getSession

Session getSession()

Get a reference to the session.

protocolConnect

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

Description copied from class: Service

The service implementation should override this method to perform the actual protocol-specific connection attempt. The default implementation of the connect method calls this method as needed.

The protocolConnect method should return false if a user name or password is required for authentication but the corresponding parameter is null; the connect method will prompt the user when needed to supply missing information. This method may also return false 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.

The protocolConnect 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.

Overrides:

protocolConnect in class Service

Parameters:

host - the name of the host to connect to

portNum - the port to use (-1 means use default port)

user - the name of the user to login as

passwd - the user's password

Returns:

true if connection successful, false if authentication failed

Throws:

AuthenticationFailedException - for authentication failures

MessagingException - for non-authentication failures

isConnected

public boolean isConnected()

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

Overrides:

isConnected in class Service

Returns:

true if the service is connected, false if it is not connected

getPort

Protocol getPort(POP3Folder owner)
          throws java.io.IOException

Throws:

java.io.IOException

cleanupAndThrow

private static java.io.IOException cleanupAndThrow(Protocol p,
                                                   java.io.IOException ife)

isRecoverable

private static boolean isRecoverable(java.lang.Throwable t)

closePort

void closePort(POP3Folder owner)

close

public void close()
           throws MessagingException

Description copied from class: Service

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.

This implementation uses setConnected(false) to set this service's connected state to false. 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 super.close() in a finally clause.

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class Service

Throws:

MessagingException - for errors while closing

See Also:

ConnectionEvent

close

void close(boolean force)
    throws MessagingException

Throws:

MessagingException

getDefaultFolder

public Folder getDefaultFolder()
                        throws MessagingException

Description copied from class: Store

Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store.

Specified by:

getDefaultFolder in class Store

Returns:

the root Folder

Throws:

MessagingException - for other failures

getFolder

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

Only the name "INBOX" is supported.

Specified by:

getFolder in class Store

Parameters:

name - 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.

Returns:

Folder object

Throws:

MessagingException - for other failures

See Also:

Folder.exists(), Folder.create(int)

getFolder

public Folder getFolder(URLName url)
                 throws MessagingException

Description copied from class: Store

Return a closed Folder object, corresponding to the given URLName. The store specified in the given URLName should refer to this Store object.

Implementations of this method may obtain the name of the actual folder using the getFile() method on URLName, and use that name to create the folder.

Specified by:

getFolder in class Store

Parameters:

url - URLName that denotes a folder

Returns:

Folder object

Throws:

MessagingException - for other failures

See Also:

URLName

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

Description copied from class: Service

Stop the event dispatcher thread so the queue can be garbage collected.

Overrides:

finalize in class Service

Throws:

java.lang.Throwable

checkConnected

private void checkConnected()
                     throws MessagingException

Throws:

MessagingException