added new save replies with original message option
[squirrelmail.git] / include / options / folder.php
CommitLineData
c36ed9cf 1<?php
c36ed9cf 2
35586184 3/**
4 * options_folder.php
5 *
76911253 6 * Copyright (c) 1999-2003 The SquirrelMail Project Team
35586184 7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * Displays all options relating to folders
10 *
11 * $Id$
2b646597 12 * @package squirrelmail
35586184 13 */
cbe5423b 14
2b646597 15/** SquirrelMail required files. */
86725763 16require_once(SM_PATH . 'functions/imap.php');
be2d5495 17require_once(SM_PATH . 'functions/imap_general.php');
cbe5423b 18
aedb6605 19/* Define the group constants for the folder options page. */
cbe5423b 20define('SMOPT_GRP_SPCFOLDER', 0);
21define('SMOPT_GRP_FOLDERLIST', 1);
be2d5495 22define('SMOPT_GRP_FOLDERSELECT', 2);
cbe5423b 23
48af4b64 24/**
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
36 */
cbe5423b 37function load_optpage_data_folder() {
38 global $username, $key, $imapServerAddress, $imapPort;
2fad95fa 39 global $folder_prefix, $default_folder_prefix, $show_prefix_option;
cbe5423b 40
41 /* Get some imap data we need later. */
42 $imapConnection =
43 sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
44 $boxes = sqimap_mailbox_list($imapConnection);
bbcafebd 45
b5efadfa 46 /* Build a simple array into which we will build options. */
bbcafebd 47 $optgrps = array();
b5efadfa 48 $optvals = array();
49
bbcafebd 50 /******************************************************/
51 /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
52 /******************************************************/
bbcafebd 53
54 /*** Load the General Options into the array ***/
55 $optgrps[SMOPT_GRP_SPCFOLDER] = _("Special Folder Options");
56 $optvals[SMOPT_GRP_SPCFOLDER] = array();
57
cbe5423b 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
66 );
67 }
68
be2d5495 69 $trash_folder_values = array(SMPREF_NONE => '[ '._("Do not use Trash").' ]',
70 'whatever' => $boxes);
bbcafebd 71 $optvals[SMOPT_GRP_SPCFOLDER][] = array(
b5efadfa 72 'name' => 'trash_folder',
73 'caption' => _("Trash Folder"),
be2d5495 74 'type' => SMOPT_TYPE_FLDRLIST,
b5efadfa 75 'refresh' => SMOPT_REFRESH_FOLDERLIST,
cbe5423b 76 'posvals' => $trash_folder_values,
77 'save' => 'save_option_trash_folder'
b5efadfa 78 );
aedb6605 79
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'
89 );
90
be2d5495 91 $sent_folder_values = array(SMPREF_NONE => '[ '._("Do not use Sent").' ]',
92 'whatever' => $boxes);
bbcafebd 93 $optvals[SMOPT_GRP_SPCFOLDER][] = array(
b5efadfa 94 'name' => 'sent_folder',
95 'caption' => _("Sent Folder"),
be2d5495 96 'type' => SMOPT_TYPE_FLDRLIST,
b5efadfa 97 'refresh' => SMOPT_REFRESH_FOLDERLIST,
cbe5423b 98 'posvals' => $sent_folder_values,
99 'save' => 'save_option_sent_folder'
b5efadfa 100 );
aedb6605 101
bbcafebd 102 $optvals[SMOPT_GRP_SPCFOLDER][] = array(
aedb6605 103 'name' => 'save_reply_with_orig',
104 'caption' => _("Save Replies with Original Message"),
105 'type' => SMOPT_TYPE_BOOLEAN,
106 'refresh' => SMOPT_REFRESH_FOLDERLIST
b5efadfa 107 );
108
bbcafebd 109 /*** Load the General Options into the array ***/
110 $optgrps[SMOPT_GRP_FOLDERLIST] = _("Folder List Options");
111 $optvals[SMOPT_GRP_FOLDERLIST] = array();
112
113 $optvals[SMOPT_GRP_FOLDERLIST][] = array(
a440e68f 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"))
120 );
121
122 $left_size_values = array();
123 for ($lsv = 100; $lsv <= 300; $lsv += 10) {
124 $left_size_values[$lsv] = "$lsv " . _("pixels");
125 }
bbcafebd 126 $optvals[SMOPT_GRP_FOLDERLIST][] = array(
a440e68f 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
132 );
133
134 $minute_str = _("Minutes");
135 $left_refresh_values = array(SMPREF_NONE => _("Never"));
136 foreach (array(30,60,120,180,300,600) as $lr_val) {
137 if ($lr_val < 60) {
138 $left_refresh_values[$lr_val] = "$lr_val " . _("Seconds");
139 } else if ($lr_val == 60) {
140 $left_refresh_values[$lr_val] = "1 " . _("Minute");
141 } else {
142 $left_refresh_values[$lr_val] = ($lr_val/60) . " $minute_str";
143 }
144 }
bbcafebd 145 $optvals[SMOPT_GRP_FOLDERLIST][] = array(
a440e68f 146 'name' => 'left_refresh',
147 'caption' => _("Auto Refresh Folder List"),
148 'type' => SMOPT_TYPE_STRLIST,
149 'refresh' => SMOPT_REFRESH_FOLDERLIST,
150 'posvals' => $left_refresh_values
151 );
152
bbcafebd 153 $optvals[SMOPT_GRP_FOLDERLIST][] = array(
a440e68f 154 'name' => 'unseen_notify',
10ff0c3d 155 'caption' => _("Enable Unread Message Notification"),
a440e68f 156 'type' => SMOPT_TYPE_STRLIST,
157 'refresh' => SMOPT_REFRESH_FOLDERLIST,
158 'posvals' => array(SMPREF_UNSEEN_NONE => _("No Notification"),
159 SMPREF_UNSEEN_INBOX => _("Only INBOX"),
160 SMPREF_UNSEEN_ALL => _("All Folders"))
161 );
162
bbcafebd 163 $optvals[SMOPT_GRP_FOLDERLIST][] = array(
a440e68f 164 'name' => 'unseen_type',
10ff0c3d 165 'caption' => _("Unread Message Notification Type"),
a440e68f 166 'type' => SMOPT_TYPE_STRLIST,
167 'refresh' => SMOPT_REFRESH_FOLDERLIST,
168 'posvals' => array(SMPREF_UNSEEN_ONLY => _("Only Unseen"),
aedb6605 169 SMPREF_UNSEEN_TOTAL => _("Unseen and Total"))
a440e68f 170 );
171
bbcafebd 172 $optvals[SMOPT_GRP_FOLDERLIST][] = array(
a440e68f 173 'name' => 'collapse_folders',
174 'caption' => _("Enable Collapsable Folders"),
175 'type' => SMOPT_TYPE_BOOLEAN,
176 'refresh' => SMOPT_REFRESH_FOLDERLIST
177 );
178
f612a235 179 $optvals[SMOPT_GRP_FOLDERLIST][] = array(
180 'name' => 'unseen_cum',
181 'caption' => _("Enable Cumulative Unread Message Notification"),
182 'type' => SMOPT_TYPE_BOOLEAN,
183 'refresh' => SMOPT_REFRESH_FOLDERLIST
184 );
185
186
bbcafebd 187 $optvals[SMOPT_GRP_FOLDERLIST][] = array(
a440e68f 188 'name' => 'date_format',
189 'caption' => _("Show Clock on Folders Panel"),
190 'type' => SMOPT_TYPE_STRLIST,
191 'refresh' => SMOPT_REFRESH_FOLDERLIST,
192 'posvals' => array( '1' => 'MM/DD/YY HH:MM',
193 '2' => 'DD/MM/YY HH:MM',
157e9c5e 194 '3' => _("Show weekday and time"),
195 '4' => _("Show time with seconds"),
196 '5' => _("Show time"),
a440e68f 197 '6' => _("No Clock")),
198 );
199
bbcafebd 200 $optvals[SMOPT_GRP_FOLDERLIST][] = array(
a440e68f 201 'name' => 'hour_format',
202 'caption' => _("Hour Format"),
203 'type' => SMOPT_TYPE_STRLIST,
204 'refresh' => SMOPT_REFRESH_FOLDERLIST,
205 'posvals' => array(SMPREF_TIME_12HR => _("12-hour clock"),
aedb6605 206 SMPREF_TIME_24HR => _("24-hour clock"))
a440e68f 207 );
208
0d672ac0 209 $optvals[SMOPT_GRP_FOLDERLIST][] = array(
210 'name' => 'search_memory',
211 'caption' => _("Memory Search"),
212 'type' => SMOPT_TYPE_STRLIST,
90568047 213 'refresh' => SMOPT_REFRESH_NONE,
0d672ac0 214 'posvals' => array( 0 => _("Disabled"),
215 1 => '1',
216 2 => '2',
217 3 => '3',
218 4 => '4',
219 5 => '5',
220 6 => '6',
221 7 => '7',
222 8 => '8',
a2bc1180 223 9 => '9')
224 );
0d672ac0 225
be2d5495 226
227 /*** Load the General Options into the array ***/
228 $optgrps[SMOPT_GRP_FOLDERSELECT] = _("Folder Selection Options");
229 $optvals[SMOPT_GRP_FOLDERSELECT] = array();
230
ebbf2fd0 231 $delim = sqimap_get_delimiter($imapConnection);
be2d5495 232 $optvals[SMOPT_GRP_FOLDERSELECT][] = array(
233 'name' => 'mailbox_select_style',
234 'caption' => _("Selection List Style"),
235 'type' => SMOPT_TYPE_STRLIST,
236 'refresh' => SMOPT_REFRESH_NONE,
28df812d 237 'posvals' => array( 0 => _("Long: ") . '"' . _("Folder") . $delim . _("Subfolder") . '"',
238 1 => _("Indented: ") . '"&nbsp;&nbsp;&nbsp;&nbsp;' . _("Subfolder") . '"',
239 2 => _("Delimited: ") . '".&nbsp;' . _("Subfolder") . '"')
be2d5495 240 );
241
cbe5423b 242 /* Assemble all this together and return it as our result. */
243 $result = array(
244 'grps' => $optgrps,
245 'vals' => $optvals
246 );
ebbf2fd0 247 sqimap_logout($imapConnection);
cbe5423b 248 return ($result);
249}
250
251/******************************************************************/
252/** Define any specialized save functions for this option page. ***/
253/******************************************************************/
48af4b64 254
255/**
256 * Saves the trash folder option.
257 */
cbe5423b 258function save_option_trash_folder($option) {
259 global $data_dir, $username;
260
261 /* Set move to trash on or off. */
262 $trash_on = ($option->new_value == SMPREF_NONE ? SMPREF_OFF : SMPREF_ON);
263 setPref($data_dir, $username, 'move_to_trash', $trash_on);
a440e68f 264
cbe5423b 265 /* Now just save the option as normal. */
266 save_option($option);
267}
2016e645 268
48af4b64 269/**
270 * Saves the sent folder option.
271 */
cbe5423b 272function save_option_sent_folder($option) {
273 global $data_dir, $username;
e7db48af 274
cbe5423b 275 /* Set move to sent on or off. */
276 $sent_on = ($option->new_value == SMPREF_NONE ? SMPREF_OFF : SMPREF_ON);
277 setPref($data_dir, $username, 'move_to_sent', $sent_on);
e7db48af 278
cbe5423b 279 /* Now just save the option as normal. */
280 save_option($option);
281}
e7db48af 282
48af4b64 283/**
284 * Saves the draft folder option.
285 */
cbe5423b 286function save_option_draft_folder($option) {
287 global $data_dir, $username;
288
289 /* Set move to draft on or off. */
290 $draft_on = ($option->new_value == SMPREF_NONE ? SMPREF_OFF : SMPREF_ON);
291 setPref($data_dir, $username, 'save_as_draft', $draft_on);
292
293 /* Now just save the option as normal. */
294 save_option($option);
295}
296
297?>