Add advanced control over the SSL context used when connecting to the SMTP and IMAP...

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

diff --git a/config/config_local.example.php b/config/config_local.example.php
index a340c7c2ee9432041d88bf287568b127bd13a950..bcb482c672a5eac89a27b461d7ea83f8b309b50c 100644 (file)
--- a/config/config_local.example.php
+++ b/config/config_local.example.php
@@ -27,7 +27,7 @@
  * of custom PHP session handlers.  This feature is well
  * documented in the code in include/init.php
  *
- * hide_squirrelmail_header (must be defined as a constant:
+ * $hide_squirrelmail_header (must be defined as a constant:
  * define('hide_squirrelmail_header', 1);
  * This allows the administrator to force SquirrelMail never
  * to add its own Received headers with user information in
@@ -52,5 +52,28 @@
  * (those that are displayed in a different color than other
  * "normal" mailboxes).
  *
+ * $smtpSslOptions allows more control over the SSL context used
+ * when connecting to the SMTP server over SSL/TLS.  See:
+ * http://php.net/manual/context.ssl.php
+ * For example, you can specify a CA file that corresponds
+ * to your server's certificate and make sure that the
+ * server's certificate is validated when connecting:
+ * $smtpSslOptions = array(
+ *     'cafile' => '/etc/pki/tls/certs/ca-bundle.crt',
+ *     'verify_peer' => true,
+ *     'verify_depth' => 3,
+ * );
+ *
+ * $imapSslOptions allows more control over the SSL context used
+ * when connecting to the IMAP server over SSL/TLS.  See:
+ * http://php.net/manual/context.ssl.php
+ * For example, you can specify a CA file that corresponds
+ * to your server's certificate and make sure that the
+ * server's certificate is validated when connecting:
+ * $imapSslOptions = array(
+ *     'cafile' => '/etc/pki/tls/certs/ca-bundle.crt',
+ *     'verify_peer' => true,
+ *     'verify_depth' => 3,
+ * );
  */