IMAPAdapter (GNU inetlib API documentation)

JavaScript is disabled on your browser.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

gnu.inet.imap

Class IMAPAdapter

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

All Implemented Interfaces:

IMAPCallback
```
public class IMAPAdapter
extends java.lang.Object
implements IMAPCallback 
```
Adapter for an IMAP response callback. This is provided for convenience of implementation.

Since:

1.2

Constructor Summary

Constructors
Constructor and Description

IMAPAdapter ()

IMAPAdapter (IMAPCallback proxy)

Constructors
Constructor and Description
`IMAPAdapter ()`
`IMAPAdapter (IMAPCallback proxy)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`acl (java.lang.String mailbox, java.util.Map<java.lang.String,java.lang.String> rights)` Notification of access control rights.
`void`	`alert (java.lang.String message)` Notification of a user alert.
`void`	`appenduid (long uidvalidity, long uid)` Indicates that the message has been appended to the destination mailbox.
`void`	`capability (java.util.List<java.lang.String> capabilities)` Notification of capabilities change.
`void`	`copyuid (long uidvalidity, UIDSet source, UIDSet destination)` Indicates that the message(s) have been copied to the destination mailbox with the stated UID(s).
`void`	`exists (int messages)` Notification of the number of messages in a mailbox.
`void`	`expunge (int message)` Notification that a given messages has been permanently deleted.
`void`	`fetch (int message, java.util.List<FetchDataItem> data)` Notification of data specific to a message
`void`	`firstUnseen (int message)` The message sequence number of the first unseen message in the mailbox.
`void`	`flags (java.util.List<java.lang.String> flags)` Notification of the flags applicable for the associated mailbox.
`void`	`list (java.util.List<java.lang.String> attributes, java.lang.String delimiter, java.lang.String mailbox)` Notification of a list entry.
`void`	`listrights (java.lang.String mailbox, java.lang.String identifier, java.lang.String required, java.util.List<java.lang.String> optional)` Notification of a list of rights.
`void`	`myrights (java.lang.String mailbox, java.lang.String rights)` Notification of the user's rights with respect to the mailbox.
`void`	`namespace (Namespace personal, Namespace otherUsers, Namespace shared)` Notification of a namespace result.
`void`	`permanentflags (java.util.List<java.lang.String> flags)` Notification of the permanent flags applicable for the associated mailbox.
`void`	`quota (java.lang.String quotaRoot, java.util.Map<java.lang.String,java.lang.Integer> currentUsage, java.util.Map<java.lang.String,java.lang.Integer> limit)` Notification of a quota.
`void`	`quotaroot (java.lang.String mailbox, java.util.List<java.lang.String> quotaRoots)` Notification of the quota roots for a mailbox.
`void`	`readOnly ()` Indicates that the mailbox was opened read-only.
`void`	`readWrite ()` Indicates that the mailbox was opened read-write.
`void`	`recent (int messages)` Notification of the number of messages with the recent flag set.
`void`	`search (java.util.List<java.lang.Integer> results)` Notification of a search result.
`void`	`tryCreate ()` Indicates that the mailbox does not exist yet but could be created.
`void`	`uidnext (long uid)` The next unique identifier value.
`void`	`uidnotsticky ()` Indicates that the server does not support persistent UIDs, and APPEND and COPY will not return APPENDUID or COPYUID responses.
`void`	`uidvalidity (long uidvalidity)` The unique identifier validity value.
`void`	`unseen (int messages)` The number of messages which do not have the \Seen flag set.

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

- Constructor Detail
  - IMAPAdapter
```
public IMAPAdapter()
```
  - IMAPAdapter
```
public IMAPAdapter(IMAPCallback proxy)
```
- Method Detail
  - alert
```
public void alert(java.lang.String message)
```
    Description copied from interface: IMAPCallback
    
    Notification of a user alert. This should be displayed to the user somehow.
    
    Specified by:
    
    alert in interface IMAPCallback
    
    Parameters:
    message - the message text
  - capability
```
public void capability(java.util.List<java.lang.String> capabilities)
```
    Description copied from interface: IMAPCallback
    
    Notification of capabilities change.
    
    Specified by:
    
    capability in interface IMAPCallback
    
    Parameters:
    capabilities - the new capabilities
  - exists
```
public void exists(int messages)
```
    Description copied from interface: IMAPCallback
    
    Notification of the number of messages in a mailbox.
    
    Specified by:
    
    exists in interface IMAPCallback
    
    Parameters:
    messages - the number of messages
  - recent
```
public void recent(int messages)
```
    Description copied from interface: IMAPCallback
    
    Notification of the number of messages with the recent flag set.
    
    Specified by:
    
    recent in interface IMAPCallback
    
    Parameters:
    messages - the number of messages
  - expunge
```
public void expunge(int message)
```
    Description copied from interface: IMAPCallback
    
    Notification that a given messages has been permanently deleted.
    
    Specified by:
    
    expunge in interface IMAPCallback
    
    Parameters:
    message - the message number
  - fetch
```
public void fetch(int message,
 java.util.List<FetchDataItem> data)
```
    Description copied from interface: IMAPCallback
    
    Notification of data specific to a message
    
    Specified by:
    
    fetch in interface IMAPCallback
    
    Parameters:
    message - the message number
    data - the message data
  - flags
```
public void flags(java.util.List<java.lang.String> flags)
```
    Description copied from interface: IMAPCallback
    
    Notification of the flags applicable for the associated mailbox.
    
    Specified by:
    
    flags in interface IMAPCallback
  - permanentflags
```
public void permanentflags(java.util.List<java.lang.String> flags)
```
    Description copied from interface: IMAPCallback
    
    Notification of the permanent flags applicable for the associated mailbox. These are flags that the user can change permanently. If not present, all flags can be changed permanently.
    
    Specified by:
    
    permanentflags in interface IMAPCallback
  - firstUnseen
```
public void firstUnseen(int message)
```
    Description copied from interface: IMAPCallback
    
    The message sequence number of the first unseen message in the mailbox. If not present, a SEARCH command must be issued to discover this value.
    
    Specified by:
    
    firstUnseen in interface IMAPCallback
  - unseen
```
public void unseen(int messages)
```
    Description copied from interface: IMAPCallback
    
    The number of messages which do not have the \Seen flag set.
    
    Specified by:
    
    unseen in interface IMAPCallback
  - uidvalidity
```
public void uidvalidity(long uidvalidity)
```
    Description copied from interface: IMAPCallback
    
    The unique identifier validity value. If not present, the server does not support UIDs.
    
    Specified by:
    
    uidvalidity in interface IMAPCallback
  - uidnext
```
public void uidnext(long uid)
```
    Description copied from interface: IMAPCallback
    
    The next unique identifier value.
    
    Specified by:
    
    uidnext in interface IMAPCallback
  - readWrite
```
public void readWrite()
```
    Description copied from interface: IMAPCallback
    
    Indicates that the mailbox was opened read-write.
    
    Specified by:
    
    readWrite in interface IMAPCallback
  - readOnly
```
public void readOnly()
```
    Description copied from interface: IMAPCallback
    
    Indicates that the mailbox was opened read-only.
    
    Specified by:
    
    readOnly in interface IMAPCallback
  - tryCreate
```
public void tryCreate()
```
    Description copied from interface: IMAPCallback
    
    Indicates that the mailbox does not exist yet but could be created.
    
    Specified by:
    
    tryCreate in interface IMAPCallback
  - list
```
public void list(java.util.List<java.lang.String> attributes,
 java.lang.String delimiter,
 java.lang.String mailbox)
```
    Description copied from interface: IMAPCallback
    
    Notification of a list entry.
    
    Specified by:
    
    list in interface IMAPCallback
    
    Parameters:
    attributes - the mailbox attributes
    delimiter - the mailbox hierarchy delimiter
    mailbox - the mailbox name
  - search
```
public void search(java.util.List<java.lang.Integer> results)
```
    Description copied from interface: IMAPCallback
    
    Notification of a search result.
    
    Specified by:
    
    search in interface IMAPCallback
    
    Parameters:
    results - the search results. For an ordinary search these are message sequence numbers; for a UID search they are UIDs.
  - namespace
```
public void namespace(Namespace personal,
 Namespace otherUsers,
 Namespace shared)
```
    Description copied from interface: IMAPCallback
    
    Notification of a namespace result.
    
    Specified by:
    
    namespace in interface IMAPCallback
    
    Parameters:
    personal - the server's Personal namespace
    otherUsers - the Other Users' namespace
    shared - the Shared namespace
  - quota
```
public void quota(java.lang.String quotaRoot,
 java.util.Map<java.lang.String,java.lang.Integer> currentUsage,
 java.util.Map<java.lang.String,java.lang.Integer> limit)
```
    Description copied from interface: IMAPCallback
    
    Notification of a quota.
    
    Specified by:
    
    quota in interface IMAPCallback
    
    Parameters:
    quotaRoot - the quota root
    currentUsage - current usage by resource
    limit - limits of each resource
    See Also:
    2087
  - quotaroot
```
public void quotaroot(java.lang.String mailbox,
 java.util.List<java.lang.String> quotaRoots)
```
    Description copied from interface: IMAPCallback
    
    Notification of the quota roots for a mailbox.
    
    Specified by:
    
    quotaroot in interface IMAPCallback
    
    Parameters:
    mailbox - the mailbox
    quotaRoots - the quota roots for the mailbox
    See Also:
    2087
  - acl
```
public void acl(java.lang.String mailbox,
 java.util.Map<java.lang.String,java.lang.String> rights)
```
    Description copied from interface: IMAPCallback
    
    Notification of access control rights. This occurs in response to a GETACL command.
    
    Specified by:
    
    acl in interface IMAPCallback
    
    Parameters:
    mailbox - the mailbox name
    rights - the identifier-rights pairs
    See Also:
    4314
  - listrights
```
public void listrights(java.lang.String mailbox,
 java.lang.String identifier,
 java.lang.String required,
 java.util.List<java.lang.String> optional)
```
    Description copied from interface: IMAPCallback
    
    Notification of a list of rights. This occurs in response to a LISTRIGHTS command.
    
    Specified by:
    
    listrights in interface IMAPCallback
    
    Parameters:
    mailbox - the mailbox name
    identifier - the identifier
    required - the required rights for this identifier
    See Also:
    4314
  - myrights
```
public void myrights(java.lang.String mailbox,
 java.lang.String rights)
```
    Description copied from interface: IMAPCallback
    
    Notification of the user's rights with respect to the mailbox. This occurs in response to a MYRIGHTS command.
    
    Specified by:
    
    myrights in interface IMAPCallback
    
    Parameters:
    mailbox - the mailbox name
    rights - the rights for the current user
    See Also:
    4314
  - appenduid
```
public void appenduid(long uidvalidity,
 long uid)
```
    Description copied from interface: IMAPCallback
    
    Indicates that the message has been appended to the destination mailbox.
    
    Specified by:
    
    appenduid in interface IMAPCallback
    
    Parameters:
    uidvalidity - uidvalidity of the destination mailbox
    uid - uid of the appended message in the destination mailbox
    See Also:
    2359
  - copyuid
```
public void copyuid(long uidvalidity,
 UIDSet source,
 UIDSet destination)
```
    Description copied from interface: IMAPCallback
    
    Indicates that the message(s) have been copied to the destination mailbox with the stated UID(s).
    
    Specified by:
    
    copyuid in interface IMAPCallback
    
    Parameters:
    uidvalidity - uidvalidity of the destination mailbox
    source - UID(s) of the message(s) in the source mailbox
    destination - UID(s) of the message(s) in the destination mailbox
    See Also:
    2359
  - uidnotsticky
```
public void uidnotsticky()
```
    Description copied from interface: IMAPCallback
    
    Indicates that the server does not support persistent UIDs, and APPEND and COPY will not return APPENDUID or COPYUID responses.
    
    Specified by:
    
    uidnotsticky in interface IMAPCallback
    
    See Also:
    2359

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class IMAPAdapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IMAPAdapter

IMAPAdapter

Method Detail

alert

capability

exists

recent

expunge

fetch

flags

permanentflags

firstUnseen

unseen

uidvalidity

uidnext

readWrite

readOnly

tryCreate

list

search

namespace

quota

quotaroot

acl

listrights

myrights

appenduid

copyuid

uidnotsticky