4 * setup.php -- Sent Subfolders Setup File
6 * This is a standard SquirrelMail 1.2 API for plugins.
8 * @copyright © 1999-2006 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
12 * @subpackage sent_subfolders
17 define('SMPREF_SENT_SUBFOLDERS_DISABLED', 0);
18 define('SMPREF_SENT_SUBFOLDERS_YEARLY', 1);
19 define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2);
20 define('SMPREF_SENT_SUBFOLDERS_MONTHLY', 3);
21 define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS');
24 * Adds plugin to SquirrelMail's hooks
26 function squirrelmail_plugin_init_sent_subfolders() {
27 /* Standard initialization API. */
28 global $squirrelmail_plugin_hooks;
30 /* The hooks to make the sent subfolders display correctly. */
31 $squirrelmail_plugin_hooks
32 ['check_handleAsSent_result']['sent_subfolders'] =
33 'sent_subfolders_check_handleAsSent';
35 /* The hooks to automatically update sent subfolders. */
36 $squirrelmail_plugin_hooks
37 ['left_main_before']['sent_subfolders'] =
38 'sent_subfolders_update_sentfolder';
40 $squirrelmail_plugin_hooks
41 ['compose_send']['sent_subfolders'] =
42 'sent_subfolders_update_sentfolder';
44 /* The hook to load the sent subfolders prefs. */
45 $squirrelmail_plugin_hooks
46 ['loading_prefs']['sent_subfolders'] =
47 'sent_subfolders_load_prefs';
49 /* The hooks to handle sent subfolders options. */
50 $squirrelmail_plugin_hooks
51 ['optpage_loadhook_folder']['sent_subfolders'] =
52 'sent_subfolders_optpage_loadhook_folders';
54 /* mark base sent folder as special mailbox */
55 $squirrelmail_plugin_hooks
56 ['special_mailbox']['sent_subfolders'] =
57 'sent_subfolders_special_mailbox';
60 function sent_subfolders_check_handleAsSent() {
61 global $handleAsSent_result, $sent_subfolders_base,
64 $sent_subfolders_base = 'INBOX.Sent';
65 $args = func_get_arg(0);
66 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
68 /* Only check the folder string if we have been passed a mailbox. */
69 if ($use_sent_subfolders && (count($args) > 1)) {
70 /* Chop up the folder strings as needed. */
71 $base_str = $sent_subfolders_base . $delimiter;
72 $mbox_str = substr($args[1], 0, strlen($base_str));
74 /* Perform the comparison. */
75 $handleAsSent_result =
76 ( $handleAsSent_result
77 ||
($base_str == $mbox_str)
78 ||
($sent_subfolders_base == $args[1])
84 * Loads sent_subfolders settings
86 function sent_subfolders_load_prefs() {
87 global $use_sent_subfolders, $data_dir, $username,
88 $sent_subfolders_setting, $sent_subfolders_base;
90 $use_sent_subfolders = getPref
91 ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF
);
93 $sent_subfolders_setting = getPref
94 ($data_dir, $username, 'sent_subfolders_setting', SMPREF_SENT_SUBFOLDERS_DISABLED
);
96 $sent_subfolders_base = getPref
97 ($data_dir, $username, 'sent_subfolders_base', SMPREF_NONE
);
101 * Adds sent_subfolders options in folder preferences
103 function sent_subfolders_optpage_loadhook_folders() {
104 global $optpage_data, $imapServerAddress, $imapPort, $show_contain_subfolders_option;
106 sqgetGlobalVar('username', $username, SQ_SESSION
);
107 sqgetGlobalVar('key', $key, SQ_COOKIE
);
109 /* Get some imap data we need later. */
111 sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
112 $boxes = sqimap_mailbox_list($imapConnection);
113 sqimap_logout($imapConnection);
115 /* Load the Sent Subfolder Options into an array. */
116 $optgrp = _("Sent Subfolders Options");
120 'name' => 'sent_subfolders_setting',
121 'caption' => _("Use Sent Subfolders"),
122 'type' => SMOPT_TYPE_STRLIST
,
123 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
124 'posvals' => array(SMPREF_SENT_SUBFOLDERS_DISABLED
=> _("Disabled"),
125 SMPREF_SENT_SUBFOLDERS_MONTHLY
=> _("Monthly"),
126 SMPREF_SENT_SUBFOLDERS_QUARTERLY
=> _("Quarterly"),
127 SMPREF_SENT_SUBFOLDERS_YEARLY
=> _("Yearly")),
128 'save' => 'save_option_sent_subfolders_setting'
131 $filtered_folders=array_filter($boxes, "filter_folders");
132 $sent_subfolders_base_values = array('whatever'=>$filtered_folders);
135 'name' => 'sent_subfolders_base',
136 'caption' => _("Base Sent Folder"),
137 'type' => SMOPT_TYPE_FLDRLIST
,
138 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
139 'posvals' => $sent_subfolders_base_values,
140 'folder_filter' => 'noinferiors'
143 if ($show_contain_subfolders_option) {
145 'name' => 'sent_subfolders_warning',
146 'caption' => _("Warning"),
147 'type' => SMOPT_TYPE_COMMENT
,
148 'comment' => _("There are some restrictions in Sent Subfolder options.")
152 /* Add our option data to the global array. */
153 $optpage_data['grps'][SMOPT_GRP_SENT_SUBFOLDERS
] = $optgrp;
154 $optpage_data['vals'][SMOPT_GRP_SENT_SUBFOLDERS
] = $optvals;
158 * Defines folder filtering rules
160 * Callback function that should exclude some folders from folder listing.
161 * @param array $fldr list of folders. See sqimap_mailbox_list
162 * @return boolean returns true, if folder has to included in folder listing
165 function filter_folders($fldr) {
166 return strtolower($fldr['unformatted'])!='inbox';
170 * Saves sent_subfolder_options
172 function save_option_sent_subfolders_setting($option) {
173 global $data_dir, $username, $use_sent_subfolders;
175 /* Set use_sent_subfolders as either on or off. */
176 if ($option->new_value
== SMPREF_SENT_SUBFOLDERS_DISABLED
) {
177 setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF
);
179 setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_ON
);
180 setPref($data_dir, $username, 'move_to_sent', SMPREF_ON
);
183 /* Now just save the option as normal. */
184 save_option($option);
188 * Update sent_subfolders settings
190 * function updates default sent folder value and
191 * creates required imap folders
193 function sent_subfolders_update_sentfolder() {
195 global $sent_subfolders_base, $sent_subfolders_setting;
196 global $data_dir, $imapServerAddress, $imapPort, $color;
197 global $use_sent_subfolders, $move_to_sent;
199 sqgetGlobalVar('username', $username, SQ_SESSION
);
200 sqgetGlobalVar('key', $key, SQ_COOKIE
);
201 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
203 if ($use_sent_subfolders ||
$move_to_sent) {
206 $quarter = sent_subfolder_getQuarter($month);
209 * Regarding the structure we've got three main possibilities.
210 * One sent holder. level 0.
211 * Multiple year holders with messages in it. level 1.
212 * Multiple year folders with holders in it. level 2.
214 $cnd_delimiter = $delimiter;
216 switch ($sent_subfolders_setting) {
217 case SMPREF_SENT_SUBFOLDERS_YEARLY
:
219 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
222 case SMPREF_SENT_SUBFOLDERS_QUARTERLY
:
224 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
226 . $delimiter . $quarter;
227 $year_folder = $sent_subfolders_base . $cnd_delimiter
230 case SMPREF_SENT_SUBFOLDERS_MONTHLY
:
232 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
234 . $delimiter . $month;
235 $year_folder = $sent_subfolders_base. $cnd_delimiter . $year;
237 case SMPREF_SENT_SUBFOLDERS_DISABLED
:
240 $sent_subfolder = $sent_folder;
241 $year_folder = $sent_folder;
244 /* If this folder is NOT the current sent folder, update stuff. */
245 if ($sent_subfolder != $sent_folder) {
246 /* Auto-create folders, if they do not yet exist. */
247 if ($sent_subfolder != 'none') {
248 /* Create the imap connection. */
249 $ic = sqimap_login($username, $key, $imapServerAddress, $imapPort, 10);
253 * If sent_subfolder can't store messages (noselect) ||
254 * year_folder can't store subfolders (noinferiors) in level=2 setup ||
255 * subfolder_base can't store subfolders (noinferiors), setup is broken
257 if (sqimap_mailbox_is_noselect($ic,$sent_subfolder,$boxes) ||
258 ($level==2 && sqimap_mailbox_is_noinferiors($ic,$year_folder,$boxes)) ||
259 sqimap_mailbox_is_noinferiors($ic,$sent_subfolders_base,$boxes)) {
260 error_box(_("Sent Subfolders plugin is misconfigured."),$color);
263 /* Auto-create the year folder, if it does not yet exist. */
264 if (!sqimap_mailbox_exists($ic, $year_folder)) {
265 sqimap_mailbox_create($ic, $year_folder, 'noselect');
266 // TODO: safety check for imap servers that can't create subfolders
268 } else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) {
269 sqimap_subscribe($ic, $year_folder);
273 /* Auto-create the subfolder, if it does not yet exist. */
274 if (!sqimap_mailbox_exists($ic, $sent_subfolder)) {
275 sqimap_mailbox_create($ic, $sent_subfolder, '');
276 } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
277 sqimap_subscribe($ic, $sent_subfolder);
279 /* Update sent_folder setting. */
280 setPref($data_dir, $username, 'sent_folder', $sent_subfolder);
281 setPref($data_dir, $username, 'move_to_sent', SMPREF_ON
);
282 $sent_folder = $sent_subfolder;
283 $move_to_sent = SMPREF_ON
;
285 /* Close the imap connection. */
294 * Sets quarter subfolder names
296 * @param string $month numeric month
297 * @return string quarter name (Q + number)
299 function sent_subfolder_getQuarter($month) {
325 /* Return the current quarter. */
326 return ('Q' . $result);
330 * detects if mailbox is part of sent_subfolders
332 * @param string $mb imap folder name
333 * @return boolean 1 - is part of sent_subfolders, 0 - is not part of sent_subfolders
335 function sent_subfolders_special_mailbox($mb) {
336 global $data_dir, $username, $delimiter;
338 $use_sent_subfolders = getPref
339 ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF
);
340 $sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', 'na');
343 * If sent_subfolders are used and mailbox is equal to subfolder base
344 * or mailbox matches subfolder base + delimiter.
346 if ($use_sent_subfolders == SMPREF_ON
&&
347 ($mb == $sent_subfolders_base ||
stristr($mb,$sent_subfolders_base . $delimiter) ) ) {