6 * Copyright (c) 1999-2005 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * Displays all options relating to folders
12 * @package squirrelmail
15 /** SquirrelMail required files. */
16 require_once(SM_PATH
. 'functions/imap.php');
17 require_once(SM_PATH
. 'functions/imap_general.php');
19 /* Define the group constants for the folder options page. */
20 define('SMOPT_GRP_SPCFOLDER', 0);
21 define('SMOPT_GRP_FOLDERLIST', 1);
22 define('SMOPT_GRP_FOLDERSELECT', 2);
25 * This function builds an array with all the information about
26 * the options available to the user, and returns it. The options
27 * are grouped by the groups in which they are displayed.
28 * For each option, the following information is stored:
29 * - name: the internal (variable) name
30 * - caption: the description of the option in the UI
31 * - type: one of SMOPT_TYPE_*
32 * - refresh: one of SMOPT_REFRESH_*
33 * - size: one of SMOPT_SIZE_*
34 * - save: the name of a function to call when saving this option
35 * @return array all option information
37 function load_optpage_data_folder() {
38 global $username, $key, $imapServerAddress, $imapPort;
39 global $folder_prefix, $default_folder_prefix, $show_prefix_option;
41 /* Get some imap data we need later. */
43 sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
44 $boxes = sqimap_mailbox_list($imapConnection);
46 /* Build a simple array into which we will build options. */
50 /******************************************************/
51 /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
52 /******************************************************/
54 /*** Load the General Options into the array ***/
55 $optgrps[SMOPT_GRP_SPCFOLDER
] = _("Special Folder Options");
56 $optvals[SMOPT_GRP_SPCFOLDER
] = array();
58 if (!isset($folder_prefix)) { $folder_prefix = $default_folder_prefix; }
59 if ($show_prefix_option) {
60 $optvals[SMOPT_GRP_SPCFOLDER
][] = array(
61 'name' => 'folder_prefix',
62 'caption' => _("Folder Path"),
63 'type' => SMOPT_TYPE_STRING
,
64 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
65 'size' => SMOPT_SIZE_LARGE
69 $trash_folder_values = array(SMPREF_NONE
=> '[ '._("Do not use Trash").' ]',
70 'whatever' => $boxes);
71 $optvals[SMOPT_GRP_SPCFOLDER
][] = array(
72 'name' => 'trash_folder',
73 'caption' => _("Trash Folder"),
74 'type' => SMOPT_TYPE_FLDRLIST
,
75 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
76 'posvals' => $trash_folder_values,
77 'save' => 'save_option_trash_folder'
80 $draft_folder_values = array(SMPREF_NONE
=> '[ '._("Do not use Drafts").' ]',
81 'whatever' => $boxes);
82 $optvals[SMOPT_GRP_SPCFOLDER
][] = array(
83 'name' => 'draft_folder',
84 'caption' => _("Draft Folder"),
85 'type' => SMOPT_TYPE_FLDRLIST
,
86 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
87 'posvals' => $draft_folder_values,
88 'save' => 'save_option_draft_folder'
91 $sent_folder_values = array(SMPREF_NONE
=> '[ '._("Do not use Sent").' ]',
92 'whatever' => $boxes);
93 $optvals[SMOPT_GRP_SPCFOLDER
][] = array(
94 'name' => 'sent_folder',
95 'caption' => _("Sent Folder"),
96 'type' => SMOPT_TYPE_FLDRLIST
,
97 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
98 'posvals' => $sent_folder_values,
99 'save' => 'save_option_sent_folder'
102 $optvals[SMOPT_GRP_SPCFOLDER
][] = array(
103 'name' => 'save_reply_with_orig',
104 'caption' => _("Save Replies with Original Message"),
105 'type' => SMOPT_TYPE_BOOLEAN
,
106 'refresh' => SMOPT_REFRESH_FOLDERLIST
109 /*** Load the General Options into the array ***/
110 $optgrps[SMOPT_GRP_FOLDERLIST
] = _("Folder List Options");
111 $optvals[SMOPT_GRP_FOLDERLIST
] = array();
113 $optvals[SMOPT_GRP_FOLDERLIST
][] = array(
114 'name' => 'location_of_bar',
115 'caption' => _("Location of Folder List"),
116 'type' => SMOPT_TYPE_STRLIST
,
117 'refresh' => SMOPT_REFRESH_ALL
,
118 'posvals' => array(SMPREF_LOC_LEFT
=> _("Left"),
119 SMPREF_LOC_RIGHT
=> _("Right"))
122 $left_size_values = array();
123 for ($lsv = 100; $lsv <= 300; $lsv +
= 10) {
124 $left_size_values[$lsv] = "$lsv " . _("pixels");
126 $optvals[SMOPT_GRP_FOLDERLIST
][] = array(
127 'name' => 'left_size',
128 'caption' => _("Width of Folder List"),
129 'type' => SMOPT_TYPE_STRLIST
,
130 'refresh' => SMOPT_REFRESH_ALL
,
131 'posvals' => $left_size_values
134 $left_refresh_values = array(SMPREF_NONE
=> _("Never"));
135 foreach (array(30,60,120,180,300,600,1200) as $lr_val) {
137 $left_refresh_values[$lr_val] = "$lr_val " . _("Seconds");
139 $left_refresh_values[$lr_val] = sprintf(ngettext("%d Minute","%d Minutes",($lr_val/60)),($lr_val/60));
142 $optvals[SMOPT_GRP_FOLDERLIST
][] = array(
143 'name' => 'left_refresh',
144 'caption' => _("Auto Refresh Folder List"),
145 'type' => SMOPT_TYPE_STRLIST
,
146 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
147 'posvals' => $left_refresh_values
150 $optvals[SMOPT_GRP_FOLDERLIST
][] = array(
151 'name' => 'unseen_notify',
152 'caption' => _("Enable Unread Message Notification"),
153 'type' => SMOPT_TYPE_STRLIST
,
154 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
155 'posvals' => array(SMPREF_UNSEEN_NONE
=> _("No Notification"),
156 SMPREF_UNSEEN_INBOX
=> _("Only INBOX"),
157 SMPREF_UNSEEN_ALL
=> _("All Folders"))
160 $optvals[SMOPT_GRP_FOLDERLIST
][] = array(
161 'name' => 'unseen_type',
162 'caption' => _("Unread Message Notification Type"),
163 'type' => SMOPT_TYPE_STRLIST
,
164 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
165 'posvals' => array(SMPREF_UNSEEN_ONLY
=> _("Only Unseen"),
166 SMPREF_UNSEEN_TOTAL
=> _("Unseen and Total"))
169 $optvals[SMOPT_GRP_FOLDERLIST
][] = array(
170 'name' => 'collapse_folders',
171 'caption' => _("Enable Collapsable Folders"),
172 'type' => SMOPT_TYPE_BOOLEAN
,
173 'refresh' => SMOPT_REFRESH_FOLDERLIST
176 $optvals[SMOPT_GRP_FOLDERLIST
][] = array(
177 'name' => 'unseen_cum',
178 'caption' => _("Enable Cumulative Unread Message Notification"),
179 'type' => SMOPT_TYPE_BOOLEAN
,
180 'refresh' => SMOPT_REFRESH_FOLDERLIST
184 $optvals[SMOPT_GRP_FOLDERLIST
][] = array(
185 'name' => 'date_format',
186 'caption' => _("Show Clock on Folders Panel"),
187 'type' => SMOPT_TYPE_STRLIST
,
188 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
189 'posvals' => array( '0' => _("International date and time"),
190 '1' => _("American date and time"),
191 '2' => _("European date and time"),
192 '3' => _("Show weekday and time"),
193 '4' => _("Show time with seconds"),
194 '5' => _("Show time"),
195 '6' => _("No Clock")),
198 $optvals[SMOPT_GRP_FOLDERLIST
][] = array(
199 'name' => 'search_memory',
200 'caption' => _("Memory Search"),
201 'type' => SMOPT_TYPE_STRLIST
,
202 'refresh' => SMOPT_REFRESH_NONE
,
203 'posvals' => array( 0 => _("Disabled"),
215 $optvals[SMOPT_GRP_FOLDERLIST
][] = array(
216 'name' => 'show_only_subscribed_folders',
217 'caption' => _("Show only subscribed folders"),
218 'type' => SMOPT_TYPE_BOOLEAN
,
219 'refresh' => SMOPT_REFRESH_FOLDERLIST
222 /*** Load the General Options into the array ***/
223 $optgrps[SMOPT_GRP_FOLDERSELECT
] = _("Folder Selection Options");
224 $optvals[SMOPT_GRP_FOLDERSELECT
] = array();
226 $delim = sqimap_get_delimiter($imapConnection);
227 $optvals[SMOPT_GRP_FOLDERSELECT
][] = array(
228 'name' => 'mailbox_select_style',
229 'caption' => _("Selection List Style"),
230 'type' => SMOPT_TYPE_STRLIST
,
231 'refresh' => SMOPT_REFRESH_NONE
,
232 'posvals' => array( 0 => _("Long: ") . '"' . _("Folder") . $delim . _("Subfolder") . '"',
233 1 => _("Indented: ") . '" ' . _("Subfolder") . '"',
234 2 => _("Delimited: ") . '". ' . _("Subfolder") . '"'),
235 'htmlencoded' => true
238 /* Assemble all this together and return it as our result. */
243 sqimap_logout($imapConnection);
247 /******************************************************************/
248 /** Define any specialized save functions for this option page. ***/
249 /******************************************************************/
252 * Saves the trash folder option.
254 function save_option_trash_folder($option) {
255 global $data_dir, $username;
257 /* Set move to trash on or off. */
258 $trash_on = ($option->new_value
== SMPREF_NONE ? SMPREF_OFF
: SMPREF_ON
);
259 setPref($data_dir, $username, 'move_to_trash', $trash_on);
261 /* Now just save the option as normal. */
262 save_option($option);
266 * Saves the sent folder option.
268 function save_option_sent_folder($option) {
269 global $data_dir, $username;
271 /* Set move to sent on or off. */
272 $sent_on = ($option->new_value
== SMPREF_NONE ? SMPREF_OFF
: SMPREF_ON
);
273 setPref($data_dir, $username, 'move_to_sent', $sent_on);
275 /* Now just save the option as normal. */
276 save_option($option);
280 * Saves the draft folder option.
282 function save_option_draft_folder($option) {
283 global $data_dir, $username;
285 /* Set move to draft on or off. */
286 $draft_on = ($option->new_value
== SMPREF_NONE ? SMPREF_OFF
: SMPREF_ON
);
287 setPref($data_dir, $username, 'save_as_draft', $draft_on);
289 /* Now just save the option as normal. */
290 save_option($option);