public class IMAPStore extends Store implements QuotaAwareStore, ResponseHandler
Applications that need to make use of IMAP-specific features may cast
a Store
object to an IMAPStore
object and
use the methods on this class. The getQuota
and
setQuota
methods support the IMAP QUOTA extension.
Refer to RFC 2087
for more information.
The id
method supports the IMAP ID extension;
see RFC 2971.
The fields ID_NAME, ID_VERSION, etc. represent the suggested field names
in RFC 2971 section 3.3 and may be used as keys in the Map containing
client values or server values.
See the com.sun.mail.imap package documentation for further information on the IMAP protocol provider.
WARNING: The APIs unique to this class should be considered EXPERIMENTAL. They may be changed in the future in ways that are incompatible with applications using the current APIs.
Modifier and Type | Field and Description |
---|---|
protected String |
authorizationID |
protected int |
defaultPort |
protected String |
host |
static String |
ID_ADDRESS |
static String |
ID_ARGUMENTS |
static String |
ID_COMMAND |
static String |
ID_DATE |
static String |
ID_ENVIRONMENT |
static String |
ID_NAME |
static String |
ID_OS |
static String |
ID_OS_VERSION |
static String |
ID_SUPPORT_URL |
static String |
ID_VENDOR |
static String |
ID_VERSION |
protected boolean |
isSSL |
protected MailLogger |
logger |
protected String |
name |
protected String |
password |
protected String |
proxyAuthUser |
static int |
RESPONSE
A special event type for a StoreEvent to indicate an IMAP
response, if the mail.imap.enableimapevents property is set.
|
protected String |
saslRealm |
protected String |
user |
Modifier | Constructor and Description |
---|---|
|
IMAPStore(Session session,
URLName url)
Constructor that takes a Session object and a URLName that
represents a specific IMAP server.
|
protected |
IMAPStore(Session session,
URLName url,
String name,
boolean isSSL)
Constructor used by this class and by IMAPSSLStore subclass.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close this Store.
|
protected void |
finalize()
Stop the event dispatcher thread so the queue can be garbage collected.
|
Folder |
getDefaultFolder()
Get the default folder, representing the root of this user's
namespace.
|
Folder |
getFolder(String name)
Get named folder.
|
Folder |
getFolder(URLName url)
Get named folder.
|
Folder[] |
getPersonalNamespaces()
Using the IMAP NAMESPACE command (RFC 2342), return a set
of folders representing the Personal namespaces.
|
String |
getProxyAuthUser()
Get the user name to be used with the PROXYAUTH command.
|
Quota[] |
getQuota(String root)
Get the quotas for the named quota root.
|
Folder[] |
getSharedNamespaces()
Using the IMAP NAMESPACE command (RFC 2342), return a set
of folders representing the Shared namespaces.
|
Folder[] |
getUserNamespaces(String user)
Using the IMAP NAMESPACE command (RFC 2342), return a set
of folders representing the User's namespaces.
|
void |
handleResponse(Response r)
Response handler method.
|
boolean |
hasCapability(String capability)
Return true if the specified capability string is in the list
of capabilities the server announced.
|
Map<String,String> |
id(Map<String,String> clientParams)
Send the IMAP ID command (if supported by the server) and return
the result from the server.
|
void |
idle()
Use the IMAP IDLE command (see
RFC 2177),
if supported by the server, to enter idle mode so that the server
can send unsolicited notifications
without the need for the client to constantly poll the server.
|
boolean |
isConnected()
Check whether this store is connected.
|
boolean |
isSSL()
Does this IMAPStore use SSL when connecting to the server?
|
protected IMAPFolder |
newIMAPFolder(ListInfo li)
Create an IMAPFolder object.
|
protected IMAPFolder |
newIMAPFolder(String fullName,
char separator)
Create an IMAPFolder object.
|
protected IMAPFolder |
newIMAPFolder(String fullName,
char separator,
Boolean isNamespace)
Create an IMAPFolder object.
|
protected IMAPProtocol |
newIMAPProtocol(String host,
int port)
Create an IMAPProtocol object connected to the host and port.
|
protected void |
preLogin(IMAPProtocol p)
This method is called after the connection is made and
TLS is started (if needed), but before any authentication
is attempted.
|
protected boolean |
protocolConnect(String host,
int pport,
String user,
String password)
Implementation of protocolConnect().
|
void |
setPassword(String password)
Set the password that will be used for subsequent connections
after this Store is first connected (for example, when creating
a connection to open a Folder).
|
void |
setProxyAuthUser(String user)
Set the user name to be used with the PROXYAUTH command.
|
void |
setQuota(Quota quota)
Set the quotas for the quota root specified in the quota argument.
|
void |
setUsername(String user)
Set the user name that will be used for subsequent connections
after this Store is first connected (for example, when creating
a connection to open a Folder).
|
addFolderListener, addStoreListener, notifyFolderListeners, notifyFolderRenamedListeners, notifyStoreListeners, removeFolderListener, removeStoreListener
addConnectionListener, connect, connect, connect, connect, getURLName, notifyConnectionListeners, queueEvent, removeConnectionListener, setConnected, setURLName, toString
public static final int RESPONSE
public static final String ID_NAME
public static final String ID_VERSION
public static final String ID_OS
public static final String ID_OS_VERSION
public static final String ID_VENDOR
public static final String ID_SUPPORT_URL
public static final String ID_ADDRESS
public static final String ID_DATE
public static final String ID_COMMAND
public static final String ID_ARGUMENTS
public static final String ID_ENVIRONMENT
protected final String name
protected final int defaultPort
protected final boolean isSSL
protected String host
protected String user
protected String password
protected String proxyAuthUser
protected String authorizationID
protected String saslRealm
protected MailLogger logger
public IMAPStore(Session session, URLName url)
session
- the Sessionurl
- the URLName of this storeprotected boolean protocolConnect(String host, int pport, String user, String password) throws MessagingException
The host
, user
, and password
parameters must all be non-null. If the authentication mechanism
being used does not require a password, an empty string or other
suitable dummy password should be used.
protocolConnect
in class Service
host
- the name of the host to connect topport
- the port to use (-1 means use default port)user
- the name of the user to login aspassword
- the user's passwordAuthenticationFailedException
- for authentication failuresMessagingException
- for non-authentication failuresprotected IMAPProtocol newIMAPProtocol(String host, int port) throws IOException, ProtocolException
host
- the host nameport
- the port numberIOException
- for I/O errorsProtocolException
- for protocol errorsprotected void preLogin(IMAPProtocol p) throws ProtocolException
The implementation of this method in this class does nothing.
p
- the IMAPProtocol connectionProtocolException
- for protocol errorspublic boolean isSSL()
public void setUsername(String user)
Some IMAP servers may provide an authentication ID that can be used for more efficient authentication for future connections. This authentication ID is provided in a server-specific manner not described here.
Most applications will never need to use this method.
user
- the user name for the storepublic void setPassword(String password)
Most applications will never need to use this method.
password
- the password for the storepublic boolean hasCapability(String capability) throws MessagingException
capability
- the capability stringMessagingException
- for failurespublic void setProxyAuthUser(String user)
mail.imap.proxyauth.user
property when this
Store is created.user
- the user name to setpublic String getProxyAuthUser()
public boolean isConnected()
isConnected
in class Service
public void close() throws MessagingException
close
in interface AutoCloseable
close
in class Service
MessagingException
- for errors while closingConnectionEvent
protected void finalize() throws Throwable
Service
public Folder getDefaultFolder() throws MessagingException
getDefaultFolder
in class Store
MessagingException
- for other failurespublic Folder getFolder(String name) throws MessagingException
getFolder
in class Store
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.MessagingException
- for other failuresFolder.exists()
,
Folder.create(int)
public Folder getFolder(URLName url) throws MessagingException
getFolder
in class Store
url
- URLName that denotes a folderMessagingException
- for other failuresURLName
protected IMAPFolder newIMAPFolder(String fullName, char separator, Boolean isNamespace)
fullName
- the full name of the folderseparator
- the separator character for the folder hierarchyisNamespace
- does this name represent a namespace?protected IMAPFolder newIMAPFolder(String fullName, char separator)
fullName
- the full name of the folderseparator
- the separator character for the folder hierarchyprotected IMAPFolder newIMAPFolder(ListInfo li)
li
- the ListInfo for the folderpublic Folder[] getPersonalNamespaces() throws MessagingException
getPersonalNamespaces
in class Store
MessagingException
- for other failurespublic Folder[] getUserNamespaces(String user) throws MessagingException
getUserNamespaces
in class Store
user
- the user nameMessagingException
- for other failurespublic Folder[] getSharedNamespaces() throws MessagingException
getSharedNamespaces
in class Store
MessagingException
- for other failurespublic Quota[] getQuota(String root) throws MessagingException
getQuota
in interface QuotaAwareStore
root
- the name of the quota rootMessagingException
- if the server doesn't support the
QUOTA extensionpublic void setQuota(Quota quota) throws MessagingException
getQuota
method, but it need not be.setQuota
in interface QuotaAwareStore
quota
- the quota to setMessagingException
- if the server doesn't support the
QUOTA extensionpublic void handleResponse(Response r)
handleResponse
in interface ResponseHandler
public void idle() throws MessagingException
ConnectionListener
to be notified of
events. When another thread (e.g., the listener thread)
needs to issue an IMAP comand for this Store, the idle mode will
be terminated and this method will return. Typically the caller
will invoke this method in a loop.
If the mail.imap.enableimapevents property is set, notifications
received while the IDLE command is active will be delivered to
ConnectionListener
s as events with a type of
IMAPStore.RESPONSE
. The event's message will be
the raw IMAP response string.
Note that most IMAP servers will not deliver any events when
using the IDLE command on a connection with no mailbox selected
(i.e., this method). In most cases you'll want to use the
idle
method on IMAPFolder
.
NOTE: This capability is highly experimental and likely will change in future releases.
The mail.imap.minidletime property enforces a minimum delay before returning from this method, to ensure that other threads have a chance to issue commands before the caller invokes this method again. The default delay is 10 milliseconds.
MessagingException
- if the server doesn't support the
IDLE extensionIllegalStateException
- if the store isn't connectedpublic Map<String,String> id(Map<String,String> clientParams) throws MessagingException
clientParams
- a Map of keys and values identifying the clientMessagingException
- if the server doesn't support the
ID extensionCopyright © 2019 Eclipse Foundation. Use is subject to license terms.