JavaMail API 1.6.2 · com.sun.mail.pop3.POP3Store

Modifier and Type	Field and Description
pack-priv volatile boolean	cacheWriteTo
private Map<String, String>	capabilities
private int	defaultPort
pack-priv volatile boolean	disableTop
pack-priv volatile File	fileCacheDir
pack-priv volatile boolean	finalizeCleanClose
pack-priv volatile boolean	forgetTopHeaders
private String	host
private boolean	isSSL
pack-priv volatile boolean	keepMessageContent
private MailLogger	logger
pack-priv volatile Constructor<?>	messageConstructor
private String	name
private String	passwd
private Protocol	port
private int	portNum
private POP3Folder	portOwner
private boolean	requireStartTLS
pack-priv volatile boolean	rsetBeforeQuit
pack-priv volatile boolean	supportsUidl
pack-priv volatile boolean	useFileCache
private String	user
private boolean	useStartTLS
private boolean	usingSSL

Access	Constructor and Description
public	POP3Store(Session session, URLName url)
public	POP3Store(Session session, URLName url, String name, boolean isSSL)

Method Summary

Modifier and Type	Method and Description
public Map<String, String>	Returns: Map of capabilities capabilities() Return a Map of the capabilities the server provided, as per RFC 2449.
private void	checkConnected()
private static IOException	cleanupAndThrow(Protocol p, IOException ife)
public synchronized void	close() Overrides javax.mail.Service.close. Implements java.lang.AutoCloseable.close. Close this service and terminate its connection.
pack-priv synchronized void	close(boolean force)
pack-priv synchronized void	closePort(POP3Folder owner)
protected void	finalize() Overrides javax.mail.Service.finalize. Stop the event dispatcher thread so the queue can be garbage collected.
private final synchronized boolean	getBoolProp(String prop) Get the value of a boolean property.
public Folder	getDefaultFolder() Implements abstract javax.mail.Store.getDefaultFolder. Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store.
public Folder	getFolder(String 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. name) Implements abstract javax.mail.Store.getFolder. Only the name "INBOX" is supported.
public Folder	getFolder(URLName URLName that denotes a folder url) Implements abstract javax.mail.Store.getFolder. Return a closed Folder object, corresponding to the given URLName.
pack-priv synchronized Protocol	getPort(POP3Folder owner)
pack-priv synchronized Session	getSession() Hides javax.mail.Service.getSession. Get a reference to the session.
public synchronized boolean	isConnected() Overrides javax.mail.Service.isConnected. Check whether this store is connected.
private static boolean	isRecoverable(Throwable t)
public synchronized boolean	Returns: true if using SSL isSSL() Is this POP3Store using SSL to connect to the server?
protected synchronized boolean	protocolConnect(String the name of the host to connect to host, int the port to use (-1 means use default port) portNum, String the name of the user to login as user, String the user's password passwd) Overrides javax.mail.Service.protocolConnect. The service implementation should override this method to perform the actual protocol-specific connection attempt.

Inherited from javax.mail.Store:: addFolderListener addStoreListener getPersonalNamespaces getSharedNamespaces getUserNamespaces notifyFolderListeners notifyFolderRenamedListeners notifyStoreListeners removeFolderListener removeStoreListener

cacheWriteTo	back to summary
pack-priv volatile boolean cacheWriteTo

capabilities	back to summary
private Map<String, String> capabilities

defaultPort	back to summary
private int defaultPort

disableTop	back to summary
pack-priv volatile boolean disableTop

fileCacheDir	back to summary
pack-priv volatile File fileCacheDir

finalizeCleanClose	back to summary
pack-priv volatile boolean finalizeCleanClose

forgetTopHeaders	back to summary
pack-priv volatile boolean forgetTopHeaders

host	back to summary
private String host

isSSL	back to summary
private boolean isSSL

keepMessageContent	back to summary
pack-priv volatile boolean keepMessageContent

logger	back to summary
private MailLogger logger

messageConstructor	back to summary
pack-priv volatile Constructor<?> messageConstructor

name	back to summary
private String name

passwd	back to summary
private String passwd

port	back to summary
private Protocol port

portNum	back to summary
private int portNum

portOwner	back to summary
private POP3Folder portOwner

requireStartTLS	back to summary
private boolean requireStartTLS

rsetBeforeQuit	back to summary
pack-priv volatile boolean rsetBeforeQuit

supportsUidl	back to summary
pack-priv volatile boolean supportsUidl

useFileCache	back to summary
pack-priv volatile boolean useFileCache

user	back to summary
private String user

useStartTLS	back to summary
private boolean useStartTLS

usingSSL	back to summary
private boolean usingSSL

POP3Store	back to summary
public POP3Store(Session session, URLName url)

POP3Store	back to summary
public POP3Store(Session session, URLName url, String name, boolean isSSL)

Method Detail

capabilities back to summary

capabilities	back to summary
public Map<String, 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<String, String> Map of capabilities Exceptions MessagingException: for failures Since JavaMail 1.4.3

public Map<String, 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<String, String>

Map of capabilities

Exceptions

MessagingException:: for failures

Since

JavaMail 1.4.3

checkConnected	back to summary
private void checkConnected() throws MessagingException

cleanupAndThrow	back to summary
private static IOException cleanupAndThrow(Protocol p, IOException ife)

close back to summary

close	back to summary
public synchronized void close() throws MessagingException Overrides javax.mail.Service.close. Implements java.lang.AutoCloseable.close. Doc from javax.mail.Service.close. 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. Annotations @Override Exceptions MessagingException: for errors while closing

public synchronized void close() throws MessagingException

Overrides javax.mail.Service.close.

Implements java.lang.AutoCloseable.close.

Doc from javax.mail.Service.close.

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.

Annotations

@Override

Exceptions

MessagingException:: for errors while closing

close	back to summary
pack-priv synchronized void close(boolean force) throws MessagingException

closePort	back to summary
pack-priv synchronized void closePort(POP3Folder owner)

finalize back to summary

finalize	back to summary
protected void finalize() throws Throwable Overrides javax.mail.Service.finalize. Doc from javax.mail.Service.finalize. Stop the event dispatcher thread so the queue can be garbage collected. Annotations @Override Exceptions Throwable: Doc from java.lang.Object.finalize. the `Exception` raised by this method

protected void finalize() throws Throwable

Overrides javax.mail.Service.finalize.

Doc from javax.mail.Service.finalize.

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

Annotations

@Override

Exceptions

Throwable:

Doc from java.lang.Object.finalize.

the Exception raised by this method

getBoolProp	back to summary
private final synchronized boolean getBoolProp(String prop) Get the value of a boolean property. Print out the value if logging is enabled.

getDefaultFolder	back to summary
public Folder getDefaultFolder() throws MessagingException Implements abstract javax.mail.Store.getDefaultFolder. Doc from javax.mail.Store.getDefaultFolder. Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store. Returns:Folder the root Folder Annotations @Override Exceptions MessagingException: for other failures

getDefaultFolder

back to summary

public Folder getDefaultFolder() throws MessagingException

Implements abstract javax.mail.Store.getDefaultFolder.

Doc from javax.mail.Store.getDefaultFolder.

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

Returns:Folder

the root Folder

Annotations

@Override

Exceptions

MessagingException:: for other failures

getFolder	back to summary
public Folder getFolder(String name) throws MessagingException Implements abstract javax.mail.Store.getFolder. Only the name "INBOX" is supported. Parameters name:String Doc from javax.mail.Store.getFolder. 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 Doc from javax.mail.Store.getFolder. Folder object Annotations @Override Exceptions MessagingException: Doc from javax.mail.Store.getFolder. for other failures

getFolder

back to summary

public Folder getFolder(String name) throws MessagingException

Implements abstract javax.mail.Store.getFolder.

Only the name "INBOX" is supported.

Parameters

name:String

Doc from javax.mail.Store.getFolder.

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

Doc from javax.mail.Store.getFolder.

Folder object

Annotations

@Override

Exceptions

MessagingException:

Doc from javax.mail.Store.getFolder.

for other failures

getFolder back to summary

getFolder	back to summary
public Folder getFolder(URLName url) throws MessagingException Implements abstract javax.mail.Store.getFolder. Doc from javax.mail.Store.getFolder. 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. Parameters url:URLName URLName that denotes a folder Returns:Folder Folder object Annotations @Override Exceptions MessagingException: for other failures

public Folder getFolder(URLName url) throws MessagingException

Implements abstract javax.mail.Store.getFolder.

Doc from javax.mail.Store.getFolder.

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.

Parameters

url:URLName: URLName that denotes a folder

Returns:Folder

Folder object

Annotations

@Override

Exceptions

MessagingException:: for other failures

getPort	back to summary
pack-priv synchronized Protocol getPort(POP3Folder owner) throws IOException

getSession	back to summary
pack-priv synchronized Session getSession() Hides javax.mail.Service.getSession. Get a reference to the session.

getSession

back to summary

pack-priv synchronized Session getSession()

Hides javax.mail.Service.getSession.

Get a reference to the session.

isConnected	back to summary
public synchronized boolean isConnected() Overrides javax.mail.Service.isConnected. Check whether this store is connected. Override superclass method, to actually ping our server connection. Returns:boolean Doc from javax.mail.Service.isConnected. true if the service is connected, false if it is not connected Annotations @Override

isConnected

back to summary

public synchronized boolean isConnected()

Overrides javax.mail.Service.isConnected.

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

Returns:boolean

Doc from javax.mail.Service.isConnected.

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

Annotations

@Override

isRecoverable	back to summary
private static boolean isRecoverable(Throwable t)

isSSL	back to summary
public synchronized boolean isSSL() Is this POP3Store using SSL to connect to the server? Returns:boolean true if using SSL Since JavaMail 1.4.6

isSSL

back to summary

public synchronized boolean isSSL()

Is this POP3Store using SSL to connect to the server?

Returns:boolean: true if using SSL
Since: JavaMail 1.4.6

protocolConnect back to summary

protocolConnect	back to summary
protected synchronized boolean protocolConnect(String host, int portNum, String user, String passwd) throws MessagingException Overrides javax.mail.Service.protocolConnect. Doc from javax.mail.Service.protocolConnect. 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. Parameters host:String the name of the host to connect to portNum:int the port to use (-1 means use default port) user:String the name of the user to login as passwd:String the user's password Returns:boolean true if connection successful, false if authentication failed Annotations @Override Exceptions MessagingException: for non-authentication failures

protected synchronized boolean protocolConnect(String host, int portNum, String user, String passwd) throws MessagingException

Overrides javax.mail.Service.protocolConnect.

Doc from javax.mail.Service.protocolConnect.

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.

Parameters

host:String: the name of the host to connect to
portNum:int: the port to use (-1 means use default port)
user:String: the name of the user to login as
passwd:String: the user's password

Returns:boolean

true if connection successful, false if authentication failed

Annotations

@Override

Exceptions

MessagingException:: for non-authentication failures

public Class POP3Store

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail