Overview

Packages

  • Imap
    • Client

Classes

  • Horde_Imap_Client
  • Horde_Imap_Client_Auth_DigestMD5
  • Horde_Imap_Client_Base
  • Horde_Imap_Client_Cache
  • Horde_Imap_Client_Data_Acl
  • Horde_Imap_Client_Data_AclCommon
  • Horde_Imap_Client_Data_AclNegative
  • Horde_Imap_Client_Data_AclRights
  • Horde_Imap_Client_Data_Envelope
  • Horde_Imap_Client_Data_Fetch
  • Horde_Imap_Client_Data_Fetch_Pop3
  • Horde_Imap_Client_Data_Thread
  • Horde_Imap_Client_DateTime
  • Horde_Imap_Client_Exception
  • Horde_Imap_Client_Exception_NoSupportExtension
  • Horde_Imap_Client_Fetch_Query
  • Horde_Imap_Client_Ids
  • Horde_Imap_Client_Ids_Pop3
  • Horde_Imap_Client_Mailbox
  • Horde_Imap_Client_Search_Query
  • Horde_Imap_Client_Socket
  • Horde_Imap_Client_Socket_Pop3
  • Horde_Imap_Client_Sort
  • Horde_Imap_Client_Translation
  • Horde_Imap_Client_Utf7imap
  • Horde_Imap_Client_Utils
  • Horde_Imap_Client_Utils_Pop3
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Imap_Client_Sort

Function to sort a list of IMAP mailboxes.

Copyright 2004-2012 Horde LLC (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Package: Imap\Client
Category: Horde
License: LGPL 2.1
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Imap/Client/Sort.php
Methods summary
final public static
# sortMailboxes( array & $mbox, array $options = array() )

Sort a list of mailboxes. $mbox will be sorted after running this function.

Sort a list of mailboxes. $mbox will be sorted after running this function.

Parameters

$mbox
$mbox The list of mailboxes to sort.
$options
<p>Additional options: - delimiter: (string) The delimiter to use. DEFAULT: '.' - inbox: (boolean) Always put INBOX at the head of the list? DEFAULT: Yes - index: (boolean) If sorting by value ('keysort' is false), maintain key index association? DEFAULT: No - keysort: (boolean) Sort by $mbox's keys? DEFAULT: Sort by $mbox values.</p>
final public static integer
# mboxCompare( string $a, string $b )

Hierarchical folder sorting function (used with usort()).

Hierarchical folder sorting function (used with usort()).

Parameters

$a
Comparison item 1.
$b
Comparison item 2.

Returns

integer
See usort().
API documentation generated by ApiGen