Improve documentation for header config file.
authorMichael M Slusarz <slusarz@curecanti.org>
Thu, 19 Mar 2009 10:33:22 +0000 (04:33 -0600)
committerMichael M Slusarz <slusarz@curecanti.org>
Thu, 19 Mar 2009 11:00:15 +0000 (05:00 -0600)
imp/config/header.php.dist

index f60005a..7bde6ec 100644 (file)
@@ -3,18 +3,23 @@
  * This file will allow you to set headers to append to outgoing mail messages.
  *
  * To add a new header item, simply add a new entry to the $_header array.
- * The "key" should be the header name.
- * The "value" should be the header data.
+ * KEY:   Header name (must be in US-ASCII charset))
+ * VALUE: Header data (must be in US-ASCII charset)
  *
  * $Id$
  */
 
-$_header = array();
+$_header = array(
 
-/* Add your custom entries below this line. */
+    // Add information on organization to which the sender belongs.
+    // Not standardized for use in e-mail, but generally recognized.
+    // See RFC 2076 [3.7]; RFC 1036 [2.2.8]
+    //'Organization' => 'Example Corp.',
 
-// Add the IP of the remote browser
-//$_header['X-Originating-IP'] = $_SERVER['REMOTE_ADDR'];
+    // Add the IP of the remote browser
+    //'X-Originating-IP' => $_SERVER['REMOTE_ADDR'],
 
-// Add the Browser information of the remote browser
-//$_header['X-Remote-Browser'] = $_SERVER['HTTP_USER_AGENT'];
+    // Add the Browser information of the remote browser
+    //'X-Remote-Browser' => $_SERVER['HTTP_USER_AGENT'],
+
+);