]> git.ipfire.org Git - thirdparty/mlmmj.git/commitdiff
Improve documentation about the digest list text.
authorBen Schmidt <none@none>
Tue, 3 Jan 2012 17:06:37 +0000 (04:06 +1100)
committerBen Schmidt <none@none>
Tue, 3 Jan 2012 17:06:37 +0000 (04:06 +1100)
README.listtexts

index 568c661e2c4c0900a561b23a9690f321bd92745a..5abc727f652976a0463592b2c068d452da50f9b6 100644 (file)
@@ -135,7 +135,9 @@ is given in brackets. Those with asterisks (*) are not yet used.
   sent to the list owner when somebody is (un-)subscribed
 
 - digest
-  sent at the start of a digest
+  sent at the start of a digest (NOTE: the only header supported in this list
+  text so far is a single-line 'Subject:' header; however, the contents of
+  control/customheaders is included when digests are sent)
 
 - probe (bounce-probe)
   sent to a subscriber after an email to them bounced to inform them of the
@@ -180,6 +182,8 @@ The Subject: header is treated specially: it may include UTF-8 characters,
 which will automatically be escaped using the =?utf-8?q?...?= quoting
 mechanism.
 
+(NOTE: the 'digest' list text is a bit different. See its description above.)
+
 Both headers and bodies of list texts may include conditionals, formatting
 directives and substitutions. These are explained in the following sections.