Methods summary
public
boolean
|
#
poll( )
AJAX action: Poll mailboxes.
AJAX action: Poll mailboxes.
See the list of variables needed for IMP_Ajax_Application#changed() and
IMP_Ajax_Application#viewPortData().
Returns
boolean
True.
|
public
boolean
|
#
viewPort( )
AJAX action: Output ViewPort data.
AJAX action: Output ViewPort data.
See the list of variables needed for IMP_Ajax_Appication#changed() and
IMP_Ajax_Application#viewPortData().
Additional variables used (contained in 'viewport' parameter): - checkcache: (integer) If 1, only send data if cache has been invalidated. - rangeslice: (string) Range slice. See js/viewport.js. - sortby: (integer) The Horde_Imap_Client sort constant. - sortdir: (integer) 0 for ascending, 1 for descending.
Returns
boolean
True on success, false on failure.
|
public
boolean
|
#
moveMessages( )
AJAX action: Move messages.
AJAX action: Move 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: - mboxto: (string) Mailbox to move the message to (base64url encoded).
Returns
boolean
True on success, false on failure.
|
public
boolean
|
#
copyMessages( )
AJAX action: Copy messages.
AJAX action: Copy messages.
See the list of variables needed for
IMP_Ajax_Application#_checkUidvalidity(). Mailbox/indices form
parameters needed. Additional variables used: - mboxto: (string) Mailbox to copy the message to (base64url encoded).
Returns
boolean
True on success, false on failure.
|
public
boolean
|
#
deleteMessages( )
AJAX action: Delete messages.
AJAX action: Delete 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.
Returns
boolean
True on success, false on failure.
|
public
boolean
|
#
reportSpam( )
AJAX action: Report message as [not]spam.
AJAX action: Report message as [not]spam.
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: - spam: (integer) 1 to mark as spam, 0 to mark as innocent.
Returns
boolean
True on success.
|
public
mixed
|
#
getReplyData( )
AJAX action: Get reply data.
AJAX action: Get reply data.
See the list of variables needed for
IMP_Ajax_Application#checkUidvalidity(). Mailbox/indices form
parameters needed. Additional variables used: - headeronly: (boolean) Only return header information (DEFAULT: false). - format: (string) The format to force to ('text' or 'html') (DEFAULT: Auto-determined). - imp_compose: (string) The IMP_Compose cache identifier. - type: (string) See IMP_Compose::replyMessage().
Returns
mixedFalse on failure, or an object with the following
entries:
- addr: (array) List of addresses (to, cc, bcc).
- body: (string) The body text of the message.
- format: (string) Either 'text' or 'html'.
- identity: (integer) The identity ID to use for this message.
- opts: (array) Additional options needed for DimpCompose.fillForm().
- subject: (string) Subject value.
- type: (string) The input 'type' value.
|
public
mixed
|
#
getForwardData( )
Get forward compose data.
Get forward compose data.
See the list of variables needed for checkUidvalidity().
Mailbox/indices form parameters needed. Additional variables used: - dataonly: (boolean) Only return data information (DEFAULT: false). - format: (string) The format to force to ('text' or 'html') (DEFAULT: Auto-determined). - imp_compose: (string) The IMP_Compose cache identifier. - type: (string) Forward type.
Returns
mixedFalse on failure, or an object with the following
entries:
- body: (string) The body text of the message.
- format: (string) Either 'text' or 'html'.
- header: (array) The headers of the message.
- identity: (integer) The identity ID to use for this message.
- opts: (array) Additional options needed for DimpCompose.fillForm().
- type: (string) The input 'type' value.
|
public
mixed
|
#
getRedirectData( )
AJAX action: Get compose redirect data.
AJAX action: Get compose redirect data.
Mailbox/indices form parameters needed.
Returns
mixedFalse on failure, or an object with the following
entries:
- imp_compose: (string) The IMP_Compose cache identifier.
- type: (string) The input 'type' value.
|
public
mixed
|
#
getResumeData( )
AJAX action: Get resume data.
AJAX action: Get resume data.
See the list of variables needed for
IMP_Ajax_Application#checkUidvalidity(). Mailbox/indices form
parameters needed. Additional variables used: - format: (string) The format to force to ('text' or 'html') (DEFAULT: Auto-determined). - imp_compose: (string) The IMP_Compose cache identifier. - type: (string) Resume type: one of 'editasnew', 'resume', 'template', 'template_edit'.
Returns
mixedFalse on failure, or an object with the following
entries:
- addr: (array) List of addresses (to, cc, bcc).
- body: (string) The body text of the message.
- format: (string) Either 'text' or 'html'.
- identity: (integer) The identity ID to use for this message.
- opts: (array) Additional options (atc, priority, readreceipt).
- subject: (string) Subject value.
- type: (string) The input 'type' value.
|
public
boolean
|
#
cancelCompose( )
AJAX action: Cancel compose.
AJAX action: Cancel compose.
Variables used: - discard: (boolean) If true, discard draft. - imp_compose: (string) The IMP_Compose cache identifier.
Returns
boolean
True.
|
public
object
|
#
sendMessage( )
AJAX action: Send a message.
AJAX action: Send a message.
See the list of variables needed for
IMP_Ajax_Application#composeSetup(). Additional variables used: - encrypt: (integer) The encryption method to use (IMP ENCRYPT constants). - html: (integer) In HTML compose mode? - message: (string) The message text. - pgp_attach_pubkey: (boolean) True if PGP public key should be attached to the message. - priority: (string) The priority of the message. - request_read_receipt: (boolean) Add request read receipt header? - save_attachments_select: (boolean) Whether to save attachments. - save_sent_mail: (boolean) True if saving sent mail. - save_sent_mail_mbox: (string) base64url encoded version of sent mail mailbox to use. - vcard_attach: (boolean) Attach user's vCard to the message?
Returns
objectAn object with the following entries:
- action: (string) The AJAX action string
- draft_delete: (integer) If set, remove auto-saved drafts.
- encryptjs: (array) Javascript to run after encryption failure.
- flag: (array) See IMP_Ajax_Queue::add().
- identity: (integer) If set, this is the identity that is tied to
the current recipient address.
- success: (integer) 1 on success, 0 on failure.
|
public
object
|
#
redirectMessage( )
Redirect the message.
Variables used: See the list of variables needed for
IMP_Ajax_Application#composeSetup().
Returns
objectAn object with the following entries:
- action: (string) 'redirectMessage'.
- success: (integer) 1 on success, 0 on failure.
|
public
object
|
#
showMessage( )
Generate data necessary to display a message.
Generate data necessary to display a message.
See the list of variables needed for changed() and
checkUidvalidity(). Mailbox/indices form parameters needed. Additional
variables used: - peek: (integer) If set, don't set seen flag. - preview: (integer) If set, return preview data. Otherwise, return full data.
Returns
objectObject with the following entries:
- buid: (integer) The message BUID.
- error: (string) On error, the error string.
- errortype: (string) On error, the error type.
- view: (string) The view ID.
|
IMP_Ajax_Application_Handler_Common