diff options
Diffstat (limited to 'plugins/sieverules/config.inc.php.dist')
| -rw-r--r-- | plugins/sieverules/config.inc.php.dist | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/plugins/sieverules/config.inc.php.dist b/plugins/sieverules/config.inc.php.dist new file mode 100644 index 000000000..7d8f48238 --- /dev/null +++ b/plugins/sieverules/config.inc.php.dist @@ -0,0 +1,147 @@ +<?php + +/** + * SieveRules configuration file + */ + +// managesieve server address +// The host can contain the following macros that will be expanded as follows: +// %n - hostname ($_SERVER['SERVER_NAME']) +// %t - hostname without the first part +// %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part) +// %s - domain name after the '@' from e-mail address provided at login screen +// For example %n = mail.domain.tld, %t = domain.tld +$rcmail_config['sieverules_host'] = 'localhost'; + +// managesieve server port +$rcmail_config['sieverules_port'] = 2000; + +// Log managesieve conversation to <log_dir>/sieverules or to syslog +$rcmail_config['sieverules_debug'] = false; + +// authentication method. Can be CRAM-MD5, DIGEST-MD5, PLAIN, LOGIN, EXTERNAL +// or none. Optional, defaults to best method supported by server. +$rcmail_config['sieverules_auth_type'] = null; + +// optional managesieve authentication identifier to be used as authorization proxy, +// authenticate as a different user but act on behalf of the logged in user, +// works with PLAIN and DIGEST-MD5 auth. +$rcmail_config['sieverules_auth_cid'] = null; + +// optional managesieve authentication password to be used for sieverules_auth_cid +$rcmail_config['sieverules_auth_pw'] = null; + +// enable TLS for managesieve server connection +$rcmail_config['sieverules_usetls'] = FALSE; + +// folder delimiter - if your sieve system uses a different folder delimiter to +// your IMAP server set it here, otherwise leave as null to use IMAP delimiter +$rcmail_config['sieverules_folder_delimiter'] = null; + +// Sieve RFC says that we should use UTF-8 encoding for mailbox names, +// but some implementations does not covert UTF-8 to modified UTF-7. +// set to null for default behaviour +$rcmail_config['sieverules_folder_encoding'] = null; + +// include the IMAP root in the folder path when creating the rules +// set to false to never include the IMAP root in the folder path +// set to null for default behaviour +$rcmail_config['sieverules_include_imap_root'] = null; + +// ruleset name +$rcmail_config['sieverules_ruleset_name'] = 'roundcube'; + +// allow multiple actions +$rcmail_config['sieverules_multiple_actions'] = TRUE; + +// allowed actions +$rcmail_config['sieverules_allowed_actions'] = array( + 'fileinto' => TRUE, + 'vacation' => TRUE, + 'reject' => TRUE, + 'redirect' => TRUE, + 'keep' => TRUE, + 'discard' => TRUE, + 'imapflags' => TRUE, + 'notify' => TRUE, + 'stop' => TRUE, + 'editheaderadd' => TRUE, + 'editheaderrem' => TRUE + ); + +// headers listed as examples of "Other headers" +$rcmail_config['sieverules_other_headers'] = array( + 'Reply-To', 'List-Id', 'MailingList', 'Mailing-List', + 'X-ML-Name', 'X-List', 'X-List-Name', 'X-Mailing-List', + 'Resent-From', 'Resent-To', 'X-Mailer', 'X-MailingList', + 'X-Spam-Status', 'X-Priority', 'Importance', 'X-MSMail-Priority', + 'Precedence', 'Return-Path', 'Received', 'Auto-Submitted', + 'X-Spam-Flag', 'X-Spam-Tests', 'Sender', + ); + +// Predefined rules +// each rule should be in it own array - examples provided in README +// 'name' => name of the rule, displayed in the rule type select box +// 'type' => one of: header, address, envelope, size +// 'header' => name of the header to test +// 'operator' => operator to use, for all possible values please see README +// 'extra' => extra information needed for the rule in some cases +// 'target' => value that the header is tested against +$rcmail_config['sieverules_predefined_rules'] = array(); + +// Advanced editor +// allows the user to edit the sieve file directly, without the restrictions of the normal UI +// 0 - Disabled, option not shown in the UI +// 1 - Enabled, option shown in the UI +// 2 - Option shown in the UI and used by default +$rcmail_config['sieverules_adveditor'] = 0; + +// Allow users to use multiple rulesets +$rcmail_config['sieverules_multiplerules'] = FALSE; + +// Default (or global) sieve rule file +$rcmail_config['sieverules_default_file'] = '/etc/dovecot/sieve/default'; + +// Auto load default sieve rule file if no rules exist and no import filters match +$rcmail_config['sieverules_auto_load_default'] = FALSE; + +// Example sieve rule file +$rcmail_config['sieverules_example_file'] = '/etc/dovecot/sieve/example'; + +// Force the :addresses line to always be added to new vacation rules +// Some sieve setups require that the :address part of a vacation rule is always present for the message to be sent +// Cyrus setups need this to option set to true +$rcmail_config['sieverules_force_vacto'] = FALSE; + +// Limit the selection of :addresses available to only those setup in as an identity +// Setting this to false will give the user a textbox to enter in any address(es) they like, rather than a list of checkboxes +$rcmail_config['sieverules_limit_vacto'] = TRUE; + +// Allow users to set the :from option when creating new vacation rules, not all servers support this option +// If your server supports the variables extension users also have an 'auto detect' option which will detect the address to which the message was sent +// Else the user's default identity will be used as the default value +$rcmail_config['sieverules_show_vacfrom'] = FALSE; + +// Allow users to set the :handle option when creating new vacation rules, not all servers support this option +$rcmail_config['sieverules_show_vachandle'] = FALSE; + +// The rule file can be written as one IF/ELSIF statement or as a series of unrelated IF statements +// TRUE - one IF/ELSIF statement (default) +// FALSE - a series of unrelated IF statements +$rcmail_config['sieverules_use_elsif'] = TRUE; + +// Fileinto action options +// 0 - List only subscribed folders +// 1 - List subscribed and unsubscribed folders +// 2 - List subscribed and unsubscribed folders and allow users to enter a folder name (for advanced users only, requires sieve mailbox extension) +$rcmail_config['sieverules_fileinto_options'] = 0; + +// Define the format of the :from option value for vacation and notify actions +// 0 - Use only the email address - :from "user@example.com" +// 1 - Use the name and email address, not all servers support this option - :from "First Last <user@example.com>" +$rcmail_config['sieverules_from_format'] = 0; + +// For information on customising the rule file see "The structure of the rule file" in the README +// For information on customising the contents of the drop downs see "Default values for header, operator and flag drop downs" in the README + +?>
\ No newline at end of file |