All Known Implementing Classes:

IMAPAdapter

public interface IMAPCallback

Since:

1.2

• 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.

• Method Detail

  • alert

    void alert(java.lang.String message)

    Notification of a user alert. This should be displayed to the user somehow.

    Parameters:

    message - the message text

  • capability

    void capability(java.util.List<java.lang.String> capabilities)

    Notification of capabilities change.

    Parameters:

    capabilities - the new capabilities

  • exists

    void exists(int messages)

    Notification of the number of messages in a mailbox.

    Parameters:

    messages - the number of messages

  • recent

    void recent(int messages)

    Notification of the number of messages with the recent flag set.

    Parameters:

    messages - the number of messages

  • expunge

    void expunge(int message)

    Notification that a given messages has been permanently deleted.

    Parameters:

    message - the message number

  • fetch

    void fetch(int message,
     java.util.List<FetchDataItem> data)

    Notification of data specific to a message

    Parameters:

    message - the message number

    data - the message data

  • flags

    void flags(java.util.List<java.lang.String> flags)

    Notification of the flags applicable for the associated mailbox.

  • permanentflags

    void permanentflags(java.util.List<java.lang.String> flags)

    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.

  • firstUnseen

    void firstUnseen(int message)

    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.

  • unseen

    void unseen(int messages)

    The number of messages which do not have the \Seen flag set.

  • uidvalidity

    void uidvalidity(long uidvalidity)

    The unique identifier validity value. If not present, the server does not support UIDs.

  • uidnext

    void uidnext(long uid)

    The next unique identifier value.

  • readWrite

    void readWrite()

    Indicates that the mailbox was opened read-write.

  • readOnly

    void readOnly()

    Indicates that the mailbox was opened read-only.

  • tryCreate

    void tryCreate()

    Indicates that the mailbox does not exist yet but could be created.

  • list

    void list(java.util.List<java.lang.String> attributes,
     java.lang.String delimiter,
     java.lang.String mailbox)

    Notification of a list entry.

    Parameters:

    attributes - the mailbox attributes

    delimiter - the mailbox hierarchy delimiter

    mailbox - the mailbox name

  • search

    void search(java.util.List<java.lang.Integer> results)

    Notification of a search result.

    Parameters:

    results - the search results. For an ordinary search these are message sequence numbers; for a UID search they are UIDs.

  • namespace

    void namespace(Namespace personal,
     Namespace otherUsers,
     Namespace shared)

    Notification of a namespace result.

    Parameters:

    personal - the server's Personal namespace

    otherUsers - the Other Users' namespace

    shared - the Shared namespace

  • quota

    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.

    Parameters:

    quotaRoot - the quota root

    currentUsage - current usage by resource

    limit - limits of each resource

    See Also:

    2087

  • quotaroot

    void quotaroot(java.lang.String mailbox,
     java.util.List<java.lang.String> quotaRoots)

    Notification of the quota roots for a mailbox.

    Parameters:

    mailbox - the mailbox

    quotaRoots - the quota roots for the mailbox

    See Also:

    2087

  • acl

    void acl(java.lang.String mailbox,
     java.util.Map<java.lang.String,java.lang.String> rights)

    Notification of access control rights. This occurs in response to a GETACL command.

    Parameters:

    mailbox - the mailbox name

    rights - the identifier-rights pairs

    See Also:

    4314

  • listrights

    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. This occurs in response to a LISTRIGHTS command.

    Parameters:

    mailbox - the mailbox name

    identifier - the identifier

    required - the required rights for this identifier

    rights - the list of optional rights for this identifier

    See Also:

    4314

  • myrights

    void myrights(java.lang.String mailbox,
     java.lang.String rights)

    Notification of the user's rights with respect to the mailbox. This occurs in response to a MYRIGHTS command.

    Parameters:

    mailbox - the mailbox name

    rights - the rights for the current user

    See Also:

    4314

  • appenduid

    void appenduid(long uidvalidity,
     long uid)

    Indicates that the message has been appended to the destination mailbox.

    Parameters:

    uidvalidity - uidvalidity of the destination mailbox

    uid - uid of the appended message in the destination mailbox

    See Also:

    2359

  • copyuid

    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).

    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

    void uidnotsticky()

    Indicates that the server does not support persistent UIDs, and APPEND and COPY will not return APPENDUID or COPYUID responses.

    See Also:

    2359