Class IMP_Ajax_Application
Defines the AJAX interface for IMP.
Global tasks: - msgload: (string) BUID of a message to load in the background (mailbox is located in 'mailbox' parameter). - poll: (string) The list of mailboxes to process (JSON encoded array; mailboxes are base64url encoded). If an empty array, polls all mailboxes.
Global parameters (in viewport parameter): - force: (integer) If set, always return viewport information if changed.
-
Horde_Core_Ajax_Application
-
IMP_Ajax_Application
Methods summary
public
|
|
public
array
|
#
getTasks( )
Get the list of tasks.
Returns
array
Task list.
|
public
object
|
#
initCompose( )
Initialize the objects needed to compose.
Initialize the objects needed to compose.
Returns
objectObject with the following properties:
- ajax: IMP_Ajax_Application_Compose object
- compose: IMP_Compose object
- contents: IMP_Contents object
|
public
|
#
checkUidvalidity( )
Check the UID validity of the mailbox.
Check the UID validity of the mailbox.
See the list of variables needed for viewPortData().
|
public
IMP_Ajax_Application_Viewport
|
#
viewPortData( boolean $change )
Generate the information necessary for a ViewPort request from/to the
browser.
Generate the information necessary for a ViewPort request from/to the
browser.
Variables used (contained in 'viewport' object): - applyfilter - cache - cacheid - delhide - initial - qsearch - qsearchfield - qsearchfilter - qsearchflag - qsearchflagnot - qsearchmbox - rangeslice - sortby - sortdir
Parameters
- $change
- True if cache information has changed.
Returns
|
public
boolean
|
#
changed( boolean $rw = null )
Determine if the cache information has changed.
Determine if the cache information has changed.
Variables used: - cacheid: (string) The browser (ViewPort) cache identifier. - forceUpdate: (integer) If 1, forces an update.
Parameters
- $rw
- Open mailbox as READ+WRITE?
Returns
booleanTrue if the server state differs from the browser
state.
|
public
array
|
#
composeSetup( string $action )
Setup environment for compose actions.
Setup environment for compose actions.
Variables used: - bcc: (string) Bcc address to use. - bcc_ac: (string) Bcc address to use (autocompleter JSON data). - cc: (string) Cc address to use. - cc_ac: (string) Cc address to use (autocompleter JSON data). - composeCache: (string) The IMP_Compose cache identifier. - from: (string) From address to use. - from_ac: (string) From address to use (autocompleter JSON data). - identity: (integer) The identity to use - redirect_to: (string) To address to use (for redirect). - redirect_to_ac: (string) To address to use (for redirect) (autocompleter JSON data). - to: (string) To address to use. - to_ac: (string) To address to use (autocompleter JSON data).
Parameters
Returns
arrayAn array with the following values:
- (object) AJAX base return object (with action and success
parameters defined).
- (IMP_Compose) The IMP_Compose object for the message.
- (array) The list of headers for the object.
- (Horde_Prefs_Identity) The identity used for the composition.
Throws
Horde_Exception
|
public
array
|
#
getAddrFields( )
Return address field data from the browser form.
Return address field data from the browser form.
Returns
arrayKeys are header names, values are arrays with two keys:
- addr: (array) List of addresses.
- map: (boolean) If true, addr keys are autocomplete IDs.
|
public
|
#
deleteMsgs( IMP_Indices $indices, boolean $changed, boolean $force = false )
Processes delete message requests.
See the list of variables needed for viewPortData().
Processes delete message requests.
See the list of variables needed for viewPortData().
Parameters
- $indices
- An indices object.
- $changed
- If true, add full ViewPort information.
- $force
- <p>If true, forces addition of disappear
information.</p>
|