main.inc.php 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850
  1. <?php
  2. /*
  3. +-----------------------------------------------------------------------+
  4. | Main configuration file |
  5. | |
  6. | This file is part of the Roundcube Webmail client |
  7. | Copyright (C) 2005-2011, The Roundcube Dev Team |
  8. | |
  9. | Licensed under the GNU General Public License version 3 or |
  10. | any later version with exceptions for skins & plugins. |
  11. | See the README file for a full license statement. |
  12. | |
  13. +-----------------------------------------------------------------------+
  14. */
  15. $rcmail_config = array();
  16. // ----------------------------------
  17. // LOGGING/DEBUGGING
  18. // ----------------------------------
  19. // system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
  20. $rcmail_config['debug_level'] = 1;
  21. // log driver: 'syslog' or 'file'.
  22. $rcmail_config['log_driver'] = 'file';
  23. // date format for log entries
  24. // (read http://php.net/manual/en/function.date.php for all format characters)
  25. $rcmail_config['log_date_format'] = 'd-M-Y H:i:s O';
  26. // Syslog ident string to use, if using the 'syslog' log driver.
  27. $rcmail_config['syslog_id'] = 'roundcube';
  28. // Syslog facility to use, if using the 'syslog' log driver.
  29. // For possible values see installer or http://php.net/manual/en/function.openlog.php
  30. $rcmail_config['syslog_facility'] = LOG_USER;
  31. // Log sent messages to <log_dir>/sendmail or to syslog
  32. $rcmail_config['smtp_log'] = true;
  33. // Log successful logins to <log_dir>/userlogins or to syslog
  34. $rcmail_config['log_logins'] = false;
  35. // Log session authentication errors to <log_dir>/session or to syslog
  36. $rcmail_config['log_session'] = false;
  37. // Log SQL queries to <log_dir>/sql or to syslog
  38. $rcmail_config['sql_debug'] = false;
  39. // Log IMAP conversation to <log_dir>/imap or to syslog
  40. $rcmail_config['imap_debug'] = false;
  41. // Log LDAP conversation to <log_dir>/ldap or to syslog
  42. $rcmail_config['ldap_debug'] = false;
  43. // Log SMTP conversation to <log_dir>/smtp or to syslog
  44. $rcmail_config['smtp_debug'] = false;
  45. // ----------------------------------
  46. // IMAP
  47. // ----------------------------------
  48. // the mail host chosen to perform the log-in
  49. // leave blank to show a textbox at login, give a list of hosts
  50. // to display a pulldown menu or set one host as string.
  51. // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
  52. // Supported replacement variables:
  53. // %n - http hostname ($_SERVER['SERVER_NAME'])
  54. // %d - domain (http hostname without the first part)
  55. // %s - domain name after the '@' from e-mail address provided at login screen
  56. // For example %n = mail.domain.tld, %d = domain.tld
  57. $rcmail_config['default_host'] = 'localhost';
  58. // TCP port used for IMAP connections
  59. $rcmail_config['default_port'] = 143;
  60. // IMAP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
  61. // best server supported one)
  62. $rcmail_config['imap_auth_type'] = null;
  63. // If you know your imap's folder delimiter, you can specify it here.
  64. // Otherwise it will be determined automatically
  65. $rcmail_config['imap_delimiter'] = null;
  66. // If IMAP server doesn't support NAMESPACE extension, but you're
  67. // using shared folders or personal root folder is non-empty, you'll need to
  68. // set these options. All can be strings or arrays of strings.
  69. // Folders need to be ended with directory separator, e.g. "INBOX."
  70. // (special directory "~" is an exception to this rule)
  71. // These can be used also to overwrite server's namespaces
  72. $rcmail_config['imap_ns_personal'] = null;
  73. $rcmail_config['imap_ns_other'] = null;
  74. $rcmail_config['imap_ns_shared'] = null;
  75. // By default IMAP capabilities are readed after connection to IMAP server
  76. // In some cases, e.g. when using IMAP proxy, there's a need to refresh the list
  77. // after login. Set to True if you've got this case.
  78. $rcmail_config['imap_force_caps'] = false;
  79. // By default list of subscribed folders is determined using LIST-EXTENDED
  80. // extension if available. Some servers (dovecot 1.x) returns wrong results
  81. // for shared namespaces in this case. http://trac.roundcube.net/ticket/1486225
  82. // Enable this option to force LSUB command usage instead.
  83. $rcmail_config['imap_force_lsub'] = false;
  84. // Some server configurations (e.g. Courier) doesn't list folders in all namespaces
  85. // Enable this option to force listing of folders in all namespaces
  86. $rcmail_config['imap_force_ns'] = false;
  87. // IMAP connection timeout, in seconds. Default: 0 (no limit)
  88. $rcmail_config['imap_timeout'] = 0;
  89. // Optional IMAP authentication identifier to be used as authorization proxy
  90. $rcmail_config['imap_auth_cid'] = null;
  91. // Optional IMAP authentication password to be used for imap_auth_cid
  92. $rcmail_config['imap_auth_pw'] = null;
  93. // Type of IMAP indexes cache. Supported values: 'db', 'apc' and 'memcache'.
  94. $rcmail_config['imap_cache'] = null;
  95. // Enables messages cache. Only 'db' cache is supported.
  96. $rcmail_config['messages_cache'] = false;
  97. // ----------------------------------
  98. // SMTP
  99. // ----------------------------------
  100. // SMTP server host (for sending mails).
  101. // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
  102. // If left blank, the PHP mail() function is used
  103. // Supported replacement variables:
  104. // %h - user's IMAP hostname
  105. // %n - http hostname ($_SERVER['SERVER_NAME'])
  106. // %d - domain (http hostname without the first part)
  107. // %z - IMAP domain (IMAP hostname without the first part)
  108. // For example %n = mail.domain.tld, %d = domain.tld
  109. $rcmail_config['smtp_server'] = '';
  110. // SMTP port (default is 25; use 587 for STARTTLS or 465 for the
  111. // deprecated SSL over SMTP (aka SMTPS))
  112. $rcmail_config['smtp_port'] = 25;
  113. // SMTP username (if required) if you use %u as the username Roundcube
  114. // will use the current username for login
  115. $rcmail_config['smtp_user'] = '';
  116. // SMTP password (if required) if you use %p as the password Roundcube
  117. // will use the current user's password for login
  118. $rcmail_config['smtp_pass'] = '';
  119. // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
  120. // best server supported one)
  121. $rcmail_config['smtp_auth_type'] = '';
  122. // Optional SMTP authentication identifier to be used as authorization proxy
  123. $rcmail_config['smtp_auth_cid'] = null;
  124. // Optional SMTP authentication password to be used for smtp_auth_cid
  125. $rcmail_config['smtp_auth_pw'] = null;
  126. // SMTP HELO host
  127. // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages
  128. // Leave this blank and you will get the server variable 'server_name' or
  129. // localhost if that isn't defined.
  130. $rcmail_config['smtp_helo_host'] = '';
  131. // SMTP connection timeout, in seconds. Default: 0 (no limit)
  132. $rcmail_config['smtp_timeout'] = 0;
  133. // ----------------------------------
  134. // SYSTEM
  135. // ----------------------------------
  136. include_once("/etc/roundcube/debian-db-roundcube.php");
  137. // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA.
  138. // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING!
  139. $rcmail_config['enable_installer'] = false;
  140. // provide an URL where a user can get support for this Roundcube installation
  141. // PLEASE DO NOT LINK TO THE ROUNDCUBE.NET WEBSITE HERE!
  142. $rcmail_config['support_url'] = '';
  143. // replace Roundcube logo with this image
  144. // specify an URL relative to the document root of this Roundcube installation
  145. $rcmail_config['skin_logo'] = null;
  146. // automatically create a new Roundcube user when log-in the first time.
  147. // a new user will be created once the IMAP login succeeds.
  148. // set to false if only registered users can use this service
  149. $rcmail_config['auto_create_user'] = true;
  150. // use this folder to store log files (must be writeable for apache user)
  151. // This is used by the 'file' log driver.
  152. $rcmail_config['log_dir'] = '/var/log/roundcubemail/';
  153. // use this folder to store temp files (must be writeable for apache user)
  154. $rcmail_config['temp_dir'] = '/tmp';
  155. // lifetime of message cache
  156. // possible units: s, m, h, d, w
  157. $rcmail_config['message_cache_lifetime'] = '10d';
  158. // enforce connections over https
  159. // with this option enabled, all non-secure connections will be redirected.
  160. // set the port for the ssl connection as value of this option if it differs from the default 443
  161. $rcmail_config['force_https'] = false;
  162. // tell PHP that it should work as under secure connection
  163. // even if it doesn't recognize it as secure ($_SERVER['HTTPS'] is not set)
  164. // e.g. when you're running Roundcube behind a https proxy
  165. // this option is mutually exclusive to 'force_https' and only either one of them should be set to true.
  166. $rcmail_config['use_https'] = false;
  167. // Allow browser-autocompletion on login form.
  168. // 0 - disabled, 1 - username and host only, 2 - username, host, password
  169. $rcmail_config['login_autocomplete'] = 0;
  170. // Forces conversion of logins to lower case.
  171. // 0 - disabled, 1 - only domain part, 2 - domain and local part.
  172. // If users authentication is not case-sensitive this must be enabled.
  173. // After enabling it all user records need to be updated, e.g. with query:
  174. // UPDATE users SET username = LOWER(username);
  175. $rcmail_config['login_lc'] = 0;
  176. // Includes should be interpreted as PHP files
  177. $rcmail_config['skin_include_php'] = false;
  178. // display software version on login screen
  179. $rcmail_config['display_version'] = false;
  180. // Session lifetime in minutes
  181. // must be greater than 'keep_alive'/60
  182. $rcmail_config['session_lifetime'] = 10;
  183. // session domain: .example.org
  184. $rcmail_config['session_domain'] = '';
  185. // session name. Default: 'roundcube_sessid'
  186. $rcmail_config['session_name'] = null;
  187. // Backend to use for session storage. Can either be 'db' (default) or 'memcache'
  188. // If set to memcache, a list of servers need to be specified in 'memcache_hosts'
  189. // Make sure the Memcache extension (http://pecl.php.net/package/memcache) version >= 2.0.0 is installed
  190. $rcmail_config['session_storage'] = 'db';
  191. // Use these hosts for accessing memcached
  192. // Define any number of hosts in the form of hostname:port or unix:///path/to/sock.file
  193. $rcmail_config['memcache_hosts'] = null; // e.g. array( 'localhost:11211', '192.168.1.12:11211', 'unix:///var/tmp/memcached.sock' );
  194. // check client IP in session athorization
  195. $rcmail_config['ip_check'] = false;
  196. // check referer of incoming requests
  197. $rcmail_config['referer_check'] = false;
  198. // X-Frame-Options HTTP header value sent to prevent from Clickjacking.
  199. // Possible values: sameorigin|deny. Set to false in order to disable sending them
  200. $rcmail_config['x_frame_options'] = 'sameorigin';
  201. // this key is used to encrypt the users imap password which is stored
  202. // in the session record (and the client cookie if remember password is enabled).
  203. // please provide a string of exactly 24 chars.
  204. $rcmail_config['des_key'] = 'vtIOjLZo9kffJoqzpSbm5r1r';
  205. // Automatically add this domain to user names for login
  206. // Only for IMAP servers that require full e-mail addresses for login
  207. // Specify an array with 'host' => 'domain' values to support multiple hosts
  208. // Supported replacement variables:
  209. // %h - user's IMAP hostname
  210. // %n - http hostname ($_SERVER['SERVER_NAME'])
  211. // %d - domain (http hostname without the first part)
  212. // %z - IMAP domain (IMAP hostname without the first part)
  213. // For example %n = mail.domain.tld, %d = domain.tld
  214. $rcmail_config['username_domain'] = '';
  215. // This domain will be used to form e-mail addresses of new users
  216. // Specify an array with 'host' => 'domain' values to support multiple hosts
  217. // Supported replacement variables:
  218. // %h - user's IMAP hostname
  219. // %n - http hostname ($_SERVER['SERVER_NAME'])
  220. // %d - domain (http hostname without the first part)
  221. // %z - IMAP domain (IMAP hostname without the first part)
  222. // For example %n = mail.domain.tld, %d = domain.tld
  223. $rcmail_config['mail_domain'] = '';
  224. // Password charset.
  225. // Use it if your authentication backend doesn't support UTF-8.
  226. // Defaults to ISO-8859-1 for backward compatibility
  227. $rcmail_config['password_charset'] = 'ISO-8859-1';
  228. // How many seconds must pass between emails sent by a user
  229. $rcmail_config['sendmail_delay'] = 0;
  230. // Maximum number of recipients per message. Default: 0 (no limit)
  231. $rcmail_config['max_recipients'] = 0;
  232. // Maximum allowednumber of members of an address group. Default: 0 (no limit)
  233. // If 'max_recipients' is set this value should be less or equal
  234. $rcmail_config['max_group_members'] = 0;
  235. // add this user-agent to message headers when sending
  236. $rcmail_config['useragent'] = 'Roundcube Webmail/'.RCMAIL_VERSION;
  237. // use this name to compose page titles
  238. $rcmail_config['product_name'] = 'Roundcube Webmail';
  239. // try to load host-specific configuration
  240. // see http://trac.roundcube.net/wiki/Howto_Config for more details
  241. $rcmail_config['include_host_config'] = false;
  242. // path to a text file which will be added to each sent message
  243. // paths are relative to the Roundcube root folder
  244. $rcmail_config['generic_message_footer'] = '';
  245. // path to a text file which will be added to each sent HTML message
  246. // paths are relative to the Roundcube root folder
  247. $rcmail_config['generic_message_footer_html'] = '';
  248. // add a received header to outgoing mails containing the creators IP and hostname
  249. $rcmail_config['http_received_header'] = false;
  250. // Whether or not to encrypt the IP address and the host name
  251. // these could, in some circles, be considered as sensitive information;
  252. // however, for the administrator, these could be invaluable help
  253. // when tracking down issues.
  254. $rcmail_config['http_received_header_encrypt'] = false;
  255. // This string is used as a delimiter for message headers when sending
  256. // a message via mail() function. Leave empty for auto-detection
  257. $rcmail_config['mail_header_delimiter'] = NULL;
  258. // number of chars allowed for line when wrapping text.
  259. // text wrapping is done when composing/sending messages
  260. $rcmail_config['line_length'] = 72;
  261. // send plaintext messages as format=flowed
  262. $rcmail_config['send_format_flowed'] = true;
  263. // don't allow these settings to be overriden by the user
  264. $rcmail_config['dont_override'] = array();
  265. // Set identities access level:
  266. // 0 - many identities with possibility to edit all params
  267. // 1 - many identities with possibility to edit all params but not email address
  268. // 2 - one identity with possibility to edit all params
  269. // 3 - one identity with possibility to edit all params but not email address
  270. $rcmail_config['identities_level'] = 0;
  271. // Mimetypes supported by the browser.
  272. // attachments of these types will open in a preview window
  273. // either a comma-separated list or an array: 'text/plain,text/html,text/xml,image/jpeg,image/gif,image/png,application/pdf'
  274. $rcmail_config['client_mimetypes'] = null; # null == default
  275. // mime magic database
  276. $rcmail_config['mime_magic'] = null;
  277. // path to imagemagick identify binary
  278. $rcmail_config['im_identify_path'] = null;
  279. // path to imagemagick convert binary
  280. $rcmail_config['im_convert_path'] = null;
  281. // maximum size of uploaded contact photos in pixel
  282. $rcmail_config['contact_photo_size'] = 160;
  283. // Enable DNS checking for e-mail address validation
  284. $rcmail_config['email_dns_check'] = false;
  285. // ----------------------------------
  286. // PLUGINS
  287. // ----------------------------------
  288. // List of active plugins (in plugins/ directory)
  289. $rcmail_config['plugins'] = array('password');
  290. // ----------------------------------
  291. // USER INTERFACE
  292. // ----------------------------------
  293. // default messages sort column. Use empty value for default server's sorting,
  294. // or 'arrival', 'date', 'subject', 'from', 'to', 'fromto', 'size', 'cc'
  295. $rcmail_config['message_sort_col'] = '';
  296. // default messages sort order
  297. $rcmail_config['message_sort_order'] = 'DESC';
  298. // These cols are shown in the message list. Available cols are:
  299. // subject, from, to, fromto, cc, replyto, date, size, status, flag, attachment, 'priority'
  300. $rcmail_config['list_cols'] = array('subject', 'status', 'fromto', 'date', 'size', 'flag', 'attachment');
  301. // the default locale setting (leave empty for auto-detection)
  302. // RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR
  303. $rcmail_config['language'] = null;
  304. // use this format for date display (date or strftime format)
  305. $rcmail_config['date_format'] = 'Y-m-d';
  306. // give this choice of date formats to the user to select from
  307. $rcmail_config['date_formats'] = array('Y-m-d', 'd-m-Y', 'Y/m/d', 'm/d/Y', 'd/m/Y', 'd.m.Y', 'j.n.Y');
  308. // use this format for time display (date or strftime format)
  309. $rcmail_config['time_format'] = 'H:i';
  310. // give this choice of time formats to the user to select from
  311. $rcmail_config['time_formats'] = array('G:i', 'H:i', 'g:i a', 'h:i A');
  312. // use this format for short date display (derived from date_format and time_format)
  313. $rcmail_config['date_short'] = 'D H:i';
  314. // use this format for detailed date/time formatting (derived from date_format and time_format)
  315. $rcmail_config['date_long'] = 'Y-m-d H:i';
  316. // store draft message is this mailbox
  317. // leave blank if draft messages should not be stored
  318. // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
  319. $rcmail_config['drafts_mbox'] = 'Drafts';
  320. // store spam messages in this mailbox
  321. // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
  322. $rcmail_config['junk_mbox'] = 'Spam';
  323. // store sent message is this mailbox
  324. // leave blank if sent messages should not be stored
  325. // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
  326. $rcmail_config['sent_mbox'] = 'Sent';
  327. // move messages to this folder when deleting them
  328. // leave blank if they should be deleted directly
  329. // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
  330. $rcmail_config['trash_mbox'] = 'Trash';
  331. // display these folders separately in the mailbox list.
  332. // these folders will also be displayed with localized names
  333. // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
  334. $rcmail_config['default_folders'] = array('INBOX', 'Drafts', 'Sent', 'Spam', 'Trash');
  335. $rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Spam', 'Trash');
  336. // automatically create the above listed default folders on first login
  337. $rcmail_config['create_default_folders'] = true;
  338. // protect the default folders from renames, deletes, and subscription changes
  339. $rcmail_config['protect_default_folders'] = true;
  340. // if in your system 0 quota means no limit set this option to true
  341. $rcmail_config['quota_zero_as_unlimited'] = false;
  342. // Make use of the built-in spell checker. It is based on GoogieSpell.
  343. // Since Google only accepts connections over https your PHP installatation
  344. // requires to be compiled with Open SSL support
  345. $rcmail_config['enable_spellcheck'] = true;
  346. // Enables spellchecker exceptions dictionary.
  347. // Setting it to 'shared' will make the dictionary shared by all users.
  348. $rcmail_config['spellcheck_dictionary'] = false;
  349. // Set the spell checking engine. 'googie' is the default. 'pspell' is also available,
  350. // but requires the Pspell extensions. When using Nox Spell Server, also set 'googie' here.
  351. $rcmail_config['spellcheck_engine'] = 'googie';
  352. // For a locally installed Nox Spell Server, please specify the URI to call it.
  353. // Get Nox Spell Server from http://orangoo.com/labs/?page_id=72
  354. // Leave empty to use the Google spell checking service, what means
  355. // that the message content will be sent to Google in order to check spelling
  356. $rcmail_config['spellcheck_uri'] = '';
  357. // These languages can be selected for spell checking.
  358. // Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
  359. // Leave empty for default set of available language.
  360. $rcmail_config['spellcheck_languages'] = NULL;
  361. // Makes that words with all letters capitalized will be ignored (e.g. GOOGLE)
  362. $rcmail_config['spellcheck_ignore_caps'] = false;
  363. // Makes that words with numbers will be ignored (e.g. g00gle)
  364. $rcmail_config['spellcheck_ignore_nums'] = false;
  365. // Makes that words with symbols will be ignored (e.g. g@@gle)
  366. $rcmail_config['spellcheck_ignore_syms'] = false;
  367. // Use this char/string to separate recipients when composing a new message
  368. $rcmail_config['recipients_separator'] = ',';
  369. // don't let users set pagesize to more than this value if set
  370. $rcmail_config['max_pagesize'] = 200;
  371. // Minimal value of user's 'keep_alive' setting (in seconds)
  372. // Must be less than 'session_lifetime'
  373. $rcmail_config['min_keep_alive'] = 60;
  374. // Enables files upload indicator. Requires APC installed and enabled apc.rfc1867 option.
  375. // By default refresh time is set to 1 second. You can set this value to true
  376. // or any integer value indicating number of seconds.
  377. $rcmail_config['upload_progress'] = false;
  378. // Specifies for how many seconds the Undo button will be available
  379. // after object delete action. Currently used with supporting address book sources.
  380. // Setting it to 0, disables the feature.
  381. $rcmail_config['undo_timeout'] = 0;
  382. // ----------------------------------
  383. // ADDRESSBOOK SETTINGS
  384. // ----------------------------------
  385. // This indicates which type of address book to use. Possible choises:
  386. // 'sql' (default) and 'ldap'.
  387. // If set to 'ldap' then it will look at using the first writable LDAP
  388. // address book as the primary address book and it will not display the
  389. // SQL address book in the 'Address Book' view.
  390. $rcmail_config['address_book_type'] = 'sql';
  391. // In order to enable public ldap search, configure an array like the Verisign
  392. // example further below. if you would like to test, simply uncomment the example.
  393. // Array key must contain only safe characters, ie. a-zA-Z0-9_
  394. $rcmail_config['ldap_public'] = array();
  395. // If you are going to use LDAP for individual address books, you will need to
  396. // set 'user_specific' to true and use the variables to generate the appropriate DNs to access it.
  397. //
  398. // The recommended directory structure for LDAP is to store all the address book entries
  399. // under the users main entry, e.g.:
  400. //
  401. // o=root
  402. // ou=people
  403. // uid=user@domain
  404. // mail=contact@contactdomain
  405. //
  406. // So the base_dn would be uid=%fu,ou=people,o=root
  407. // The bind_dn would be the same as based_dn or some super user login.
  408. /*
  409. * example config for Verisign directory
  410. *
  411. $rcmail_config['ldap_public']['Verisign'] = array(
  412. 'name' => 'Verisign.com',
  413. // Replacement variables supported in host names:
  414. // %h - user's IMAP hostname
  415. // %n - http hostname ($_SERVER['SERVER_NAME'])
  416. // %d - domain (http hostname without the first part)
  417. // %z - IMAP domain (IMAP hostname without the first part)
  418. // For example %n = mail.domain.tld, %d = domain.tld
  419. 'hosts' => array('directory.verisign.com'),
  420. 'port' => 389,
  421. 'use_tls' => false,
  422. 'ldap_version' => 3, // using LDAPv3
  423. 'user_specific' => false, // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login.
  424. // %fu - The full username provided, assumes the username is an email
  425. // address, uses the username_domain value if not an email address.
  426. // %u - The username prior to the '@'.
  427. // %d - The domain name after the '@'.
  428. // %dc - The domain name hierarchal string e.g. "dc=test,dc=domain,dc=com"
  429. // %dn - DN found by ldap search when search_filter/search_base_dn are used
  430. 'base_dn' => '',
  431. 'bind_dn' => '',
  432. 'bind_pass' => '',
  433. // It's possible to bind for an individual address book
  434. // The login name is used to search for the DN to bind with
  435. 'search_base_dn' => '',
  436. 'search_filter' => '', // e.g. '(&(objectClass=posixAccount)(uid=%u))'
  437. // DN and password to bind as before searching for bind DN, if anonymous search is not allowed
  438. 'search_bind_dn' => '',
  439. 'search_bind_pw' => '',
  440. // Default for %dn variable if search doesn't return DN value
  441. 'search_dn_default' => '',
  442. // Optional authentication identifier to be used as SASL authorization proxy
  443. // bind_dn need to be empty
  444. 'auth_cid' => '',
  445. // SASL authentication method (for proxy auth), e.g. DIGEST-MD5
  446. 'auth_method' => '',
  447. // Indicates if the addressbook shall be hidden from the list.
  448. // With this option enabled you can still search/view contacts.
  449. 'hidden' => false,
  450. // Indicates if the addressbook shall not list contacts but only allows searching.
  451. 'searchonly' => false,
  452. // Indicates if we can write to the LDAP directory or not.
  453. // If writable is true then these fields need to be populated:
  454. // LDAP_Object_Classes, required_fields, LDAP_rdn
  455. 'writable' => false,
  456. // To create a new contact these are the object classes to specify
  457. // (or any other classes you wish to use).
  458. 'LDAP_Object_Classes' => array('top', 'inetOrgPerson'),
  459. // The RDN field that is used for new entries, this field needs
  460. // to be one of the search_fields, the base of base_dn is appended
  461. // to the RDN to insert into the LDAP directory.
  462. 'LDAP_rdn' => 'cn',
  463. // The required fields needed to build a new contact as required by
  464. // the object classes (can include additional fields not required by the object classes).
  465. 'required_fields' => array('cn', 'sn', 'mail'),
  466. 'search_fields' => array('mail', 'cn'), // fields to search in
  467. // mapping of contact fields to directory attributes
  468. // for every attribute one can specify the number of values (limit) allowed.
  469. // default is 1, a wildcard * means unlimited
  470. 'fieldmap' => array(
  471. // Roundcube => LDAP:limit
  472. 'name' => 'cn',
  473. 'surname' => 'sn',
  474. 'firstname' => 'givenName',
  475. 'title' => 'title',
  476. 'email' => 'mail:*',
  477. 'phone:home' => 'homePhone',
  478. 'phone:work' => 'telephoneNumber',
  479. 'phone:mobile' => 'mobile',
  480. 'phone:pager' => 'pager',
  481. 'street' => 'street',
  482. 'zipcode' => 'postalCode',
  483. 'region' => 'st',
  484. 'locality' => 'l',
  485. // if you uncomment country, you need to modify 'sub_fields' above
  486. // 'country' => 'c',
  487. 'department' => 'departmentNumber',
  488. 'notes' => 'description',
  489. // these currently don't work:
  490. // 'phone:workfax' => 'facsimileTelephoneNumber',
  491. // 'photo' => 'jpegPhoto',
  492. // 'organization' => 'o',
  493. // 'manager' => 'manager',
  494. // 'assistant' => 'secretary',
  495. ),
  496. // Map of contact sub-objects (attribute name => objectClass(es)), e.g. 'c' => 'country'
  497. 'sub_fields' => array(),
  498. 'sort' => 'cn', // The field to sort the listing by.
  499. 'scope' => 'sub', // search mode: sub|base|list
  500. 'filter' => '(objectClass=inetOrgPerson)', // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
  501. 'fuzzy_search' => true, // server allows wildcard search
  502. 'vlv' => false, // Enable Virtual List View to more efficiently fetch paginated data (if server supports it)
  503. 'numsub_filter' => '(objectClass=organizationalUnit)', // with VLV, we also use numSubOrdinates to query the total number of records. Set this filter to get all numSubOrdinates attributes for counting
  504. 'sizelimit' => '0', // Enables you to limit the count of entries fetched. Setting this to 0 means no limit.
  505. 'timelimit' => '0', // Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit.
  506. 'referrals' => true|false, // Sets the LDAP_OPT_REFERRALS option. Mostly used in multi-domain Active Directory setups
  507. // definition for contact groups (uncomment if no groups are supported)
  508. // for the groups base_dn, the user replacements %fu, %u, $d and %dc work as for base_dn (see above)
  509. // if the groups base_dn is empty, the contact base_dn is used for the groups as well
  510. // -> in this case, assure that groups and contacts are separated due to the concernig filters!
  511. 'groups' => array(
  512. 'base_dn' => '',
  513. 'scope' => 'sub', // search mode: sub|base|list
  514. 'filter' => '(objectClass=groupOfNames)',
  515. 'object_classes' => array("top", "groupOfNames"),
  516. 'member_attr' => 'member', // name of the member attribute, e.g. uniqueMember
  517. 'name_attr' => 'cn', // attribute to be used as group name
  518. ),
  519. );
  520. */
  521. // An ordered array of the ids of the addressbooks that should be searched
  522. // when populating address autocomplete fields server-side. ex: array('sql','Verisign');
  523. $rcmail_config['autocomplete_addressbooks'] = array('sql');
  524. // The minimum number of characters required to be typed in an autocomplete field
  525. // before address books will be searched. Most useful for LDAP directories that
  526. // may need to do lengthy results building given overly-broad searches
  527. $rcmail_config['autocomplete_min_length'] = 1;
  528. // Number of parallel autocomplete requests.
  529. // If there's more than one address book, n parallel (async) requests will be created,
  530. // where each request will search in one address book. By default (0), all address
  531. // books are searched in one request.
  532. $rcmail_config['autocomplete_threads'] = 0;
  533. // Max. numer of entries in autocomplete popup. Default: 15.
  534. $rcmail_config['autocomplete_max'] = 15;
  535. // show address fields in this order
  536. // available placeholders: {street}, {locality}, {zipcode}, {country}, {region}
  537. $rcmail_config['address_template'] = '{street}<br/>{locality} {zipcode}<br/>{country} {region}';
  538. // Matching mode for addressbook search (including autocompletion)
  539. // 0 - partial (*abc*), default
  540. // 1 - strict (abc)
  541. // 2 - prefix (abc*)
  542. // Note: For LDAP sources fuzzy_search must be enabled to use 'partial' or 'prefix' mode
  543. $rcmail_config['addressbook_search_mode'] = 0;
  544. // ----------------------------------
  545. // USER PREFERENCES
  546. // ----------------------------------
  547. // Use this charset as fallback for message decoding
  548. //$rcmail_config['default_charset'] = 'ISO-8859-1';
  549. $rcmail_config['default_charset'] = 'UTF-8';
  550. // skin name: folder from skins/
  551. $rcmail_config['skin'] = 'larry';
  552. // show up to X items in messages list view
  553. $rcmail_config['mail_pagesize'] = 50;
  554. // show up to X items in contacts list view
  555. $rcmail_config['addressbook_pagesize'] = 50;
  556. // sort contacts by this col (preferably either one of name, firstname, surname)
  557. $rcmail_config['addressbook_sort_col'] = 'surname';
  558. // the way how contact names are displayed in the list
  559. // 0: display name
  560. // 1: (prefix) firstname middlename surname (suffix)
  561. // 2: (prefix) surname firstname middlename (suffix)
  562. // 3: (prefix) surname, firstname middlename (suffix)
  563. $rcmail_config['addressbook_name_listing'] = 0;
  564. // use this timezone to display date/time
  565. // valid timezone identifers are listed here: php.net/manual/en/timezones.php
  566. // 'auto' will use the browser's timezone settings
  567. $rcmail_config['timezone'] = 'auto';
  568. // prefer displaying HTML messages
  569. $rcmail_config['prefer_html'] = true;
  570. // display remote inline images
  571. // 0 - Never, always ask
  572. // 1 - Ask if sender is not in address book
  573. // 2 - Always show inline images
  574. $rcmail_config['show_images'] = 0;
  575. // compose html formatted messages by default
  576. // 0 - never, 1 - always, 2 - on reply to HTML message only
  577. $rcmail_config['htmleditor'] = 0;
  578. // show pretty dates as standard
  579. $rcmail_config['prettydate'] = true;
  580. // save compose message every 300 seconds (5min)
  581. $rcmail_config['draft_autosave'] = 300;
  582. // default setting if preview pane is enabled
  583. $rcmail_config['preview_pane'] = false;
  584. // Mark as read when viewed in preview pane (delay in seconds)
  585. // Set to -1 if messages in preview pane should not be marked as read
  586. $rcmail_config['preview_pane_mark_read'] = 0;
  587. // Clear Trash on logout
  588. $rcmail_config['logout_purge'] = false;
  589. // Compact INBOX on logout
  590. $rcmail_config['logout_expunge'] = false;
  591. // Display attached images below the message body
  592. $rcmail_config['inline_images'] = true;
  593. // Encoding of long/non-ascii attachment names:
  594. // 0 - Full RFC 2231 compatible
  595. // 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default)
  596. // 2 - Full 2047 compatible
  597. $rcmail_config['mime_param_folding'] = 1;
  598. // Set true if deleted messages should not be displayed
  599. // This will make the application run slower
  600. $rcmail_config['skip_deleted'] = false;
  601. // Set true to Mark deleted messages as read as well as deleted
  602. // False means that a message's read status is not affected by marking it as deleted
  603. $rcmail_config['read_when_deleted'] = true;
  604. // Set to true to never delete messages immediately
  605. // Use 'Purge' to remove messages marked as deleted
  606. $rcmail_config['flag_for_deletion'] = false;
  607. // Default interval for keep-alive/check-recent requests (in seconds)
  608. // Must be greater than or equal to 'min_keep_alive' and less than 'session_lifetime'
  609. $rcmail_config['keep_alive'] = 60;
  610. // If true all folders will be checked for recent messages
  611. $rcmail_config['check_all_folders'] = false;
  612. // If true, after message delete/move, the next message will be displayed
  613. $rcmail_config['display_next'] = false;
  614. // 0 - Do not expand threads
  615. // 1 - Expand all threads automatically
  616. // 2 - Expand only threads with unread messages
  617. $rcmail_config['autoexpand_threads'] = 0;
  618. // When replying place cursor above original message (top posting)
  619. $rcmail_config['top_posting'] = false;
  620. // When replying strip original signature from message
  621. $rcmail_config['strip_existing_sig'] = true;
  622. // Show signature:
  623. // 0 - Never
  624. // 1 - Always
  625. // 2 - New messages only
  626. // 3 - Forwards and Replies only
  627. $rcmail_config['show_sig'] = 1;
  628. // When replying or forwarding place sender's signature above existing message
  629. $rcmail_config['sig_above'] = false;
  630. // Use MIME encoding (quoted-printable) for 8bit characters in message body
  631. $rcmail_config['force_7bit'] = false;
  632. // Defaults of the search field configuration.
  633. // The array can contain a per-folder list of header fields which should be considered when searching
  634. // The entry with key '*' stands for all folders which do not have a specific list set.
  635. // Please note that folder names should to be in sync with $rcmail_config['default_folders']
  636. $rcmail_config['search_mods'] = null; // Example: array('*' => array('subject'=>1, 'from'=>1), 'Sent' => array('subject'=>1, 'to'=>1));
  637. // Defaults of the addressbook search field configuration.
  638. $rcmail_config['addressbook_search_mods'] = null; // Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1);
  639. // 'Delete always'
  640. // This setting reflects if mail should be always deleted
  641. // when moving to Trash fails. This is necessary in some setups
  642. // when user is over quota and Trash is included in the quota.
  643. $rcmail_config['delete_always'] = false;
  644. // Directly delete messages in Junk instead of moving to Trash
  645. $rcmail_config['delete_junk'] = true;
  646. // Behavior if a received message requests a message delivery notification (read receipt)
  647. // 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
  648. // 3 = send automatically if sender is in addressbook, otherwise ask the user
  649. // 4 = send automatically if sender is in addressbook, otherwise ignore
  650. $rcmail_config['mdn_requests'] = 0;
  651. // Return receipt checkbox default state
  652. $rcmail_config['mdn_default'] = 0;
  653. // Delivery Status Notification checkbox default state
  654. $rcmail_config['dsn_default'] = 0;
  655. // Place replies in the folder of the message being replied to
  656. $rcmail_config['reply_same_folder'] = false;
  657. // Sets default mode of Forward feature to "forward as attachment"
  658. $rcmail_config['forward_attachment'] = false;
  659. // Defines address book (internal index) to which new contacts will be added
  660. // By default it is the first writeable addressbook.
  661. // Note: Use '0' for built-in address book.
  662. $rcmail_config['default_addressbook'] = null;
  663. // Enables spell checking before sending a message.
  664. $rcmail_config['spellcheck_before_send'] = false;
  665. // Skip alternative email addresses in autocompletion (show one address per contact)
  666. $rcmail_config['autocomplete_single'] = false;
  667. // Default font for composed HTML message.
  668. // Supported values: Andale Mono, Arial, Arial Black, Book Antiqua, Courier New,
  669. // Georgia, Helvetica, Impact, Tahoma, Terminal, Times New Roman, Trebuchet MS, Verdana
  670. $rcmail_config['default_font'] = '';
  671. // end of config file