Class IMAP_Sort

Description

IMAP_Sort provides functions for sorting lists of IMAP mailboxes/folders.

$Horde: framework/IMAP/IMAP/Sort.php,v 1.6.8.17 2009/01/06 15:23:11 jan Exp $

Copyright 2004-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

Located in /IMAP/IMAP/Sort.php (line 16)


	
			
Variable Summary
 string $_delimiter
 boolean $_sortinbox
Method Summary
 IMAP_Sort IMAP_Sort (string $delimiter)
 void sortMailboxes (array &$mbox, [boolean $inbox = true], [boolean $index = false])
 void sortMailboxesByKey (array &$mbox, [boolean $inbox = true])
Variables
string $_delimiter (line 23)

The delimiter character to use.

boolean $_sortinbox (line 30)

Should we sort with 'INBOX' at the front of the list?

Methods
Constructor IMAP_Sort (line 37)

Constructor.

IMAP_Sort IMAP_Sort (string $delimiter)
  • string $delimiter: The delimiter used to separate mailboxes.
sortMailboxes (line 50)

Sort a list of mailboxes (by value).

void sortMailboxes (array &$mbox, [boolean $inbox = true], [boolean $index = false])
  • array &$mbox: The list of mailboxes to sort.
  • boolean $inbox: When sorting, always put 'INBOX' at the head of the list?
  • boolean $index: Maintain index association?
sortMailboxesByKey (line 68)

Sort a list of mailboxes (by key).

void sortMailboxesByKey (array &$mbox, [boolean $inbox = true])
  • array &$mbox: The list of mailboxes to sort, with the keys being the mailbox names.
  • boolean $inbox: When sorting, always put 'INBOX' at the head of the list?

Documentation generated on Sun, 30 Jan 2011 05:21:39 +0000 by phpDocumentor 1.4.3