/**
* setup.php -- Sent Subfolders Setup File
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * This is a standard SquirrelMail 1.2 API for plugins.
*
- * This is a standard Squirrelmail-1.2 API for plugins.
- *
- * $Id$
+ * @copyright 1999-2012 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package plugins
+ * @subpackage sent_subfolders
*/
-define('SMPREF_SENT_SUBFOLDERS_DISABLED', 0);
-define('SMPREF_SENT_SUBFOLDERS_YEARLY', 1);
-define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2);
-define('SMPREF_SENT_SUBFOLDERS_MONTHLY', 3);
-define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS');
-
+/**
+ * Adds plugin to SquirrelMail's hooks
+ */
function squirrelmail_plugin_init_sent_subfolders() {
/* Standard initialization API. */
global $squirrelmail_plugin_hooks;
/* The hooks to make the sent subfolders display correctly. */
- $squirrelmail_plugin_hooks
- ['check_handleAsSent_result']['sent_subfolders'] =
- 'sent_subfolders_check_handleAsSent';
+ $squirrelmail_plugin_hooks['check_handleAsSent_result']['sent_subfolders']
+ = 'sent_subfolders_check_handleAsSent';
/* The hooks to automatically update sent subfolders. */
- $squirrelmail_plugin_hooks
- ['left_main_before']['sent_subfolders'] =
- 'sent_subfolders_update_sentfolder';
-
- $squirrelmail_plugin_hooks
- ['compose_send']['sent_subfolders'] =
- 'sent_subfolders_update_sentfolder';
-
- /* The hook to load the sent subfolders prefs. */
- $squirrelmail_plugin_hooks
- ['loading_prefs']['sent_subfolders'] =
- 'sent_subfolders_load_prefs';
+// hook isn't in 1.5.x; isn't absolutely necessary to run on the folder list anyway
+// $squirrelmail_plugin_hooks['left_main_before']['sent_subfolders']
+// = 'sent_subfolders_update_sentfolder';
+ $squirrelmail_plugin_hooks['compose_send']['sent_subfolders']
+ = 'sent_subfolders_update_sentfolder';
/* The hooks to handle sent subfolders options. */
- $squirrelmail_plugin_hooks
- ['optpage_loadhook_folder']['sent_subfolders'] =
- 'sent_subfolders_optpage_loadhook_folders';
-}
-
-function sent_subfolders_check_handleAsSent() {
- global $handleAsSent_result, $sent_subfolders_base;
- global $use_sent_subfolders;
- $sent_subfolders_base = 'INBOX.Sent';
- $args = func_get_arg(0);
+ $squirrelmail_plugin_hooks['optpage_loadhook_folder']['sent_subfolders']
+ = 'sent_subfolders_optpage_loadhook_folders';
- /* Only check the folder string if we have been passed a mailbox. */
- if ($use_sent_subfolders && (count($args) > 1)) {
- /* Chop up the folder strings as needed. */
- $base_str = $sent_subfolders_base . $delimiter;
- $mbox_str = substr($args[1], 0, strlen($base_str));
-
- /* Perform the comparison. */
- $handleAsSent_result =
- ( $handleAsSent_result
- || ($base_str == $mbox_str)
- || ($sent_subfolders_base == $args[1])
- );
- }
+ /* mark base sent folder as special mailbox */
+ $squirrelmail_plugin_hooks['special_mailbox']['sent_subfolders']
+ = 'sent_subfolders_special_mailbox';
}
-function sent_subfolders_load_prefs() {
- global $use_sent_subfolders;
- global $sent_subfolders_setting, $sent_subfolders_base;
-
- $use_sent_subfolders = getPref
- ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
-
- $sent_subfolders_setting = getPref
- ($data_dir, $username, 'sent_subfolders_setting', SMPREF_SENT_SUBFOLDERS_DISABLED);
-
- $sent_subfolders_base = getPref
- ($data_dir, $username, 'sent_subfolders_base', SMPREF_NONE);
+function sent_subfolders_check_handleAsSent($mailbox) {
+ include_once(SM_PATH . 'plugins/sent_subfolders/functions.php');
+ sent_subfolders_check_handleAsSent_do($mailbox);
}
+/**
+ * Adds sent_subfolders options in folder preferences
+ */
function sent_subfolders_optpage_loadhook_folders() {
- global $optpage_data, $username, $key, $imapServerAddress, $imapPort;
-
- /* Get some imap data we need later. */
- $imapConnection =
- sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
- $boxes = sqimap_mailbox_list($imapConnection);
- sqimap_logout($imapConnection);
-
- /* Load the Sent Subfolder Options into an array. */
- $optgrp = _("Sent Subfolders Options");
- $optvals = array();
-
- $optvals[] = array(
- 'name' => 'sent_subfolders_setting',
- 'caption' => _("Use Sent Subfolders"),
- 'type' => SMOPT_TYPE_STRLIST,
- 'refresh' => SMOPT_REFRESH_FOLDERLIST,
- 'posvals' => array(SMPREF_SENT_SUBFOLDERS_DISABLED => _("Disabled"),
- SMPREF_SENT_SUBFOLDERS_MONTHLY => _("Monthly"),
- SMPREF_SENT_SUBFOLDERS_QUARTERLY => _("Quarterly"),
- SMPREF_SENT_SUBFOLDERS_YEARLY => _("Yearly")),
- 'save' => 'save_option_sent_subfolders_setting'
- );
-
- $sent_subfolders_base_values = array();
- foreach ($boxes as $folder) {
- if (strtolower($folder['unformatted']) != 'inbox') {
- $real_value = $folder['unformatted-dm'];
- $disp_value = str_replace(' ', ' ', $folder['formatted']);
- $sent_subfolders_base_values[$real_value] = $disp_value;
- }
- }
-
- $optvals[] = array(
- 'name' => 'sent_subfolders_base',
- 'caption' => _("Base Sent Folder"),
- 'type' => SMOPT_TYPE_STRLIST,
- 'refresh' => SMOPT_REFRESH_FOLDERLIST,
- 'posvals' => $sent_subfolders_base_values
- );
-
- /* Add our option data to the global array. */
- $optpage_data['grps'][SMOPT_GRP_SENT_SUBFOLDERS] = $optgrp;
- $optpage_data['vals'][SMOPT_GRP_SENT_SUBFOLDERS] = $optvals;
-}
-
-function save_option_sent_subfolders_setting($option) {
- global $data_dir, $username, $use_sent_subfolders;
-
- /* Set use_sent_subfolders as either on or off. */
- if ($option->new_value == SMPREF_SENT_SUBFOLDERS_DISABLED) {
- setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
- } else {
- setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_ON);
- setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
- }
-
- /* Now just save the option as normal. */
- save_option($option);
+ include_once(SM_PATH . 'plugins/sent_subfolders/functions.php');
+ sent_subfolders_optpage_loadhook_folders_do();
}
+/**
+ * Update sent_subfolders settings
+ *
+ * function updates default sent folder value and
+ * creates required imap folders
+ */
function sent_subfolders_update_sentfolder() {
- global $sent_folder, $delimiter, $auto_create_special, $auto_create_done;
- global $sent_subfolders_base, $sent_subfolders_setting;
- global $username, $data_dir, $key, $imapServerAddress, $imapPort;
- global $use_sent_subfolders, $move_to_sent;
-
- if ($use_sent_subfolders || $move_to_sent) {
- $year = date('Y');
- $month = date('m');
- $quarter = sent_subfolder_getQuarter($month);
-
- /*
- Regarding the structure we've got three main possibilities.
- One sent holder. level 0.
- Multiple year holders with messages in it. level 1.
- Multiple year folders with holders in it. level 2.
- */
- switch ($sent_subfolders_setting) {
- case SMPREF_SENT_SUBFOLDERS_YEARLY:
- $level = 1;
- $sent_subfolder = $sent_subfolders_base
- . $year;
- $year_folder = $sent_subfolder;
- break;
- case SMPREF_SENT_SUBFOLDERS_QUARTERLY:
- $level = 2;
- $sent_subfolder = $sent_subfolders_base
- . $year
- . $delimiter . $quarter;
- $year_folder = $sent_subfolders_base
- . $year;
- break;
- case SMPREF_SENT_SUBFOLDERS_MONTHLY:
- $level = 2;
- $sent_subfolder = $sent_subfolders_base
- . $year
- . $delimiter . $month;
- $year_folder = $sent_subfolders_base . $year;
- break;
- case SMPREF_SENT_SUBFOLDERS_DISABLED:
- default:
- $level = 0;
- $sent_subfolder = $sent_folder;
- $year_folder = $sent_folder;
- }
-
- /* If this folder is NOT the current sent folder, update stuff. */
- if ($sent_subfolder != $sent_folder) {
- /* First, update the sent folder. */
-
- setPref($data_dir, $username, 'sent_folder', $sent_subfolder);
- setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
- $sent_folder = $sent_subfolder;
- $move_to_sent = SMPREF_ON;
-
- /* Auto-create folders, if they do not yet exist. */
- if ($sent_folder != 'none') {
- /* Create the imap connection. */
- $ic = sqimap_login
- ($username, $key, $imapServerAddress, $imapPort, 10);
-
- /* Auto-create the year folder, if it does not yet exist. */
- if (!sqimap_mailbox_exists($ic, $year_folder)) {
- sqimap_mailbox_create($ic, $year_folder, ($level==1)?'':'noselect');
- } else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) {
- sqimap_subscribe($ic, $year_folder);
- }
-
- /* Auto-create the subfolder, if it does not yet exist. */
- if (!sqimap_mailbox_exists($ic, $sent_folder)) {
- sqimap_mailbox_create($ic, $sent_folder, '');
- } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
- sqimap_subscribe($ic, $sent_subfolder);
- }
-
- /* Close the imap connection. */
- sqimap_logout($ic);
- }
- }
- }
+ include_once(SM_PATH . 'plugins/sent_subfolders/functions.php');
+ sent_subfolders_update_sentfolder_do();
}
-function sent_subfolder_getQuarter($month) {
- switch ($month) {
- case '01':
- case '02':
- case '03':
- $result = '1';
- break;
- case '04':
- case '05':
- case '06':
- $result = '2';
- break;
- case '07':
- case '08':
- case '09':
- $result = '3';
- break;
- case '10':
- case '11':
- case '12':
- $result = '4';
- break;
- default:
- $result = 'ERR';
- }
-
- /* Return the current quarter. */
- return ('Q' . $result);
+/**
+ * detects if mailbox is part of sent_subfolders
+ *
+ * @param string $mb imap folder name
+ * @return boolean 1 - is part of sent_subfolders, 0 - is not part of sent_subfolders
+ */
+function sent_subfolders_special_mailbox($mb) {
+ include_once(SM_PATH . 'plugins/sent_subfolders/functions.php');
+ return sent_subfolders_special_mailbox_do($mb);
}
-
-?>