Happy New Year

[squirrelmail.git] / config / config_local.example.php

diff --git a/config/config_local.example.php b/config/config_local.example.php
index d3dc9611b719ee83c1078296870e6fc5cb932d12..c942d0d181fef6491bc1eb360abc7198b5504361 100644 (file)
--- a/config/config_local.example.php
+++ b/config/config_local.example.php
@@ -7,7 +7,7 @@
  * Don't do it unless you know what you're doing.
  * Use standard PHP syntax, see config.php for examples.
  *
- * @copyright 2002-2018 The SquirrelMail Project Team
+ * @copyright 2002-2020 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -146,4 +146,41 @@
  * while using this setting, you must include the following
  * as part of this setting:
  * $head_tag_extra = '<link rel="shortcut icon" href="###SM BASEURI###favicon.ico" />...<YOUR CONTENT HERE>...';
+ *
+ * $imap_id_command_args (array) causes the IMAP ID
+ * command (RFC 2971) to be sent after every login,
+ * identifying the client to the server.  Each key in this
+ * array is an attibute to be sent in the ID command to
+ * the server.  Values will be sent as-is except if the
+ * value is "###REMOTE ADDRESS###" (without quotes) in
+ * which case the current user's real IP address will be
+ * substituted.  If "###X-FORWARDED-FOR###" is used and a
+ * "X-FORWARDED-FOR" header is present in the client request,
+ * the contents of that header are used (careful, this can
+ * be forged).  If "###X-FORWARDED-FOR OR REMOTE ADDRESS###"
+ * is used, then the "X-FORWARDED-FOR" header is used if it
+ * is present in the request, otherwise, the client's
+ * connecting IP address is used.  The following attributes
+ * will always be added unless they are specifically
+ * overridden with a blank value:
+ *    name, vendor, support-url, version
+ * A parsed representation of server's response is made
+ * available to plugins as both a global and session variable
+ * named "imap_server_id_response" (a simple key/value array)
+ * unless response parsing is turned off by way of setting a
+ * variable in this file named
+ * $do_not_parse_imap_id_command_response to TRUE, in which
+ * case, the stored response will be the unparsed IMAP response.
+ * $imap_id_command_args = array('remote-host' => '###REMOTE ADDRESS###');
+ * $do_not_parse_imap_id_command_response = FALSE;
+ *
+ * $remove_rcdata_rawtext_tags_and_content
+ * When displaying HTML-format email message content, a small
+ * number of HTML tags are parsed differently (RCDATA, RAWTEXT
+ * content), but can also be removed entirely (with their contents)
+ * if desired (in most cases, should be a safe thing with minimal
+ * impact).  This would be done as a fallback security measure and
+ * can be enabled by adding this here:
+ * $remove_rcdata_rawtext_tags_and_content = TRUE; 
+ *
  */