| [ Index ] |
|
Code source de IMP H3 (4.1.5) |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Poids: | 703 lignes (28 kb) |
| Inclus ou requis: | 20 fois |
| Référencé: | 0 fois |
| Nécessite: | 6 fichiers lib/Maillog.php lib/MIME/Headers.php lib/IMAP.php lib/MIME/Contents.php lib/Folder.php lib/Compose.php |
IMP_Message:: (11 méthodes):
singleton()
IMP_Message()
copy()
delete()
undelete()
createTasksOrNotes()
stripPart()
flag()
flagAllInMailbox()
expungeMailbox()
emptyMailbox()
Classe: IMP_Message - X-Ref
The IMP_Message:: class contains all functions related to handling messages| singleton() X-Ref |
| Returns a reference to the global IMP_Message object, only creating it if it doesn't already exist. This ensures that only one IMP_Message instance is instantiated for any given session. This method must be invoked as:<code> $imp_message = &IMP_Message::singleton(); </code> return: IMP_Message The IMP_Message instance. |
| IMP_Message() X-Ref |
| Constructor. |
| copy($targetMbox, $action, &$indices) X-Ref |
| Copies or moves a list of messages to a new folder. Handles use of the IMP_SEARCH_MBOX mailbox and the Trash folder. param: string $targetMbox The mailbox to move/copy messages to. param: integer $action Either IMP_MESSAGE_MOVE or IMP_MESSAGE_COPY. param: mixed &$indices See above. return: boolean True if successful, false if not. |
| delete(&$indices, $nuke = false, $keeplog = false) X-Ref |
| Deletes a list of messages taking into account whether or not a Trash folder is being used. Handles use of the IMP_SEARCH_MBOX mailbox and the Trash folder. param: mixed &$indices See above. param: boolean $nuke Override user preferences and nuke (i.e. param: boolean $keeplog Should any history information of the return: boolean True if successful, false if not. |
| undelete(&$indices) X-Ref |
| Undeletes a list of messages. Handles the IMP_SEARCH_MBOX mailbox. This function works with IMAP only, not POP3. param: mixed &$indices See above. return: boolean True if successful, false if not. |
| createTasksOrNotes($list, $action, &$indices, $type = 'task') X-Ref |
| Copies or moves a list of messages to a tasklist or notepad. Handles use of the IMP_SEARCH_MBOX mailbox and the Trash folder. param: string $list The list in which the task or note will be param: integer $action Either IMP_MESSAGE_MOVE or IMP_MESSAGE_COPY. param: mixed $indices See above. param: string $type The object type to create, defaults to task. return: boolean True if successful, false if not. |
| stripPart(&$imp_mailbox, $partid) X-Ref |
| Strips a MIME Part out of a message. Handles the IMP_SEARCH_MBOX mailbox. param: IMP_Mailbox &$imp_mailbox The IMP_Mailbox object with the param: string $partid The MIME ID of the part to strip. return: boolean Returns true on success, or PEAR_Error on error. |
| flag($flag, &$indices, $action = true) X-Ref |
| Sets or clears a given flag for a list of messages. Handles use of the IMP_SEARCH_MBOX mailbox. This function works with IMAP only, not POP3. Valid flags are: \\SEEN \\FLAGGED \\ANSWERED \\DELETED \\DRAFT param: string $flag The IMAP flag(s) to set or clear. param: mixed &$indices See above. param: boolean $action If true, set the flag(s), otherwise clear the return: boolean True if successful, false if not. |
| flagAllInMailbox($flag, $mboxes, $action = true) X-Ref |
| Sets or clears a given flag(s) for all messages in a list of mailboxes. This function works with IMAP only, not POP3. See flag() for the list of valid flags. param: string $flag The IMAP flag(s) to set or clear. param: array $mboxes The list of mailboxes to flag. param: boolean $action If true, set the flag(s), otherwise, clear the return: boolean True if successful, false if not. |
| expungeMailbox($mbox_list) X-Ref |
| Expunges all deleted messages from the list of mailboxes. param: array $mbox_list The list of mailboxes to empty. |
| emptyMailbox($mbox_list) X-Ref |
| Empties an entire mailbox. param: array $mbox_list The list of mailboxes to empty. |
| Généré le : Thu Nov 29 12:30:07 2007 | par Balluche grâce à PHPXref 0.7 |
|
|