UTF7 support

Detects if mailbox has noselect flag (can't store messages) In versions older than 1.4.5 function checks only LSUB responses and can produce pcre warnings.

• return: whether this is a Noselect mailbox.
• since: 1.3.2

• string $lsub_line: mailbox line from untagged LIST or LSUB response

Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n mailbox name in quoted string MUST be unquoted and stripslashed (sm API)

Originally stored in functions/strings.php. Since 1.2.6 stored in functions/imap_mailbox.php

• return: mailbox name

• string $line: imap LIST/LSUB response line

Detects if mailbox is a Drafts folder or subfolder of Drafts

• return: whether this is a Draft folder
• since: 1.4.0

• string $box: mailbox name
• boolean $include_subs: (since 1.5.2) if true, subfolders of system folders are special. if false, subfolders are not special mailboxes.

Defines special mailboxes: given a mailbox name, it checks if this is a "special" one: INBOX, Trash, Sent or Draft.

Since 1.2.5 function includes special_mailbox hook.
Since 1.4.3 hook supports more than one plugin.

• since: 1.2.3

• string $box: mailbox name
• boolean $include_subs: (since 1.5.2) if true, subfolders of system folders are special. if false, subfolders are not special mailboxes unless they are tagged as special in 'special_mailbox' hook.

Callback function used for sorting mailboxes in sqimap_mailbox_tree

• return: see php strnatcasecmp()
• since: 1.5.1

• string $a
• string $b

array callback used for sorting in mailboxes class

• return: see php strnatcasecmp()
• since: 1.3.0

• object $a
• object $b

Gets the list of mailboxes for sqimap_maolbox_tree and sqimap_mailbox_list

This is because both of those functions had duplicated logic, but with slightly different implementations. This will make both use the same implementation, which should make it easier to maintain and easier to modify in the future

• return: - array of mailboxes and their attributes
• since: 1.5.1

• stream $imap_stream: imap connection resource
• bool $force: force a reload and ignore cache
• bool $show_only_subscribed: controls listing of visible or all folders
• bool $session_register: controls registration of retrieved data in session.

Creates a folder.

Mailbox is automatically subscribed.

Set $type to string that does not match 'noselect' (case insensitive), if you don't want to prepend delimiter to mailbox name. Please note that 'noinferiors' might be used someday as keyword for folders that store only messages.

• since: 1.0 or older

• stream $imap_steam: imap connection resource
• string $mailbox: mailbox name
• string $type: folder type.
• $imap_stream

Checks whether or not the specified mailbox exists

• since: 1.0 or older

• stream $imap_stream: imap connection resource
• string $mailbox: mailbox name
• array $mailboxlist: (since 1.5.1) optional array of mailboxes from sqimap_get_mailboxes() (to avoid having to talk to imap server)

Checks if folder is noinferiors (can't store other folders)

Function does not check if folder subscribed.

• return: true, when folder has noinferiors flag. false in any other case.
• since: 1.5.1

• stream $oImapStream: imap connection resource
• string $sImapFolder: imap folder name
• object $oBoxes: mailboxes class object.
• &$oBoxes

Determines if the user is subscribed to the folder or not

• since: 1.2.0

• stream $imap_stream: imap connection resource
• string $mailbox: mailbox name
• $folder

Returns a list of all folders, subscribed or not

Since 1.5.1 code moved to sqimap_get_mailboxes()

• return: see sqimap_mailbox_parse()
• since: 1.0 or older

• stream $imap_stream: imap connection resource

Returns list of options (to be echoed into select statement based on available mailboxes and separators Caller should surround options with <select ...> </select> and any formatting.

• return: html formated mailbox selection options
• since: 1.3.2

• stream $imap_stream: imap connection resource to query for mailboxes
• array $show_selected: array containing list of mailboxes to pre-select (0 if none)
• array $folder_skip: array of folders to keep out of option list (compared in lower)
• string $flag: (since 1.4.1) flag to check for in mailbox flags, used to filter out mailboxes. 'noselect' by default to remove unselectable mailboxes. 'noinferiors' used to filter out folders that can not contain subfolders. NULL to avoid flag check entirely. NOTE: noselect and noiferiors are used internally. The IMAP representation is \NoSelect and \NoInferiors
• boolean $use_long_format: (since 1.4.1) override folder display preference and always show full folder name.

Renames a mailbox.

Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook

• since: 1.2.3

• stream $imap_stream: imap connection resource
• string $old_name: mailbox name
• string $new_name: new mailbox name

Fills mailbox object

this is passed the mailbox array by left_main.php who has previously obtained it from sqimap_get_mailboxes that way, the raw mailbox list is available in left_main to other things besides just sqimap_mailbox_tree imap_stream is just used now to get status info

most of the functionality is moved to sqimap_get_mailboxes also takes care of TODO items: caching mailbox tree config setting for UW imap section (not needed now)

Some code fragments are present in 1.3.0 - 1.4.4.

• return: mailboxes class.
• since: 1.5.0

• stream $imap_stream: imap connection resource
• array $lsub_ary: output array from sqimap_get_mailboxes (contains mailboxes and flags)

• since: 1.5.0

• object $mbx_tree
• array $aMbxs
• &$mbx_tree
• &$aMbxs

• since: 1.5.0

• object $mbx_tree
• &$mbx_tree