ResponseHandler
, java.lang.AutoCloseable
, javax.mail.QuotaAwareStore
IMAPSSLStore
public class IMAPStore extends javax.mail.Store implements javax.mail.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 | Description |
---|---|---|
protected java.lang.String |
authorizationID |
|
protected int |
defaultPort |
|
protected java.lang.String |
host |
|
static java.lang.String |
ID_ADDRESS |
|
static java.lang.String |
ID_ARGUMENTS |
|
static java.lang.String |
ID_COMMAND |
|
static java.lang.String |
ID_DATE |
|
static java.lang.String |
ID_ENVIRONMENT |
|
static java.lang.String |
ID_NAME |
|
static java.lang.String |
ID_OS |
|
static java.lang.String |
ID_OS_VERSION |
|
static java.lang.String |
ID_SUPPORT_URL |
|
static java.lang.String |
ID_VENDOR |
|
static java.lang.String |
ID_VERSION |
|
protected boolean |
isSSL |
|
protected com.sun.mail.util.MailLogger |
logger |
|
protected java.lang.String |
name |
|
protected java.lang.String |
password |
|
protected java.lang.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 java.lang.String |
saslRealm |
|
protected java.lang.String |
user |
Modifier | Constructor | Description |
---|---|---|
|
IMAPStore(javax.mail.Session session,
javax.mail.URLName url) |
Constructor that takes a Session object and a URLName that
represents a specific IMAP server.
|
protected |
IMAPStore(javax.mail.Session session,
javax.mail.URLName url,
java.lang.String name,
boolean isSSL) |
Constructor used by this class and by IMAPSSLStore subclass.
|
Modifier and Type | Method | Description |
---|---|---|
void |
close() |
Close this Store.
|
protected void |
finalize() |
|
javax.mail.Folder |
getDefaultFolder() |
Get the default folder, representing the root of this user's
namespace.
|
javax.mail.Folder |
getFolder(java.lang.String name) |
Get named folder.
|
javax.mail.Folder |
getFolder(javax.mail.URLName url) |
Get named folder.
|
javax.mail.Folder[] |
getPersonalNamespaces() |
Using the IMAP NAMESPACE command (RFC 2342), return a set
of folders representing the Personal namespaces.
|
java.lang.String |
getProxyAuthUser() |
Get the user name to be used with the PROXYAUTH command.
|
javax.mail.Quota[] |
getQuota(java.lang.String root) |
Get the quotas for the named quota root.
|
javax.mail.Folder[] |
getSharedNamespaces() |
Using the IMAP NAMESPACE command (RFC 2342), return a set
of folders representing the Shared namespaces.
|
javax.mail.Folder[] |
getUserNamespaces(java.lang.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(java.lang.String capability) |
Return true if the specified capability string is in the list
of capabilities the server announced.
|
java.util.Map<java.lang.String,java.lang.String> |
id(java.util.Map<java.lang.String,java.lang.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(com.sun.mail.imap.protocol.ListInfo li) |
Create an IMAPFolder object.
|
protected IMAPFolder |
newIMAPFolder(java.lang.String fullName,
char separator) |
Create an IMAPFolder object.
|
protected IMAPFolder |
newIMAPFolder(java.lang.String fullName,
char separator,
java.lang.Boolean isNamespace) |
Create an IMAPFolder object.
|
protected com.sun.mail.imap.protocol.IMAPProtocol |
newIMAPProtocol(java.lang.String host,
int port) |
Create an IMAPProtocol object connected to the host and port.
|
protected void |
preLogin(com.sun.mail.imap.protocol.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(java.lang.String host,
int pport,
java.lang.String user,
java.lang.String password) |
Implementation of protocolConnect().
|
void |
setPassword(java.lang.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(java.lang.String user) |
Set the user name to be used with the PROXYAUTH command.
|
void |
setQuota(javax.mail.Quota quota) |
Set the quotas for the quota root specified in the quota argument.
|
void |
setUsername(java.lang.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
public static final int RESPONSE
public static final java.lang.String ID_NAME
public static final java.lang.String ID_VERSION
public static final java.lang.String ID_OS
public static final java.lang.String ID_OS_VERSION
public static final java.lang.String ID_VENDOR
public static final java.lang.String ID_SUPPORT_URL
public static final java.lang.String ID_ADDRESS
public static final java.lang.String ID_DATE
public static final java.lang.String ID_COMMAND
public static final java.lang.String ID_ARGUMENTS
public static final java.lang.String ID_ENVIRONMENT
protected final java.lang.String name
protected final int defaultPort
protected final boolean isSSL
protected java.lang.String host
protected java.lang.String user
protected java.lang.String password
protected java.lang.String proxyAuthUser
protected java.lang.String authorizationID
protected java.lang.String saslRealm
protected com.sun.mail.util.MailLogger logger
public IMAPStore(javax.mail.Session session, javax.mail.URLName url)
session
- the Sessionurl
- the URLName of this storeprotected IMAPStore(javax.mail.Session session, javax.mail.URLName url, java.lang.String name, boolean isSSL)
session
- the Sessionurl
- the URLName of this storename
- the protocol name for this storeisSSL
- use SSL?protected boolean protocolConnect(java.lang.String host, int pport, java.lang.String user, java.lang.String password) throws javax.mail.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 javax.mail.Service
javax.mail.MessagingException
protected com.sun.mail.imap.protocol.IMAPProtocol newIMAPProtocol(java.lang.String host, int port) throws java.io.IOException, ProtocolException
host
- the host nameport
- the port numberjava.io.IOException
- for I/O errorsProtocolException
- for protocol errorsprotected void preLogin(com.sun.mail.imap.protocol.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(java.lang.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(java.lang.String password)
Most applications will never need to use this method.
password
- the password for the storepublic boolean hasCapability(java.lang.String capability) throws javax.mail.MessagingException
capability
- the capability stringjavax.mail.MessagingException
- for failurespublic void setProxyAuthUser(java.lang.String user)
mail.imap.proxyauth.user
property when this
Store is created.user
- the user name to setpublic java.lang.String getProxyAuthUser()
public boolean isConnected()
isConnected
in class javax.mail.Service
public void close() throws javax.mail.MessagingException
close
in interface java.lang.AutoCloseable
close
in class javax.mail.Service
javax.mail.MessagingException
protected void finalize() throws java.lang.Throwable
finalize
in class javax.mail.Service
java.lang.Throwable
public javax.mail.Folder getDefaultFolder() throws javax.mail.MessagingException
getDefaultFolder
in class javax.mail.Store
javax.mail.MessagingException
public javax.mail.Folder getFolder(java.lang.String name) throws javax.mail.MessagingException
getFolder
in class javax.mail.Store
javax.mail.MessagingException
public javax.mail.Folder getFolder(javax.mail.URLName url) throws javax.mail.MessagingException
getFolder
in class javax.mail.Store
javax.mail.MessagingException
protected IMAPFolder newIMAPFolder(java.lang.String fullName, char separator, java.lang.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(java.lang.String fullName, char separator)
fullName
- the full name of the folderseparator
- the separator character for the folder hierarchyprotected IMAPFolder newIMAPFolder(com.sun.mail.imap.protocol.ListInfo li)
li
- the ListInfo for the folderpublic javax.mail.Folder[] getPersonalNamespaces() throws javax.mail.MessagingException
getPersonalNamespaces
in class javax.mail.Store
javax.mail.MessagingException
public javax.mail.Folder[] getUserNamespaces(java.lang.String user) throws javax.mail.MessagingException
getUserNamespaces
in class javax.mail.Store
javax.mail.MessagingException
public javax.mail.Folder[] getSharedNamespaces() throws javax.mail.MessagingException
getSharedNamespaces
in class javax.mail.Store
javax.mail.MessagingException
public javax.mail.Quota[] getQuota(java.lang.String root) throws javax.mail.MessagingException
getQuota
in interface javax.mail.QuotaAwareStore
root
- the name of the quota rootjavax.mail.MessagingException
- if the server doesn't support the
QUOTA extensionpublic void setQuota(javax.mail.Quota quota) throws javax.mail.MessagingException
getQuota
method, but it need not be.setQuota
in interface javax.mail.QuotaAwareStore
quota
- the quota to setjavax.mail.MessagingException
- if the server doesn't support the
QUOTA extensionpublic void handleResponse(Response r)
handleResponse
in interface ResponseHandler
public void idle() throws javax.mail.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.
javax.mail.MessagingException
- if the server doesn't support the
IDLE extensionjava.lang.IllegalStateException
- if the store isn't connectedpublic java.util.Map<java.lang.String,java.lang.String> id(java.util.Map<java.lang.String,java.lang.String> clientParams) throws javax.mail.MessagingException
clientParams
- a Map of keys and values identifying the clientjavax.mail.MessagingException
- if the server doesn't support the
ID extension