IMAPConnection (gnu-classpath-ext-inetlib 1.1.1 API)

java.lang.Object
- gnu.inet.imap.IMAPConnection

All Implemented Interfaces:

IMAPConstants
```
public class IMAPConnection
extends Object
implements IMAPConstants
```
The protocol class implementing IMAP4rev1.

Author:

Chris Burdess

Field Summary

Fields
Modifier and Type	Field and Description
`protected List`	`asyncResponses` List of responses received asynchronously.
`protected static int`	`DEFAULT_PORT` The default IMAP port.
`protected static int`	`DEFAULT_SSL_PORT` The default IMAP-SSL port.
`static Level`	`IMAP_TRACE` The network trace level.
`protected IMAPResponseTokenizer`	`in` The tokenizer used to read IMAP responses from.
`static Logger`	`logger` The logger used for IMAP protocol traces.
`protected CRLFOutputStream`	`out` The output stream.
`protected Socket`	`socket` The socket used for communication with the server.
`protected static String`	`TAG_PREFIX` Prefix for tags.
`protected static String`	`US_ASCII` The encoding used to create strings for IMAP commands.

Fields inherited from interface gnu.inet.imap.IMAPConstants
ACL, ALERT, APPEND, AUTHENTICATE, BAD, BODY, BODY_PEEK, BODYSTRUCTURE, BYE, CAPABILITY, CHECK, CLOSE, COPY, CRAM_MD5, CREATE, DELETE, DELETEACL, ENVELOPE, EXAMINE, EXISTS, EXPUNGE, FETCH, FETCH_FLAGS, FLAG_ANSWERED, FLAG_DELETED, FLAG_DRAFT, FLAG_FLAGGED, FLAG_RECENT, FLAG_SEEN, FLAGS, GETACL, GETQUOTA, GETQUOTAROOT, GSSAPI, HEADER, HEADER_FIELDS, HEADER_FIELDS_NOT, INTERNALDATE, KERBEROS_V4, LIST, LIST_MARKED, LIST_NOINFERIORS, LIST_NOSELECT, LIST_UNMARKED, LISTRIGHTS, LOGIN, LOGINDISABLED, LOGOUT, LSUB, MESSAGES, MYRIGHTS, NAMESPACE, NEWNAME, NIL, NO, NOOP, OK, PARSE, PERMANENTFLAGS, PREAUTH, QUOTA, QUOTAROOT, READ_ONLY, READ_WRITE, RECENT, RENAME, RFC822, RFC822_HEADER, RFC822_SIZE, RFC822_TEXT, RIGHTS_ADMIN, RIGHTS_CREATE, RIGHTS_DELETE, RIGHTS_INSERT, RIGHTS_LOOKUP, RIGHTS_POST, RIGHTS_READ, RIGHTS_SEEN, RIGHTS_WRITE, SEARCH, SEARCH_ALL, SEARCH_ANSWERED, SEARCH_BCC, SEARCH_BEFORE, SEARCH_BODY, SEARCH_CC, SEARCH_DELETED, SEARCH_DRAFT, SEARCH_FLAGGED, SEARCH_FROM, SEARCH_HEADER, SEARCH_KEYWORD, SEARCH_LARGER, SEARCH_NEW, SEARCH_NOT, SEARCH_OLD, SEARCH_ON, SEARCH_OR, SEARCH_RECENT, SEARCH_SEEN, SEARCH_SENTBEFORE, SEARCH_SENTON, SEARCH_SENTSINCE, SEARCH_SINCE, SEARCH_SMALLER, SEARCH_SUBJECT, SEARCH_TEXT, SEARCH_TO, SEARCH_UID, SEARCH_UNANSWERED, SEARCH_UNDELETED, SEARCH_UNDRAFT, SEARCH_UNFLAGGED, SEARCH_UNKEYWORD, SEARCH_UNSEEN, SELECT, SETACL, SETQUOTA, SKEY, STARTTLS, STATUS, STORAGE, STORE, SUBSCRIBE, TRYCREATE, UID, UIDNEXT, UIDVALIDITY, UNSEEN, UNSUBSCRIBE

Constructor Summary

Constructors
Constructor and Description
`IMAPConnection(String host)` Creates a new connection to the default IMAP port.
`IMAPConnection(String host, int port)` Creates a new connection.
`IMAPConnection(String host, int port, int connectionTimeout, int timeout)` Creates a new connection.
`IMAPConnection(String host, int port, int connectionTimeout, int timeout, boolean secure, TrustManager tm)` Creates a new connection.
`IMAPConnection(String host, int port, TrustManager tm)` Creates a new secure connection using the specified trust manager.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`alertsPending()` Indicates if there are alerts pending for the user-agent.
`boolean`	`append(String mailbox, String[] flags, byte[] content)` Append a message to the specified mailbox.
`boolean`	`authenticate(String mechanism, String username, String password)` Authenticates the connection using the specified SASL mechanism, username, and password.
`List`	`capability()` Returns a list of the capabilities of the IMAP server.
`void`	`check()` Request a checkpoint of the currently selected mailbox.
`boolean`	`close()` Permanently remove all messages that have the \Deleted flags set, and close the mailbox.
`boolean`	`copy(int[] messages, String mailbox)` Copies the specified messages to the end of the destination mailbox.
`boolean`	`create(String mailbox)` Creates a mailbox with the specified name.
`boolean`	`delete(String mailbox)` Deletes the mailbox with the specified name.
`boolean`	`deleteacl(String mailbox, String principal)` Removes any access rights for the given authentication principal on the specified mailbox.
`MailboxStatus`	`examine(String mailbox)` Selects the specified mailbox.
`int[]`	`expunge()` Permanently removes all messages that have the \Delete flag set.
`MessageStatus[]`	`fetch(int[] messages, String[] fetchCommands)` Retrieves data associated with messages in the mailbox.
`MessageStatus[]`	`fetch(int start, int end, String[] fetchCommands)` Retrieves data associated with the specified range of messages in the mailbox.
`MessageStatus`	`fetch(int message, String[] fetchCommands)` Retrieves data associated with the specified message in the mailbox.
`Map`	`getacl(String mailbox)` Returns the access control list for the specified mailbox.
`String[]`	`getAlerts()` Returns the pending alerts for the user-agent as an array.
`Quota`	`getquota(String quotaRoot)` Returns the specified quota root's resource usage and limits.
`Quota[]`	`getquotaroot(String mailbox)` Returns the quotas for the given mailbox.
`protected SSLSocketFactory`	`getSSLSocketFactory(TrustManager tm)` Returns a configured SSLSocketFactory to use in creating new SSL sockets.
`protected boolean`	`invokeSimpleCommand(String command)` Sends the specified IMAP command.
`ListEntry[]`	`list(String reference, String mailbox)` Returns a subset of names from the compete set of names available to the client.
`protected ListEntry[]`	`listImpl(String command, String reference, String mailbox)`
`int`	`listrights(String mailbox, String principal)` Returns the rights for the given principal for the specified mailbox.
`boolean`	`login(String username, String password)` Login to the connection using the username and password method.
`void`	`logout()` Logout this connection.
`ListEntry[]`	`lsub(String reference, String mailbox)` Returns a subset of subscribed names.
`int`	`myrights(String mailbox)` Returns the rights for the current principal for the specified mailbox.
`Namespaces`	`namespace()` Returns the namespaces available on the server.
`protected String`	`newTag()` Returns a new tag for a command.
`MailboxStatus`	`noop()` Ping the server.
`protected IMAPResponse`	`readResponse()` Reads an IMAP response from the server.
`boolean`	`rename(String source, String target)` Renames the source mailbox to the specified name.
`int[]`	`search(String charset, String[] criteria)` Searches the currently selected mailbox for messages matching the specified criteria.
`MailboxStatus`	`select(String mailbox)` Selects the specified mailbox.
`protected MailboxStatus`	`selectImpl(String mailbox, String command)`
`protected void`	`sendCommand(String tag, String command)` Sends the specified IMAP tagged command to the server.
`boolean`	`setacl(String mailbox, String principal, int rights)` Changes the access rights on the specified mailbox such that the authentication principal is granted the specified permissions.
`void`	`setAnsiDebug(boolean flag)` Sets whether debugging output should use ANSI colour escape sequences.
`Quota`	`setquota(String quotaRoot, Quota.Resource[] resources)` Sets the quota for the specified quota root.
`boolean`	`starttls()` Attempts to start TLS on the specified connection.
`boolean`	`starttls(TrustManager tm)` Attempts to start TLS on the specified connection.
`MailboxStatus`	`status(String mailbox, String[] statusNames)` Requests the status of the specified mailbox.
`MessageStatus[]`	`store(int[] messages, String flagCommand, String[] flags)` Alters data associated with messages in the mailbox.
`MessageStatus[]`	`store(int start, int end, String flagCommand, String[] flags)` Alters data associated with the specified range of messages in the mailbox.
`MessageStatus`	`store(int message, String flagCommand, String[] flags)` Alters data associated with the specified message in the mailbox.
`boolean`	`subscribe(String mailbox)` Adds the specified mailbox to the set of subscribed mailboxes as returned by the LSUB command.
`MessageStatus[]`	`uidFetch(long[] uids, String[] fetchCommands)` Retrieves data associated with messages in the mailbox.
`MessageStatus[]`	`uidFetch(long start, long end, String[] fetchCommands)` Retrieves data associated with the specified range of messages in the mailbox.
`MessageStatus`	`uidFetch(long uid, String[] fetchCommands)` Retrieves data associated with the specified message in the mailbox.
`MessageStatus[]`	`uidStore(long[] uids, String flagCommand, String[] flags)` Alters data associated with messages in the mailbox.
`MessageStatus[]`	`uidStore(long start, long end, String flagCommand, String[] flags)` Alters data associated with the specified range of messages in the mailbox.
`MessageStatus`	`uidStore(long uid, String flagCommand, String[] flags)` Alters data associated with the specified message in the mailbox.
`boolean`	`unsubscribe(String mailbox)` Removes the specified mailbox from the set of subscribed mailboxes as returned by the LSUB command.
`protected boolean`	`updateMailboxStatus(MailboxStatus ms, String id, IMAPResponse response)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
public static final Logger logger
```
    The logger used for IMAP protocol traces.
  - IMAP_TRACE
```
public static final Level IMAP_TRACE
```
    The network trace level.
  - TAG_PREFIX
```
protected static final String TAG_PREFIX
```
    Prefix for tags.
    
    See Also:
    
    Constant Field Values
  - US_ASCII
```
protected static final String US_ASCII
```
    The encoding used to create strings for IMAP commands.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
protected static final int DEFAULT_PORT
```
    The default IMAP port.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_PORT
```
protected static final int DEFAULT_SSL_PORT
```
    The default IMAP-SSL port.
    
    See Also:
    
    Constant Field Values
  - socket
```
protected Socket socket
```
    The socket used for communication with the server.
  - in
```
protected IMAPResponseTokenizer in
```
    The tokenizer used to read IMAP responses from.
  - out
```
protected CRLFOutputStream out
```
    The output stream.
  - asyncResponses
```
protected List asyncResponses
```
    List of responses received asynchronously.
- Constructor Detail
  - IMAPConnection
```
public IMAPConnection(String host)
               throws UnknownHostException,
                      IOException
```
    Creates a new connection to the default IMAP port.
    
    Parameters:
    
    host - the name of the host to connect to
    
    Throws:
    
    UnknownHostException
    
    IOException
  - IMAPConnection
```
public IMAPConnection(String host,
                      int port)
               throws UnknownHostException,
                      IOException
```
    Creates a new connection.
    
    Parameters:
    
    host - the name of the host to connect to
    
    port - the port to connect to, or -1 for the default
    
    Throws:
    
    UnknownHostException
    
    IOException
  - IMAPConnection
```
public IMAPConnection(String host,
                      int port,
                      int connectionTimeout,
                      int timeout)
               throws UnknownHostException,
                      IOException
```
    Creates a new connection.
    
    Parameters:
    
    host - the name of the host to connect to
    
    port - the port to connect to, or -1 for the default
    
    connectionTimeout - the socket connection timeout
    
    timeout - the socket timeout
    
    Throws:
    
    UnknownHostException
    
    IOException
  - IMAPConnection
```
public IMAPConnection(String host,
                      int port,
                      TrustManager tm)
               throws UnknownHostException,
                      IOException
```
    Creates a new secure connection using the specified trust manager.
    
    Parameters:
    
    host - the name of the host to connect to
    
    port - the port to connect to, or -1 for the default
    
    tm - a trust manager used to check SSL certificates, or null to use the default
    
    Throws:
    
    UnknownHostException
    
    IOException
  - IMAPConnection
```
public IMAPConnection(String host,
                      int port,
                      int connectionTimeout,
                      int timeout,
                      boolean secure,
                      TrustManager tm)
               throws UnknownHostException,
                      IOException
```
    Creates a new connection.
    
    Parameters:
    
    host - the name of the host to connect to
    
    port - the port to connect to, or -1 for the default
    
    connectionTimeout - the socket connection timeout
    
    timeout - the socket timeout
    
    secure - if an IMAP-SSL connection should be made
    
    tm - a trust manager used to check SSL certificates, or null to use the default
    
    Throws:
    
    UnknownHostException
    
    IOException
- Method Detail
  - setAnsiDebug
```
public void setAnsiDebug(boolean flag)
```
    Sets whether debugging output should use ANSI colour escape sequences.
  - newTag
```
protected String newTag()
```
    Returns a new tag for a command.
  - sendCommand
```
protected void sendCommand(String tag,
                           String command)
                    throws IOException
```
    Sends the specified IMAP tagged command to the server.
    
    Throws:
    
    IOException
  - invokeSimpleCommand
```
protected boolean invokeSimpleCommand(String command)
                               throws IOException
```
    Sends the specified IMAP command.
    
    Parameters:
    
    command - the command
    
    Returns:
    
    true if OK was received, or false if NO was received
    
    Throws:
    
    IOException - if BAD was received or an I/O error occurred
  - readResponse
```
protected IMAPResponse readResponse()
                             throws IOException
```
    Reads an IMAP response from the server. The response will consist of either:
    - A tagged response corresponding to a pending command
    - An untagged error response
    - A continuation response
    Throws:
    
    IOException
  - alertsPending
```
public boolean alertsPending()
```
    Indicates if there are alerts pending for the user-agent.
  - getAlerts
```
public String[] getAlerts()
```
    Returns the pending alerts for the user-agent as an array.
  - capability
```
public List capability()
                throws IOException
```
    Returns a list of the capabilities of the IMAP server.
    
    Throws:
    
    IOException
  - noop
```
public MailboxStatus noop()
                   throws IOException
```
    Ping the server. If a change in mailbox state is detected, a new mailbox status is returned, otherwise this method returns null.
    
    Throws:
    
    IOException
  - getSSLSocketFactory
```
protected SSLSocketFactory getSSLSocketFactory(TrustManager tm)
                                        throws GeneralSecurityException
```
    Returns a configured SSLSocketFactory to use in creating new SSL sockets.
    
    Parameters:
    
    tm - an optional trust manager to use
    
    Throws:
    
    GeneralSecurityException
  - starttls
```
public boolean starttls()
                 throws IOException
```
    Attempts to start TLS on the specified connection. See RFC 2595 for details.
    
    Returns:
    
    true if successful, false otherwise
    
    Throws:
    
    IOException
  - starttls
```
public boolean starttls(TrustManager tm)
                 throws IOException
```
    Attempts to start TLS on the specified connection. See RFC 2595 for details.
    
    Parameters:
    
    tm - the custom trust manager to use
    
    Returns:
    
    true if successful, false otherwise
    
    Throws:
    
    IOException
  - login
```
public boolean login(String username,
                     String password)
              throws IOException
```
    Login to the connection using the username and password method.
    
    Parameters:
    
    username - the authentication principal
    
    password - the authentication credentials
    
    Returns:
    
    true if authentication was successful, false otherwise
    
    Throws:
    
    IOException
  - authenticate
```
public boolean authenticate(String mechanism,
                            String username,
                            String password)
                     throws IOException
```
    Authenticates the connection using the specified SASL mechanism, username, and password.
    
    Parameters:
    
    mechanism - a SASL authentication mechanism, e.g. LOGIN, PLAIN, CRAM-MD5, GSSAPI
    
    username - the authentication principal
    
    password - the authentication credentials
    
    Returns:
    
    true if authentication was successful, false otherwise
    
    Throws:
    
    IOException
  - logout
```
public void logout()
            throws IOException
```
    Logout this connection. Underlying network resources will be freed.
    
    Throws:
    
    IOException
  - select
```
public MailboxStatus select(String mailbox)
                     throws IOException
```
    Selects the specified mailbox. The mailbox is identified as read-write if writes are permitted.
    
    Parameters:
    
    mailbox - the mailbox name
    
    Returns:
    
    a MailboxStatus containing the state of the selected mailbox
    
    Throws:
    
    IOException
  - examine
```
public MailboxStatus examine(String mailbox)
                      throws IOException
```
    Selects the specified mailbox. The mailbox is identified as read-only.
    
    Parameters:
    
    mailbox - the mailbox name
    
    Returns:
    
    a MailboxStatus containing the state of the selected mailbox
    
    Throws:
    
    IOException
  - selectImpl
```
protected MailboxStatus selectImpl(String mailbox,
                                   String command)
                            throws IOException
```
    Throws:
    
    IOException
  - updateMailboxStatus
```
protected boolean updateMailboxStatus(MailboxStatus ms,
                                      String id,
                                      IMAPResponse response)
                               throws IOException
```
    Throws:
    
    IOException
  - create
```
public boolean create(String mailbox)
               throws IOException
```
    Creates a mailbox with the specified name.
    
    Parameters:
    
    mailbox - the mailbox name
    
    Returns:
    
    true if the mailbox was successfully created, false otherwise
    
    Throws:
    
    IOException
  - delete
```
public boolean delete(String mailbox)
               throws IOException
```
    Deletes the mailbox with the specified name.
    
    Parameters:
    
    mailbox - the mailbox name
    
    Returns:
    
    true if the mailbox was successfully deleted, false otherwise
    
    Throws:
    
    IOException
  - rename
```
public boolean rename(String source,
                      String target)
               throws IOException
```
    Renames the source mailbox to the specified name.
    
    Parameters:
    
    source - the source mailbox name
    
    target - the target mailbox name
    
    Returns:
    
    true if the mailbox was successfully renamed, false otherwise
    
    Throws:
    
    IOException
  - subscribe
```
public boolean subscribe(String mailbox)
                  throws IOException
```
    Adds the specified mailbox to the set of subscribed mailboxes as returned by the LSUB command.
    
    Parameters:
    
    mailbox - the mailbox name
    
    Returns:
    
    true if the mailbox was successfully subscribed, false otherwise
    
    Throws:
    
    IOException
  - unsubscribe
```
public boolean unsubscribe(String mailbox)
                    throws IOException
```
    Removes the specified mailbox from the set of subscribed mailboxes as returned by the LSUB command.
    
    Parameters:
    
    mailbox - the mailbox name
    
    Returns:
    
    true if the mailbox was successfully unsubscribed, false otherwise
    
    Throws:
    
    IOException
  - list
```
public ListEntry[] list(String reference,
                        String mailbox)
                 throws IOException
```
    Returns a subset of names from the compete set of names available to the client.
    
    Parameters:
    
    reference - the context relative to which mailbox names are defined
    
    mailbox - a mailbox name, possibly including IMAP wildcards
    
    Throws:
    
    IOException
  - lsub
```
public ListEntry[] lsub(String reference,
                        String mailbox)
                 throws IOException
```
    Returns a subset of subscribed names.
    
    Throws:
    
    IOException
    
    See Also:
    
    list(java.lang.String, java.lang.String)
  - listImpl
```
protected ListEntry[] listImpl(String command,
                               String reference,
                               String mailbox)
                        throws IOException
```
    Throws:
    
    IOException
  - status
```
public MailboxStatus status(String mailbox,
                            String[] statusNames)
                     throws IOException
```
    Requests the status of the specified mailbox.
    
    Throws:
    
    IOException
  - append
```
public boolean append(String mailbox,
                      String[] flags,
                      byte[] content)
               throws IOException
```
    Append a message to the specified mailbox. This method returns an OutputStream to which the message should be written and then closed.
    
    Parameters:
    
    mailbox - the mailbox name
    
    flags - optional list of flags to specify for the message
    
    content - the message body(including headers)
    
    Returns:
    
    true if successful, false if error in flags/text
    
    Throws:
    
    IOException
  - check
```
public void check()
           throws IOException
```
    Request a checkpoint of the currently selected mailbox.
    
    Throws:
    
    IOException
  - close
```
public boolean close()
              throws IOException
```
    Permanently remove all messages that have the \Deleted flags set, and close the mailbox.
    
    Returns:
    
    true if successful, false if no mailbox was selected
    
    Throws:
    
    IOException
  - expunge
```
public int[] expunge()
              throws IOException
```
    Permanently removes all messages that have the \Delete flag set.
    
    Returns:
    
    the numbers of the messages expunged
    
    Throws:
    
    IOException
  - search
```
public int[] search(String charset,
                    String[] criteria)
             throws IOException
```
    Searches the currently selected mailbox for messages matching the specified criteria.
    
    Throws:
    
    IOException
  - fetch
```
public MessageStatus fetch(int message,
                           String[] fetchCommands)
                    throws IOException
```
    Retrieves data associated with the specified message in the mailbox.
    
    Parameters:
    
    message - the message number
    
    fetchCommands - the fetch commands, e.g. FLAGS
    
    Throws:
    
    IOException
  - fetch
```
public MessageStatus[] fetch(int start,
                             int end,
                             String[] fetchCommands)
                      throws IOException
```
    Retrieves data associated with the specified range of messages in the mailbox.
    
    Parameters:
    
    start - the message number of the first message
    
    end - the message number of the last message
    
    fetchCommands - the fetch commands, e.g. FLAGS
    
    Throws:
    
    IOException
  - fetch
```
public MessageStatus[] fetch(int[] messages,
                             String[] fetchCommands)
                      throws IOException
```
    Retrieves data associated with messages in the mailbox.
    
    Parameters:
    
    messages - the message numbers
    
    fetchCommands - the fetch commands, e.g. FLAGS
    
    Throws:
    
    IOException
  - uidFetch
```
public MessageStatus uidFetch(long uid,
                              String[] fetchCommands)
                       throws IOException
```
    Retrieves data associated with the specified message in the mailbox.
    
    Parameters:
    
    uid - the message UID
    
    fetchCommands - the fetch commands, e.g. FLAGS
    
    Throws:
    
    IOException
  - uidFetch
```
public MessageStatus[] uidFetch(long start,
                                long end,
                                String[] fetchCommands)
                         throws IOException
```
    Retrieves data associated with the specified range of messages in the mailbox.
    
    Parameters:
    
    start - the message number of the first message
    
    end - the message number of the last message
    
    fetchCommands - the fetch commands, e.g. FLAGS
    
    Throws:
    
    IOException
  - uidFetch
```
public MessageStatus[] uidFetch(long[] uids,
                                String[] fetchCommands)
                         throws IOException
```
    Retrieves data associated with messages in the mailbox.
    
    Parameters:
    
    uids - the message UIDs
    
    fetchCommands - the fetch commands, e.g. FLAGS
    
    Throws:
    
    IOException
  - store
```
public MessageStatus store(int message,
                           String flagCommand,
                           String[] flags)
                    throws IOException
```
    Alters data associated with the specified message in the mailbox.
    
    Parameters:
    
    message - the message number
    
    flagCommand - FLAGS, +FLAGS, -FLAGS(or .SILENT versions)
    
    flags - message flags to set
    
    Returns:
    
    the message status
    
    Throws:
    
    IOException
  - store
```
public MessageStatus[] store(int start,
                             int end,
                             String flagCommand,
                             String[] flags)
                      throws IOException
```
    Alters data associated with the specified range of messages in the mailbox.
    
    Parameters:
    
    start - the message number of the first message
    
    end - the message number of the last message
    
    flagCommand - FLAGS, +FLAGS, -FLAGS(or .SILENT versions)
    
    flags - message flags to set
    
    Returns:
    
    a list of message-number to current flags
    
    Throws:
    
    IOException
  - store
```
public MessageStatus[] store(int[] messages,
                             String flagCommand,
                             String[] flags)
                      throws IOException
```
    Alters data associated with messages in the mailbox.
    
    Parameters:
    
    messages - the message numbers
    
    flagCommand - FLAGS, +FLAGS, -FLAGS(or .SILENT versions)
    
    flags - message flags to set
    
    Returns:
    
    a list of message-number to current flags
    
    Throws:
    
    IOException
  - uidStore
```
public MessageStatus uidStore(long uid,
                              String flagCommand,
                              String[] flags)
                       throws IOException
```
    Alters data associated with the specified message in the mailbox.
    
    Parameters:
    
    uid - the message UID
    
    flagCommand - FLAGS, +FLAGS, -FLAGS(or .SILENT versions)
    
    flags - message flags to set
    
    Returns:
    
    the message status
    
    Throws:
    
    IOException
  - uidStore
```
public MessageStatus[] uidStore(long start,
                                long end,
                                String flagCommand,
                                String[] flags)
                         throws IOException
```
    Alters data associated with the specified range of messages in the mailbox.
    
    Parameters:
    
    start - the UID of the first message
    
    end - the UID of the last message
    
    flagCommand - FLAGS, +FLAGS, -FLAGS(or .SILENT versions)
    
    flags - message flags to set
    
    Returns:
    
    a list of message-number to current flags
    
    Throws:
    
    IOException
  - uidStore
```
public MessageStatus[] uidStore(long[] uids,
                                String flagCommand,
                                String[] flags)
                         throws IOException
```
    Alters data associated with messages in the mailbox.
    
    Parameters:
    
    uids - the message UIDs
    
    flagCommand - FLAGS, +FLAGS, -FLAGS(or .SILENT versions)
    
    flags - message flags to set
    
    Returns:
    
    a list of message-number to current flags
    
    Throws:
    
    IOException
  - copy
```
public boolean copy(int[] messages,
                    String mailbox)
             throws IOException
```
    Copies the specified messages to the end of the destination mailbox.
    
    Parameters:
    
    messages - the message numbers
    
    mailbox - the destination mailbox
    
    Throws:
    
    IOException
  - namespace
```
public Namespaces namespace()
                     throws IOException
```
    Returns the namespaces available on the server. See RFC 2342 for details.
    
    Throws:
    
    IOException
  - setacl
```
public boolean setacl(String mailbox,
                      String principal,
                      int rights)
               throws IOException
```
    Changes the access rights on the specified mailbox such that the authentication principal is granted the specified permissions.
    
    Parameters:
    
    mailbox - the mailbox name
    
    principal - the authentication identifier
    
    rights - the rights to assign
    
    Throws:
    
    IOException
  - deleteacl
```
public boolean deleteacl(String mailbox,
                         String principal)
                  throws IOException
```
    Removes any access rights for the given authentication principal on the specified mailbox.
    
    Parameters:
    
    mailbox - the mailbox name
    
    principal - the authentication identifier
    
    Throws:
    
    IOException
  - getacl
```
public Map getacl(String mailbox)
           throws IOException
```
    Returns the access control list for the specified mailbox. The returned rights are a logical OR of RIGHTS_* bits.
    
    Parameters:
    
    mailbox - the mailbox name
    
    Returns:
    
    a map of principal names to Integer rights
    
    Throws:
    
    IOException
  - listrights
```
public int listrights(String mailbox,
                      String principal)
               throws IOException
```
    Returns the rights for the given principal for the specified mailbox. The returned rights are a logical OR of RIGHTS_* bits.
    
    Parameters:
    
    mailbox - the mailbox name
    
    principal - the authentication identity
    
    Throws:
    
    IOException
  - myrights
```
public int myrights(String mailbox)
             throws IOException
```
    Returns the rights for the current principal for the specified mailbox. The returned rights are a logical OR of RIGHTS_* bits.
    
    Parameters:
    
    mailbox - the mailbox name
    
    Throws:
    
    IOException
  - setquota
```
public Quota setquota(String quotaRoot,
                      Quota.Resource[] resources)
               throws IOException
```
    Sets the quota for the specified quota root.
    
    Parameters:
    
    quotaRoot - the quota root
    
    resources - the list of resources and associated limits to set
    
    Returns:
    
    the new quota, or null if the operation failed
    
    Throws:
    
    IOException
  - getquota
```
public Quota getquota(String quotaRoot)
               throws IOException
```
    Returns the specified quota root's resource usage and limits.
    
    Parameters:
    
    quotaRoot - the quota root
    
    Throws:
    
    IOException
  - getquotaroot
```
public Quota[] getquotaroot(String mailbox)
                     throws IOException
```
    Returns the quotas for the given mailbox.
    
    Parameters:
    
    mailbox - the mailbox name
    
    Throws:
    
    IOException

Class IMAPConnection

Field Summary

Fields inherited from interface gnu.inet.imap.IMAPConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

IMAP_TRACE

TAG_PREFIX

US_ASCII

DEFAULT_PORT

DEFAULT_SSL_PORT

socket

in

out

asyncResponses

Constructor Detail

IMAPConnection

IMAPConnection

IMAPConnection

IMAPConnection

IMAPConnection

Method Detail

setAnsiDebug

newTag

sendCommand

invokeSimpleCommand

readResponse

alertsPending

getAlerts

capability

noop

getSSLSocketFactory

starttls

starttls

login

authenticate

logout

select

examine

selectImpl

updateMailboxStatus

create

delete

rename

subscribe

unsubscribe

list

lsub

listImpl

status

append

check

close

expunge

search

fetch

fetch

fetch

uidFetch

uidFetch

uidFetch

store

store

store

uidStore

uidStore

uidStore

copy

namespace

setacl

deleteacl

getacl

listrights

myrights

setquota

getquota

getquotaroot