- * $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.
+ * $settings - Array containing user perferences needed by this
+ * template. Indexes are as follows:
+ * $settings['templateID'] - contains the ID of the current
+ * template set. This may be needed by third
+ * party packages that don't integrate easily.
+ * $settings['unreadNotificationEnabled'] - Boolean TRUE if the user
+ * wants to see unread message count on mailboxes
+ * $settings['unreadNotificationCummulative'] - Boolean TRUE if the
+ * user has enabled cummulative message counts.
+ * $settings['unreadNotificationAllFolders'] - Boolean TRUE if the
+ * user wants to see unread message count on ALL
+ * folders or just the Inbox.
+ * $settings['unreadNotificationDisplayTotal'] - Boolean TRUE if the
+ * user wants to see the total number of messages in
+ * addition to the unread message count.
+ * $settings['collapsableFoldersEnabled'] - Boolean TRUE if the user
+ * has enabled collapsable folders.
+ * $settings['useSpecialFolderColor'] - Boolean TRUE if the use has
+ * chosen to tag "Special" folders in a different color
+ * $settings['messageRecyclingEnabled'] - Boolean TRUE if messages
+ * that get deleted go to the Trash folder. FALSE if
+ * they are permanently deleted.