* array callback used for sorting in mailboxes class
* @param object $a
* @param object $b
+ * @return integer see php strnatcasecmp()
* @since 1.3.0
*/
function sortSpecialMbx($a, $b) {
* (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
+ * Originally stored in functions/strings.php. Since 1.2.6 stored in
* functions/imap_mailbox.php
* @param string $line imap LIST/LSUB response line
* @return string mailbox name
/**
* 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.
* @param string $lsub_line mailbox line from untagged LIST or LSUB response
* @return bool whether this is a Noselect mailbox.
* @since 1.3.2
* separator character, returns the second last part of the full
* mailbox name (i.e. the mailbox's parent mailbox)
*
- * Originally stored in functions/strings.php. Since 1.2.6 stored in
+ * Originally stored in functions/strings.php. Since 1.2.6 stored in
* functions/imap_mailbox.php
* @param string $haystack full mailbox name
* @param string $needle delimiter
- * @return string parent mailbox
+ * @return string parent mailbox
*/
function readMailboxParent($haystack, $needle) {
if ($needle == '') {
/**
* 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.<br>
* Since 1.4.3 hook supports more than one plugin.
* @param string $box mailbox name
/**
* Expunges a mailbox
- *
+ *
* WARNING: Select mailbox before calling this function.
- *
- * permanently removes all messages that have the \Deleted flag
- * set from the selected mailbox. See EXPUNGE command chapter in
+ *
+ * permanently removes all messages that have the \Deleted flag
+ * set from the selected mailbox. See EXPUNGE command chapter in
* IMAP RFC.
* @param stream $imap_stream imap connection resource
* @param string $mailbox mailbox name (unused since 1.1.3).
* @param boolean $handle_errors error handling control (displays error_box on error).
* @param mixed $id (since 1.3.0) integer message id or array with integer ids
* @return integer number of expunged messages
- *
+ * @since 1.0 or older
*/
function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
if ($id) {
* Before 1.3.0 used more arguments and returned data depended on those argumements.
* @param stream $imap_stream imap connection resource
* @param string $mailbox mailbox name
- * @return array results of select command (on success - permanentflags, flags and rights)
+ * @return array results of select command (on success - permanentflags, flags and rights)
* @since 1.0 or older
*/
function sqimap_mailbox_select ($imap_stream, $mailbox) {
* 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
+ *
+ * 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.
* @param stream $imap_steam imap connection resource
* @param string $mailbox mailbox name
/**
* Deletes the given folder
+ * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
+ * @param stream $imap_stream imap connection resource
+ * @param string $mailbox mailbox name
+ * @since 1.0 or older
*/
function sqimap_mailbox_delete ($imap_stream, $mailbox) {
global $data_dir, $username;
/**
* Determines if the user is subscribed to the folder or not
+ * @param stream $imap_stream imap connection resource
+ * @param string $mailbox mailbox name
+ * @return boolean
+ * @since 1.2.0
*/
function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
$boxesall = sqimap_mailbox_list ($imap_stream);
/**
* Renames a mailbox.
+ * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
+ * @param stream $imap_stream imap connection resource
+ * @param string $old_name mailbox name
+ * @param string $new_name new mailbox name
+ * @since 1.2.3
*/
function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
if ( $old_name != $new_name ) {
* Formats a mailbox into parts for the $boxesall array
*
* The parts are:
- *
- * raw - Raw LIST/LSUB response from the IMAP server
- * formatted - nicely formatted folder name
- * unformatted - unformatted, but with delimiter at end removed
- * unformatted-dm - folder name as it appears in raw response
- * unformatted-disp - unformatted without $folder_prefix
+ * <ul>
+ * <li>raw - Raw LIST/LSUB response from the IMAP server
+ * <li>formatted - nicely formatted folder name
+ * <li>unformatted - unformatted, but with delimiter at end removed
+ * <li>unformatted-dm - folder name as it appears in raw response
+ * <li>unformatted-disp - unformatted without $folder_prefix
+ * <li>id - TODO: document me
+ * <li>flags - TODO: document me
+ * </ul>
+ * Before 1.2.0 used third argument for delimiter.
+ * @param $line
+ * @param $line_lsub
+ * @return array
+ * @since 1.0 or older
+ * @todo document id and flags keys in boxes array and function arguments.
*/
function sqimap_mailbox_parse ($line, $line_lsub) {
global $folder_prefix, $delimiter;
* based on available mailboxes and separators
* Caller should surround options with <select ...> </select> and
* any formatting.
- * $imap_stream - $imapConnection to query for mailboxes
- * $show_selected - array containing list of mailboxes to pre-select (0 if none)
- * $folder_skip - array of folders to keep out of option list (compared in lower)
- * $boxes - list of already fetched boxes (for places like folder panel, where
+ * @param stream $imap_stream imap connection resource to query for mailboxes
+ * @param array $show_selected array containing list of mailboxes to pre-select (0 if none)
+ * @param array $folder_skip array of folders to keep out of option list (compared in lower)
+ * @param $boxes list of already fetched boxes (for places like folder panel, where
* you know these options will be shown 3 times in a row.. (most often unset).
- * $flag - flag to check for in mailbox flags, used to filter out mailboxes.
+ * @param 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
- * $use_long_format - override folder display preference and always show full folder name.
+ * @param boolean $use_long_format (since 1.4.1) override folder display preference and always show full folder name.
+ * @return string html formated mailbox selection options
+ * @since 1.3.2
*/
function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
$flag = 'noselect', $use_long_format = false ) {
* @param resource $imap_stream imap connection resource
* @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0
* @return array list of mailboxes
+ * @since 1.0 or older
*/
function sqimap_mailbox_list($imap_stream, $force=false) {
if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) {
/* Find INBOX's children */
for($k = 0; $k < $cnt; ++$k) {
- if (!$used[$k] && isBoxBelow(strtolower($boxesall[$k]['unformatted']), 'inbox') &&
+ if (!$used[$k] && isBoxBelow(strtolower($boxesall[$k]['unformatted']), 'inbox') &&
strtolower($boxesall[$k]['unformatted']) != 'inbox') {
$boxesnew[] = $boxesall[$k];
$used[$k] = true;
- }
+ }
}
-
+
/* Rest of the folders */
for($k = 0; $k < $cnt; $k++) {
if (!$used[$k]) {
}
/**
- * Returns a list of all folders, subscribed or not
+ * Returns a list of all folders, subscribed or not
+ * @param stream $imap_stream imap connection resource
+ * @return array see sqimap_mailbox_parse()
+ * @since 1.0 or older
*/
function sqimap_mailbox_list_all($imap_stream) {
global $list_special_folders_first, $folder_prefix, $delimiter;
return $boxes;
}
+/**
+ * @param stream $imap_stream imap connection resource
+ * @return object see mailboxes class.
+ * @since 1.3.0
+ */
function sqimap_mailbox_tree($imap_stream) {
global $default_folder_prefix;
if (true) {
}
}
+/**
+ * Callback function used for sorting mailboxes in sqimap_mailbox_tree
+ * @param string $a
+ * @param string $b
+ * @return integer see php strnatcasecmp()
+ * @since 1.5.1
+ */
function mbxSort($a, $b) {
return strnatcasecmp($a['mbx'], $b['mbx']);
}
+/**
+ * @param array $mbx_ary
+ * @param $mbxs
+ * @param stream $imap_stream (since 1.5.0) imap connection resource
+ * @return object see mailboxes class
+ * @since 1.3.0
+ */
function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) {
global $data_dir, $username, $list_special_folders_first,
$folder_prefix, $trash_folder, $sent_folder, $draft_folder,
return $mailboxes;
}
+/**
+ * @param object $mbx_tree
+ * @since 1.5.0
+ */
function sqimap_utf7_decode_mbx_tree(&$mbx_tree) {
if (strtoupper($mbx_tree->mailboxname_full) == 'INBOX')
$mbx_tree->mailboxname_sub = _("INBOX");
}
}
-
+/**
+ * @param object $mbx_tree
+ * @param array $aMbxs
+ * @since 1.5.0
+ */
function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) {
if ($mbx_tree)
$aMbxs[] =& $mbx_tree;
}
}
+/**
+ * @param stream $imap_stream imap connection resource
+ * @param object $mbx_tree
+ * @since since 1.5.0
+ */
function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
$aMbxs = $aQuery = array();
}
}
-?>
+?>
\ No newline at end of file
projects / squirrelmail.git / blobdiff