Class IMP_Ajax_Queue
Defines an AJAX variable queue for IMP. These are variables that may be
generated by various IMP code that should be added to the eventual output
to the browser.
Copyright 2011-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (GPL). If you
did not receive this file, see http://www.horde.org/licenses/gpl.
Methods summary
public
array
|
#
generate( )
Generates variable data from the queue.
Generates variable data from the queue.
Returns
arrayQueue data.
For flag data (key: 'flag'), an array of objects with these properties:
- add: (array) The list of flags that were added.
- remove: (array) The list of flags that were removed.
- uids: (string) Indices of the messages that have changed (IMAP
sequence string; mboxes are base64url encoded).
For poll data (key: 'poll'), an array with keys as base64url encoded
mailbox names, values as the number of unseen messages.
For quota data (key: 'quota'), an array with these keys:
- m: (string) Quota message.
- p: (integer) Quota percentage.
|
public
|
#
flag( array $flags, boolean $add, IMP_Indices $indices )
Add flag entry to response queue.
Add flag entry to response queue.
Parameters
- $flags
- List of flags that have changed.
- $add
- Were the flags added?
- $indices
- Indices object.
|
public
|
#
poll( mixed $mboxes )
Add poll entry to response queue.
Add poll entry to response queue.
Parameters
- $mboxes
- A mailbox name or list of mailbox names.
|
public
|
#
quota( )
Add quota entry to response queue.
Add quota entry to response queue.
|