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
);
108 /* Get some imap data we need later. */
109 $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
110 $boxes = sqimap_mailbox_list($imapConnection);
111 sqimap_logout($imapConnection);
113 /* Load the Sent Subfolder Options into an array. */
114 $optgrp = _("Sent Subfolders Options");
118 'name' => 'sent_subfolders_setting',
119 'caption' => _("Use Sent Subfolders"),
120 'type' => SMOPT_TYPE_STRLIST
,
121 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
122 'posvals' => array(SMPREF_SENT_SUBFOLDERS_DISABLED
=> _("Disabled"),
123 SMPREF_SENT_SUBFOLDERS_MONTHLY
=> _("Monthly"),
124 SMPREF_SENT_SUBFOLDERS_QUARTERLY
=> _("Quarterly"),
125 SMPREF_SENT_SUBFOLDERS_YEARLY
=> _("Yearly")),
126 'save' => 'save_option_sent_subfolders_setting'
129 $filtered_folders=array_filter($boxes, "filter_folders");
130 $sent_subfolders_base_values = array('whatever'=>$filtered_folders);
133 'name' => 'sent_subfolders_base',
134 'caption' => _("Base Sent Folder"),
135 'type' => SMOPT_TYPE_FLDRLIST
,
136 'refresh' => SMOPT_REFRESH_FOLDERLIST
,
137 'posvals' => $sent_subfolders_base_values,
138 'folder_filter' => 'noinferiors'
141 if ($show_contain_subfolders_option) {
143 'name' => 'sent_subfolders_warning',
144 'caption' => _("Warning"),
145 'type' => SMOPT_TYPE_COMMENT
,
146 'comment' => _("There are some restrictions in Sent Subfolder options.")
150 /* Add our option data to the global array. */
151 $optpage_data['grps'][SMOPT_GRP_SENT_SUBFOLDERS
] = $optgrp;
152 $optpage_data['vals'][SMOPT_GRP_SENT_SUBFOLDERS
] = $optvals;
156 * Defines folder filtering rules
158 * Callback function that should exclude some folders from folder listing.
159 * @param array $fldr list of folders. See sqimap_mailbox_list
160 * @return boolean returns true, if folder has to included in folder listing
163 function filter_folders($fldr) {
164 return strtolower($fldr['unformatted'])!='inbox';
168 * Saves sent_subfolder_options
170 function save_option_sent_subfolders_setting($option) {
171 global $data_dir, $username, $use_sent_subfolders;
173 /* Set use_sent_subfolders as either on or off. */
174 if ($option->new_value
== SMPREF_SENT_SUBFOLDERS_DISABLED
) {
175 setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF
);
177 setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_ON
);
178 setPref($data_dir, $username, 'move_to_sent', SMPREF_ON
);
181 /* Now just save the option as normal. */
182 save_option($option);
186 * Update sent_subfolders settings
188 * function updates default sent folder value and
189 * creates required imap folders
191 function sent_subfolders_update_sentfolder() {
193 global $sent_subfolders_base, $sent_subfolders_setting;
194 global $data_dir, $imapServerAddress, $imapPort, $color;
195 global $use_sent_subfolders, $move_to_sent;
197 sqgetGlobalVar('username', $username, SQ_SESSION
);
198 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
200 if ($use_sent_subfolders ||
$move_to_sent) {
203 $quarter = sent_subfolder_getQuarter($month);
206 * Regarding the structure we've got three main possibilities.
207 * One sent holder. level 0.
208 * Multiple year holders with messages in it. level 1.
209 * Multiple year folders with holders in it. level 2.
211 $cnd_delimiter = $delimiter;
213 switch ($sent_subfolders_setting) {
214 case SMPREF_SENT_SUBFOLDERS_YEARLY
:
216 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
219 case SMPREF_SENT_SUBFOLDERS_QUARTERLY
:
221 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
223 . $delimiter . $quarter;
224 $year_folder = $sent_subfolders_base . $cnd_delimiter
227 case SMPREF_SENT_SUBFOLDERS_MONTHLY
:
229 $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
231 . $delimiter . $month;
232 $year_folder = $sent_subfolders_base. $cnd_delimiter . $year;
234 case SMPREF_SENT_SUBFOLDERS_DISABLED
:
237 $sent_subfolder = $sent_folder;
238 $year_folder = $sent_folder;
241 /* If this folder is NOT the current sent folder, update stuff. */
242 if ($sent_subfolder != $sent_folder) {
243 /* Auto-create folders, if they do not yet exist. */
244 if ($sent_subfolder != 'none') {
245 /* Create the imap connection. */
246 $ic = sqimap_login($username, false, $imapServerAddress, $imapPort, 10);
250 * If sent_subfolder can't store messages (noselect) ||
251 * year_folder can't store subfolders (noinferiors) in level=2 setup ||
252 * subfolder_base can't store subfolders (noinferiors), setup is broken
254 if (sqimap_mailbox_is_noselect($ic,$sent_subfolder,$boxes) ||
255 ($level==2 && sqimap_mailbox_is_noinferiors($ic,$year_folder,$boxes)) ||
256 sqimap_mailbox_is_noinferiors($ic,$sent_subfolders_base,$boxes)) {
257 error_box(_("Sent Subfolders plugin is misconfigured."));
260 /* Auto-create the year folder, if it does not yet exist. */
261 if (!sqimap_mailbox_exists($ic, $year_folder)) {
262 sqimap_mailbox_create($ic, $year_folder, 'noselect');
263 // TODO: safety check for imap servers that can't create subfolders
265 } else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) {
266 sqimap_subscribe($ic, $year_folder);
270 /* Auto-create the subfolder, if it does not yet exist. */
271 if (!sqimap_mailbox_exists($ic, $sent_subfolder)) {
272 sqimap_mailbox_create($ic, $sent_subfolder, '');
273 } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
274 sqimap_subscribe($ic, $sent_subfolder);
276 /* Update sent_folder setting. */
277 setPref($data_dir, $username, 'sent_folder', $sent_subfolder);
278 setPref($data_dir, $username, 'move_to_sent', SMPREF_ON
);
279 $sent_folder = $sent_subfolder;
280 $move_to_sent = SMPREF_ON
;
282 /* Close the imap connection. */
291 * Sets quarter subfolder names
293 * @param string $month numeric month
294 * @return string quarter name (Q + number)
296 function sent_subfolder_getQuarter($month) {
322 /* Return the current quarter. */
323 return ('Q' . $result);
327 * detects if mailbox is part of sent_subfolders
329 * @param string $mb imap folder name
330 * @return boolean 1 - is part of sent_subfolders, 0 - is not part of sent_subfolders
332 function sent_subfolders_special_mailbox($mb) {
333 global $data_dir, $username, $delimiter;
335 $use_sent_subfolders = getPref
336 ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF
);
337 $sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', 'na');
340 * If sent_subfolders are used and mailbox is equal to subfolder base
341 * or mailbox matches subfolder base + delimiter.
343 if ($use_sent_subfolders == SMPREF_ON
&&
344 ($mb == $sent_subfolders_base ||
stristr($mb,$sent_subfolders_base . $delimiter) ) ) {