* Double the retry interval for SMTP deliveries after each failed attempt.

[citadel.git] / citadel / techdoc / delivery-list.txt

diff --git a/citadel/techdoc/delivery-list.txt b/citadel/techdoc/delivery-list.txt
index fa13b64ed84c9be6258dd64cf4bf955e4b01c08b..ce90e765839fba870bb86b62f3f560da99f780fc 100644 (file)
--- a/citadel/techdoc/delivery-list.txt
+++ b/citadel/techdoc/delivery-list.txt
@@ -33,6 +33,39 @@ each line.
     second parameter specifies the message ID in the local database.
  
  
+ INSTRUCTION:  submitted
+ SYNTAX:       submitted|999999999
+ DESCRIPTION:
+    Contains a timestamp designating when this message was first entered into
+    the system.
+ 
+ 
+ INSTRUCTION:  attempted
+ SYNTAX:       attempted|999999999
+ DESCRIPTION:
+    Contains a timestamp designating the date/time of the last delivery
+    attempt.
+ 
+ 
+ INSTRUCTION:  retry
+ SYNTAX:       retry|9999999
+ DESCRIPTION:
+    Citadel does not retry SMTP delivery at a fixed interval.  Instead, it
+starts at a nominal interval (15 minutes by default) and then doubles the
+interval after each failed attempt.  This instruction contains the interval
+which should currently be followed (and doubled again, if the next delivery
+fails).
+  
+  
+ INSTRUCTION:  bounceto
+ SYNTAX:       bounceto|Big Bad Sender[@host]
+ DESCRIPTION:
+    Where to send "bounce" messages (delivery status notifications).  The
+    contents of the second field are supplied as the "recipient" field to
+    CtdlSaveMsg(), and therefore may be a local username, a user on another
+    Citadel, or an Internet e-mail address.
+ 
+ 
  INSTRUCTION:  local
  SYNTAX:       local|Friko Mumjiboolean|0
  DESCRIPTION:
@@ -49,15 +82,20 @@ each line.
  
  
  INSTRUCTION:  remote
- SYNTAX:       remote|billg@microsoft.com|0
+ SYNTAX:       remote|billg@microsoft.com|0|delivery status message
  DESCRIPTION:
     Names a recipient on a remote system to which the message should be
-    delivered.  (FIX ... this is where we have to keep track of multiple
-    delivery attempts and transient errors)
+    delivered.  The third parameter may contain any of the following values:
+       0 = No delivery has yet been attempted
+       2 = Delivery was successful
+       4 = A transient error was experienced ... try again later
+       5 = Delivery to this address failed permanently.  The error message
+           should be placed in the fourth field so that a bounce message may
+           be generated.
  
  
  INSTRUCTION:  ignet
- SYNTAX:       ignet|uncnsrd|Lobby|0
+ SYNTAX:       ignet|uncnsrd|Lobby|0|delivery status message
  DESCRIPTION:
     Names a room on another Citadel node to which this message needs to be
     spooled over the network.