Methods summary
public
object
|
#
createMailboxPrepare( )
AJAX action: Check access rights for creation of a submailbox.
AJAX action: Check access rights for creation of a submailbox.
Variables used: - mbox: (string) The name of the mailbox to check (base64url encoded).
Returns
objectObject with the following properties:
- result: (boolean) True if submailboxes can be created.
|
public
boolean
|
#
createMailbox( )
AJAX action: Create a mailbox.
AJAX action: Create a mailbox.
Variables used: - create_poll: (boolean) If true, add new mailbox to poll list. - mbox: (string) The name of the new mailbox. - parent: (string) The parent mailbox (base64url encoded).
Returns
boolean
True on success, false on failure.
|
public
object
|
#
deleteMailboxPrepare( )
AJAX action: Check access rights for deletion/rename of mailbox.
AJAX action: Check access rights for deletion/rename of mailbox.
Variables used: - mbox: (string) The name of the mailbox to check (base64url encoded). - type: (string) Either 'delete' or 'rename'.
Returns
objectObject with the following properties:
- result: (boolean) True if mailbox can be deleted/renamed.
|
public
boolean
|
#
deleteMailbox( )
AJAX action: Delete a mailbox.
AJAX action: Delete a mailbox.
Variables used: - container: (boolean) True if base element is a container. - mbox: (string) The full mailbox name to delete (base64url encoded). - subfolders: (boolean) Delete all subfolders?
Returns
boolean
True on success, false on failure.
|
public
boolean
|
#
renameMailbox( )
AJAX action: Rename a mailbox.
AJAX action: Rename a mailbox.
Variables used: - new_name: (string) New mailbox name (child node) (UTF-8). - new_parent: (string) New parent name (UTF-8; base64url encoded). If not present, uses old parent. - old_name: (string) Full name of old mailbox (base64url encoded).
Returns
boolean
True on success, false on failure.
|
public
object
|
#
emptyMailboxPrepare( )
AJAX action: Check access rights for a mailbox, and provide number of
messages to be emptied.
AJAX action: Check access rights for a mailbox, and provide number of
messages to be emptied.
Variables used: - mbox: (string) The name of the mailbox to check (base64url encoded).
Returns
objectObject with the following properties:
- result: (integer) The number of messages to be deleted.
|
public
boolean
|
#
emptyMailbox( )
AJAX action: Empty a mailbox.
AJAX action: Empty a mailbox.
Variables used: - mbox: (string) The full mailbox name to empty (base64url encoded).
Returns
boolean
True on success, false on failure.
|
public
boolean
|
#
flagAll( )
AJAX action: Flag all messages in a mailbox.
AJAX action: Flag all messages in a mailbox.
Variables used: - add: (integer) Add the flags? - flags: (string) The IMAP flags to add/remove (JSON serialized array). - mbox: (string) The full mailbox name (base64url encoded).
Returns
boolean
True on success, false on failure.
|
public
boolean
|
#
listMailboxes( )
AJAX action: List mailboxes.
AJAX action: List mailboxes.
Variables used: - all: (integer) 1 to show all mailboxes. - base: (string) The base mailbox. - expall: (boolean) 1 to expand all (requires 'all'). - initial: (string) 1 to indicate the initial request for mailbox list. - mboxes: (string) The list of mailboxes to process (JSON encoded array; mailboxes are base64url encoded). - reload: (integer) 1 to force reload of mailboxes. - unsub: (integer) 1 to show unsubscribed mailboxes.
Returns
boolean
True.
|
public
boolean
|
#
dynamicInit( )
AJAX action: Initialize dynamic view.
AJAX action: Initialize dynamic view.
Returns
boolean
True.
See
|
public
mixed
|
#
modifyPoll( )
AJAX action: Modify list of polled mailboxes.
AJAX action: Modify list of polled mailboxes.
Variables used: - add: (integer) 1 to add to the poll list, 0 to remove. - mbox: (string) The full mailbox name to modify (base64url encoded).
Returns
mixedFalse on failure, or an object with the following
entries:
- add: (integer) 1 if added to the poll list, 0 if removed.
- mbox: (string) The full mailbox name modified.
|
public
boolean
|
#
subscribe( )
AJAX action: [un]Subscribe to a mailbox.
AJAX action: [un]Subscribe to a mailbox.
Variables used: - mbox: (string) The full mailbox name to [un]subscribe to (base64url encoded). - sub: (integer) 1 to subscribe, empty to unsubscribe. - subfolders: (boolean) [Un]subscribe to all subfolders?
Returns
boolean
True on success, false on failure.
|
public
object
|
#
importMailbox( )
AJAX action: Import a mailbox.
AJAX action: Import a mailbox.
Variables used: - import_mbox: (string) The mailbox to import into (base64url encoded).
Returns
objectReturns response object to display JSON HTML-encoded:
- action: (string) The action name (importMailbox).
- mbox: (string) The mailbox the messages were imported to (base64url
encoded).
|
public
boolean
|
#
flagMessages( )
AJAX action: Flag messages.
AJAX action: Flag messages.
See the list of variables needed for IMP_Ajax_Application#changed() and
IMP_Ajax_Application#checkUidvalidity(). Mailbox/indices form
parameters needed. Additional variables used: - add: (integer) Set the flag? - flags: (string) The flags to set (JSON serialized array).
Returns
boolean
True on success, false on failure.
|
public
boolean
|
#
addContact( )
AJAX action: Add contact.
AJAX action: Add contact.
Variables used: - addr: (string) [JSON array] Address list.
Returns
boolean
True on success, false on failure.
|
public
boolean
|
#
blacklist( )
AJAX action: Blacklist/whitelist addresses from messages.
AJAX action: Blacklist/whitelist addresses from messages.
See the list of variables needed for IMP_Ajax_Application#changed(),
IMP_Ajax_Application#deleteMsgs(), and
IMP_Ajax_Application#checkUidvalidity(). Mailbox/indices form
parameters needed. Additional variables used: - blacklist: (integer) 1 to blacklist, 0 to whitelist.
Returns
boolean
True on success.
|
public
mixed
|
#
messageMimeTree( )
AJAX action: Return the MIME tree representation of the message.
AJAX action: Return the MIME tree representation of the message.
See the list of variables needed for IMP_Ajax_Application#changed() and
IMP_Ajax_Application#checkUidvalidity(). Mailbox/indices form
parameters needed. Additional variables used: - preview: (integer) If set, return preview data. Otherwise, return full data.
Returns
mixedOn error will return null.
Otherwise an object with the following entries:
- tree: (string) The MIME tree representation of the message.
If viewing preview, on error this object will contain error
and errortype properties.
|
public
array
|
#
deleteAttach( )
AJAX action: Delete an attachment from compose data.
AJAX action: Delete an attachment from compose data.
Variables used: - atc_indices: (string) [JSON array] Attachment IDs to delete. - imp_compose: (string) The IMP_Compose cache identifier. - quiet: (boolean) If true, don't output notifications.
Returns
array
The list of attchment IDs that were deleted.
|
public
boolean
|
#
purgeDeleted( )
AJAX action: Purge deleted messages.
AJAX action: Purge deleted messages.
See the list of variables needed for IMP_Ajax_Application#changed() and
IMP_Ajax_Application#deleteMsgs().
Returns
boolean
True on success.
|
public
mixed
|
#
sendMDN( )
AJAX action: Send a Message Disposition Notification (MDN).
AJAX action: Send a Message Disposition Notification (MDN).
Mailbox/indices form parameters needed.
Returns
mixedFalse on failure, or an object with these properties:
- buid: (integer) BUID of message.
- mbox: (string) Mailbox of message (base64url encoded).
|
public
mixed
|
#
stripAttachment( )
AJAX action: strip attachment.
AJAX action: strip attachment.
See the list of variables needed for IMP_Ajax_Application#changed() and
IMP_Ajax_Application#checkUidvalidity(). Mailbox/indices form
parameters needed.
Returns
mixedFalse on failure, or an object with these properties:
- newbuid: (integer) BUID of new message.
- newmbox: (string) Mailbox of new message (base64url encoded).
|
public
object
|
#
html2Text( )
AJAX action: Convert HTML to text (compose data).
AJAX action: Convert HTML to text (compose data).
Variables used: - data: (string) [JSON array] List of data to convert. Keys are UIDs used to idetify the return values. Values are arrays with these keys: - changed: (integer) Has the text changed from the original? - text: (string) The text to convert. - imp_compose: (string) The IMP_Compose cache identifier.
Returns
objectAn object with the following entries:
- text: (array) Array with keys as UIDs and values as the converted
text string.
|
public
object
|
#
text2Html( )
AJAX action: Convert text to HTML (compose data).
AJAX action: Convert text to HTML (compose data).
Variables used: - data: (string) [JSON array] List of data to convert. Keys are UIDs used to idetify the return values. Values are arrays with these keys: - changed: (integer) Has the text changed from the original? - text: (string) The text to convert. - imp_compose: (string) The IMP_Compose cache identifier.
Returns
objectAn object with the following entries:
- text: (array) Array with keys as UIDs and values as the converted
text string.
|
public
Horde_Core_Ajax_Response_Raw
|
#
addAttachmentCkeditor( )
AJAX action: Add an attachment to a compose message (from the ckeditor
plugin).
AJAX action: Add an attachment to a compose message (from the ckeditor
plugin).
Variables used: - CKEditorFuncNum: (integer) CKEditor function identifier to call when returning URL data - composeCache: (string) The IMP_Compose cache identifier.
Returns
Horde_Core_Ajax_Response_Rawtext/html return containing
javascript code to update the
URL parameter in CKEditor.
|
public
object
|
#
isFixedMbox( )
AJAX action: Is the given mailbox fixed? Called dynamically to delay
retrieval of ACLs of all visible mailboxes at initialization.
AJAX action: Is the given mailbox fixed? Called dynamically to delay
retrieval of ACLs of all visible mailboxes at initialization.
Variables used: - mbox: (integer) The mailbox name.
Returns
objectAn object with the following entires:
- fixed: (boolean) True if the mailbox is fixed.
|
public
object
|
#
createFlag( )
AJAX action: Create an IMAP flag.
AJAX action: Create an IMAP flag.
Variables used: - flagcolor: (string) Background color for flag label. - flagname: (string) Flag name.
Returns
objectAn object with the following properties:
- success: (boolean) True if successful.
|
public
object
|
#
sentMailList( )
AJAX action: Generate the sent-mail select list.
AJAX action: Generate the sent-mail select list.
Variables used: NONE
Returns
objectAn object with the following properties:
- flist: (array) TODO
|
public
Horde_Core_Ajax_Response_HordeCore_Reload
|
#
newFilter( )
AJAX action: Redirect to the filter edit page and pre-populate with
an e-mail address.
AJAX action: Redirect to the filter edit page and pre-populate with
an e-mail address.
Requires EITHER 'addr' -or- mailbox/indices from form params.
Variables used: - addr: (string) The e-mail address to use.
Returns
Horde_Core_Ajax_Response_HordeCore_ReloadObject with URL to
redirect to.
|
public
object
|
#
getContactsImage( )
AJAX action: Return the contacts images for a given e-mail address.
AJAX action: Return the contacts images for a given e-mail address.
Variables used: - addr: (string) The e-mail address.
Returns
objectAn object with the following properties:
- avatar: (string) The URL of the avatar image.
- flag: (string) The URL of the sender's country flag image.
- flagname: (string) The name of the country of the sender.
|
public
object
|
#
mailboxSize( )
AJAX action: Determine the size of a mailbox.
AJAX action: Determine the size of a mailbox.
Variables used: - mbox: (string) The name of the mailbox to check (base64url encoded).
Returns
objectAn object with the following properties:
- size: (string) Formatted size string.
|
public
object
|
#
autocompleteSearch( )
AJAX Action: Do an autocomplete search.
AJAX Action: Do an autocomplete search.
Variables used: - search: (string) Search string. - type: (string) Autocomplete search type.
Returns
objectAn object with a single property: 'results'.
The format of 'results' depends on the search type.
- type = 'email'
Results is an array with the following keys for each result:
- g: (array) List of addresses in the group (in same 'results'
format as type = 'email').
- l: (string) Full label.
- s: (string) Short display string.
- v: (string) Value.
|
IMP_Ajax_Application_Handler_Dynamic