[squirrelmail.git] / templates / default / left_main_advanced.tpl

<?php
/**
 * left_main_advanced.tpl
 *
 * Displays an experimental mailbox-tree with dhtml behaviour.
 * It only works on browsers which supports css and javascript. The used
 * javascript is experimental and doesn't support all browsers.
 * It has been tested on IE6 an Konquerer 3.0.0-2.
 * It is now tested and working on: (please test and update this list)
 * Windows: IE 5.5 SP2, IE 6 SP1, Gecko based (Mozilla, Firebird) and Opera7
 * XWindow: ?
 * Mac: ?
 * In the function ListAdvancedBoxes there is another var $use_folder_images.
 * setting this to true is only usefull if the images exists in ../images.
 *
 * Feel free to experiment with the code and report bugs and enhancements
 *
 * The following variables are avilable in this template:
 *      $clock           - formatted string containing last refresh
 *      $mailbox_listing - string containing HTML to display default mailbox tree
 *      $location_of_bar - string "left" or "right" indicating where the frame
 *                         is located.  Currently only used in
 *                         left_main_advanced.tpl
 *      $left_size       - width of left column in pixels.  Currently only used
 *                         in left_main_advanced.tpl
 *      $imapConnection  - IMAP connection handle.  Needed to allow plugins to
 *                         read the mailbox.
 *      $icon_theme_path - Path to the desired icon theme.  If no icon theme has
 *                         been chosen, this will be the template directory.  If
 *                         the user has disabled icons, this will be NULL.
 *
 *      $unread_notification_enabled - Boolean TRUE if the user wants to see unread
 *                             message count on mailboxes
 *      $unread_notification_cummulative - Boolean TRUE if the user has enabled
 *                             cummulative message counts.
 *      $unread_notification_allFolders - Boolean TRUE if the user wants to see
 *                             unread message count on ALL folders or just the
 *                             mailbox.
 *      $unread_notification_displayTotal - Boolean TRUE if the user wants to
 *                             see the total number of messages in addition to
 *                             the unread message count.
 *      $collapsable_folders_enabled - Boolean TRUE if the user has enabled collapsable
 *                             folders.
 *      $use_special_folder_color - Boolean TRUE if the use has chosen to tag
 *                             "Special" folders in a different color.
 *      $message_recycling_enabled - Boolean TRUE if messages that get deleted go to
 *                             the Trash folder.  FALSE if they are permanently
 *                             deleted.
 *      $trash_folder_name   - Name of the Trash folder.
 *
 *      $mailboxes       - Associative array of current mailbox structure.
 *                         Provided so template authors know what they have to
 *                         work with when building a custom mailbox tree.
 *                         Array contains the following elements:
 *          $a['MailboxName']   = String containing the name of the mailbox
 *          $a['MailboxFullName'] = String containing full IMAP name of mailbox
 *          $a['MessageCount']  = integer of all messages in the mailbox
 *          $a['UnreadCount']   = integer of unseen message in the mailbox
 *          $a['ViewLink']      = array containing elements needed to view the
 *                                mailbox.  Elements are:
 *                                  'Target' = target frame for link
 *                                  'URL'    = target URL for link
 *          $a['IsRecent']      = boolean TRUE if the mailbox is tagged "recent"
 *          $a['IsSpecial']     = boolean TRUE if the mailbox is tagged "special"
 *          $a['IsRoot']        = boolean TRUE if the mailbox is the root mailbox
 *          $a['IsNoSelect']    = boolean TRUE if the mailbox is tagged "noselect"
 *          $a['IsCollapsed']   = boolean TRUE if the mailbox is currently collapsed
 *          $a['CollapseLink']  = array containg elements needed to expand/collapse
 *                                the mailbox.  Elements are:
 *                                  'Target' = target frame for link
 *                                  'URL'    = target URL for link
 *                                  'Icon'   = the icon to use, based on user prefs
 *          $a['ChildBoxes']    = array containing this same data structure for
 *                                each child folder/mailbox of the current
 *                                mailbox.
 *          $a['CummulativeMessageCount']   = integer of total messages in all
 *                                            folders in this mailbox, exlcuding
 *                                            trash folders.
 *          $a['CummulativeUnreadCount']    = integer of total unseen messages
 *                                            in all folders in this mailbox,
 *                                            excluding trash folders.
 *
 * *
 * @copyright &copy; 1999-2006 The SquirrelMail Project Team
 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
 * @version $Id$
 * @package squirrelmail
 * @subpackage templates
 */

/*
 * Recursively parse the mailbox structure to build the navigation tree.
 *
 * @param array $box Array containing mailbox data
 * @param array $settings Array containing perferences, etc, passed to template
 * @param integer $indent_factor Counter used to control indent spacing
 * @since 1.5.2
 * @author Steve Brown
 */
function buildMailboxTree ($box, $settings, $indent_factor=0) {
    // Work in progress...
}

/* retrieve the template vars */
extract($t);

/*
 * Build an array to pass user prefs to the function that builds the tree in
 * order to avoid using globals, which are dirty, filthy things in templates. :)
 */
$settings = array();
$settings['imapConnection'] = $imapConnection;
$settings['iconThemePath'] = $icon_theme_path;
$settings['unreadNotificationEnabled'] = $unread_notification_enabled;
$settings['unreadNotificationAllFolders'] = $unread_notification_allFolders;
$settings['unreadNotificationDisplayTotal'] = $unread_notification_displayTotal;
$settings['unreadNotificationCummulative'] = $unread_notification_cummulative;
$settings['useSpecialFolderColor'] = $use_special_folder_color;
$settings['messageRecyclingEnabled'] = $message_recycling_enabled;
$settings['trashFolderName'] = $trash_folder_name;
$settings['collapsableFoldersEnabled'] = $collapsable_folders_enabled;

?>
<body class="sqm_leftMain">
<script type="text/javascript" src="js/test.js"></script>
<script type="text/javascript">
<!--
/**
Commit	Line	Data
29997535	1	<?php
	2	/**
	3	* left_main_advanced.tpl
	4	*
e945d2c2	5	* Displays an experimental mailbox-tree with dhtml behaviour.
29997535	6	* It only works on browsers which supports css and javascript. The used
	7	* javascript is experimental and doesn't support all browsers.
	8	* It has been tested on IE6 an Konquerer 3.0.0-2.
	9	* It is now tested and working on: (please test and update this list)
	10	* Windows: IE 5.5 SP2, IE 6 SP1, Gecko based (Mozilla, Firebird) and Opera7
	11	* XWindow: ?
	12	* Mac: ?
	13	* In the function ListAdvancedBoxes there is another var $use_folder_images.
	14	* setting this to true is only usefull if the images exists in ../images.
	15	*
	16	* Feel free to experiment with the code and report bugs and enhancements
	17	*
	18	* The following variables are avilable in this template:
	19	* $clock - formatted string containing last refresh
	20	* $mailbox_listing - string containing HTML to display default mailbox tree
	21	* $location_of_bar - string "left" or "right" indicating where the frame
	22	* is located. Currently only used in
	23	* left_main_advanced.tpl
	24	* $left_size - width of left column in pixels. Currently only used
	25	* in left_main_advanced.tpl
e945d2c2	26	* $imapConnection - IMAP connection handle. Needed to allow plugins to
29997535	27	* read the mailbox.
	28	* $icon_theme_path - Path to the desired icon theme. If no icon theme has
	29	* been chosen, this will be the template directory. If
	30	* the user has disabled icons, this will be NULL.
	31	*
e945d2c2	32	* $unread_notification_enabled - Boolean TRUE if the user wants to see unread
29997535	33	* message count on mailboxes
	34	* $unread_notification_cummulative - Boolean TRUE if the user has enabled
	35	* cummulative message counts.
	36	* $unread_notification_allFolders - Boolean TRUE if the user wants to see
	37	* unread message count on ALL folders or just the
	38	* mailbox.
	39	* $unread_notification_displayTotal - Boolean TRUE if the user wants to
	40	* see the total number of messages in addition to
	41	* the unread message count.
	42	* $collapsable_folders_enabled - Boolean TRUE if the user has enabled collapsable
	43	* folders.
	44	* $use_special_folder_color - Boolean TRUE if the use has chosen to tag
	45	* "Special" folders in a different color.
	46	* $message_recycling_enabled - Boolean TRUE if messages that get deleted go to
	47	* the Trash folder. FALSE if they are permanently
	48	* deleted.
	49	* $trash_folder_name - Name of the Trash folder.
e945d2c2	50	*
29997535	51	* $mailboxes - Associative array of current mailbox structure.
	52	* Provided so template authors know what they have to
	53	* work with when building a custom mailbox tree.
	54	* Array contains the following elements:
	55	* $a['MailboxName'] = String containing the name of the mailbox
	56	* $a['MailboxFullName'] = String containing full IMAP name of mailbox
	57	* $a['MessageCount'] = integer of all messages in the mailbox
	58	* $a['UnreadCount'] = integer of unseen message in the mailbox
	59	* $a['ViewLink'] = array containing elements needed to view the
	60	* mailbox. Elements are:
	61	* 'Target' = target frame for link
	62	* 'URL' = target URL for link
	63	* $a['IsRecent'] = boolean TRUE if the mailbox is tagged "recent"
	64	* $a['IsSpecial'] = boolean TRUE if the mailbox is tagged "special"
	65	* $a['IsRoot'] = boolean TRUE if the mailbox is the root mailbox
	66	* $a['IsNoSelect'] = boolean TRUE if the mailbox is tagged "noselect"
	67	* $a['IsCollapsed'] = boolean TRUE if the mailbox is currently collapsed
	68	* $a['CollapseLink'] = array containg elements needed to expand/collapse
	69	* the mailbox. Elements are:
	70	* 'Target' = target frame for link
	71	* 'URL' = target URL for link
	72	* 'Icon' = the icon to use, based on user prefs
	73	* $a['ChildBoxes'] = array containing this same data structure for
	74	* each child folder/mailbox of the current
e945d2c2	75	* mailbox.
29997535	76	* $a['CummulativeMessageCount'] = integer of total messages in all
	77	* folders in this mailbox, exlcuding
	78	* trash folders.
	79	* $a['CummulativeUnreadCount'] = integer of total unseen messages
	80	* in all folders in this mailbox,
	81	* excluding trash folders.
	82	*
	83	* *
	84	* @copyright © 1999-2006 The SquirrelMail Project Team
	85	* @license http://opensource.org/licenses/gpl-license.php GNU Public License
	86	* @version $Id$
	87	* @package squirrelmail
	88	* @subpackage templates
	89	*/
	90
	91	/*
	92	* Recursively parse the mailbox structure to build the navigation tree.
e945d2c2	93	*
29997535	94	* @param array $box Array containing mailbox data
	95	* @param array $settings Array containing perferences, etc, passed to template
	96	* @param integer $indent_factor Counter used to control indent spacing
	97	* @since 1.5.2
	98	* @author Steve Brown
	99	*/
	100	function buildMailboxTree ($box, $settings, $indent_factor=0) {
	101	// Work in progress...
	102	}
	103
	104	/* retrieve the template vars */
	105	extract($t);
	106
	107	/*
	108	* Build an array to pass user prefs to the function that builds the tree in
	109	* order to avoid using globals, which are dirty, filthy things in templates. :)
e945d2c2	110	*/
29997535	111	$settings = array();
	112	$settings['imapConnection'] = $imapConnection;
	113	$settings['iconThemePath'] = $icon_theme_path;
	114	$settings['unreadNotificationEnabled'] = $unread_notification_enabled;
	115	$settings['unreadNotificationAllFolders'] = $unread_notification_allFolders;
	116	$settings['unreadNotificationDisplayTotal'] = $unread_notification_displayTotal;
	117	$settings['unreadNotificationCummulative'] = $unread_notification_cummulative;
	118	$settings['useSpecialFolderColor'] = $use_special_folder_color;
	119	$settings['messageRecyclingEnabled'] = $message_recycling_enabled;
	120	$settings['trashFolderName'] = $trash_folder_name;
	121	$settings['collapsableFoldersEnabled'] = $collapsable_folders_enabled;
	122
	123	?>
	124	<body class="sqm_leftMain">
	125	<script type="text/javascript" src="js/test.js"></script>
	126	<script type="text/javascript">
	127	<!--
	128	/**
e945d2c2	129