| [ Index ] |
|
Code source de IMP H3 (4.1.5) |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Poids: | 995 lignes (33 kb) |
| Inclus ou requis: | 3 fois |
| Référencé: | 0 fois |
| Nécessite: | 4 fichiers lib/IMAP/Search.php lib/IMAP.php lib/MIME/Contents.php lib/IMAP/Thread.php |
IMP_Mailbox:: (29 méthodes):
singleton()
IMP_Mailbox()
setNoNewmailPopup()
setNewIndex()
showPreviews()
buildMailboxArray()
_buildMailbox()
newMessageCount()
unseenMessages()
getArrayIndex()
getMessageIndex()
getMessageCount()
isValidIndex()
getIMAPIndex()
updateMailbox()
buildMailboxPage()
sortby()
aboveSortLimit()
isSpecialFolder()
_setSorted()
_setArrayIndex()
_getSortedIndex()
_setRange()
_threadSort()
getThreadOb()
_sortIfNeeded()
_removeCurrent()
_determineSort()
moveNext()
Classe: IMP_Mailbox - X-Ref
The IMP_Mailbox:: class contains all code related to handling mailbox| singleton($index = null, $force = false) X-Ref |
| Attempts to return a reference to a concrete IMP_Mailbox instance. It will only create a new instance if no IMP_Mailbox instance with the same parameters currently exists. This method must be invoked as: $var = &IMP_Mailbox::singleton(); param: integer $index See IMP_Mailbox constructor. param: boolean $force Force the creation of a new instance. return: mixed The created concrete IMP_Mailbox instance, or false |
| IMP_Mailbox($index = null) X-Ref |
| Constructor. param: integer $index The index of the current message. This will cause |
| setNoNewmailPopup($nopopup) X-Ref |
| Sets the value of the 'no_newmail_popup' flag. param: boolean $nopopup The value to set the flag. |
| setNewIndex($index) X-Ref |
| Sets a new index. param: integer $index The index of the new current message. |
| showPreviews() X-Ref |
| Determines if mail previews should be generated. return: boolean True if mail previews should be generated. |
| buildMailboxArray($begin, $end) X-Ref |
| Build the array of message information. param: integer $begin The beginning message number. param: integer $end The ending message number. return: array An array with information on the requested messages. |
| _buildMailbox() X-Ref |
| Builds the list of messages in the mailbox. return: array The sorted index. |
| newMessageCount() X-Ref |
| The number of new messages in the mailbox (IMAP RECENT flag, with UNDELETED if we're hiding deleted messages). return: integer The number of new messages in the mailbox. |
| unseenMessages() X-Ref |
| Get the list of unseen messages in the mailbox (IMAP UNSEEN flag). return: array The list of unseen messages. |
| getArrayIndex() X-Ref |
| Returns the current array index. return: integer The array index. |
| getMessageIndex() X-Ref |
| Returns the current message array index. If the array index has run off the end of the message array, will return the last index. return: integer The message array index. |
| getMessageCount() X-Ref |
| Returns the current message count of the mailbox. return: integer The mailbox message count. |
| isValidIndex() X-Ref |
| Checks to see if the current index is valid. This function is only useful if an index was passed to the constructor. return: boolean True if index is valid, false if not. |
| getIMAPIndex($offset = 0) X-Ref |
| Returns IMAP mbox/UID information on a message. param: integer $offset The offset from the current message. return: array 'index' -- The message index. |
| updateMailbox($action, $success = true) X-Ref |
| Update the current mailbox if an action has been performed on the current message index. param: integer $action The action to perform. param: boolean $success Was the action successful? |
| buildMailboxPage($page = 0, $start = 0) X-Ref |
| Using the preferences and the current mailbox, determines the messages to view on the current page. param: integer $page The page number currently being displayed. param: integer $start The starting message number. return: stdClass An object with the following fields: |
| sortby() X-Ref |
| Return the current sort method used. return: integer The sort method. |
| aboveSortLimit() X-Ref |
| Determine whether the sort limit has been reached. return: boolean Has the sort limit been reached? |
| isSpecialFolder() X-Ref |
| Is this a 'special' folder (e.g. 'drafts' or 'sent-mail' folder)? return: boolean Is this a 'special' folder? |
| _setSorted() X-Ref |
| Updates the sorted messages array. |
| _setArrayIndex($data, $type) X-Ref |
| Updates the message array index. param: integer $data If $type is 'offset', the number of messages to param: string $type Either 'offset' or 'uid'. |
| _getSortedIndex() X-Ref |
| Get the sorted list of messages for a mailbox. This function correctly handles sort preferences, deletion preferences (e.g. hide deleted messages), and protocol (e.g. 'pop3' vs. 'imap'). The following variables are updated by this method: msgl |
| _setRange($arr) X-Ref |
| Sets the current page of messages based on the current index. The following session variables are updated by this method: 'msgl' param: array $arr The array of message indices. |
| _threadSort($new) X-Ref |
| Perform re-threading sort. param: boolean $new True for newest messages first, false for oldest return: array The sorted list of messages. |
| getThreadOb() X-Ref |
| Get the IMP_Thread object for the current mailbox. return: IMP_Thread The IMP_Thread object for the current mailbox. |
| _sortIfNeeded() X-Ref |
| Determines if a resort is needed, and, if necessary, performs the resort. The sorted range needs to be updated in the following cases: + Indexes are being tracked + There is a valid array index + This is not a search mailbox + The UIDs may no longer be valid (Optional) + This is the last message in the mailbox + A sort has not already occurred by some method in this class |
| _removeCurrent() X-Ref |
| Returns the current sorted array without the current index message. return: array The sorted array without the current index in it. |
| _determineSort($check = false) X-Ref |
| Determine the correct sort method for this mailbox. param: boolean Run the sort_limit check? |
| moveNext() X-Ref |
| Move current pointer to the next index. |
| Généré le : Thu Nov 29 12:30:07 2007 | par Balluche grâce à PHPXref 0.7 |
|
|