* Added a new message function hook type EVT_SMTPSCAN which permits modules to

[citadel.git] / citadel / techdoc / hack.txt

diff --git a/citadel/techdoc/hack.txt b/citadel/techdoc/hack.txt
index 90bbe404adc93d9f3453f27771ac62035071a8f5..af5ce2cd13742ad82f9afa470156d3177bb41cc0 100644 (file)
--- a/citadel/techdoc/hack.txt
+++ b/citadel/techdoc/hack.txt
@@ -117,6 +117,11 @@ T  Date/Time       A 32-bit integer containing the date and time of
 U       Subject         Optional.  Developers may choose whether they wish to
                         generate or display subject fields.  Citadel/UX does
                         not generate them, but it does print them when found.
+0      Error           This field is typically never found in a message on
+                       disk or in transit.  Message scanning modules are
+                       expected to fill in this field when rejecting a message
+                       with an explanation as to what happened (virus found,
+                       message looks like spam, etc.)
   
                        EXAMPLE