]> code.citadel.org Git - citadel.git/blobdiff - citadel/techdoc/delivery-list.txt
Re-Sort Cleanup of event io on shutdown
[citadel.git] / citadel / techdoc / delivery-list.txt
index 9395c9442ee43198516bee85e925b2eca98b4f8a..b6663cdb051e4048332b8ec9290a51baebeaa34b 100644 (file)
@@ -23,7 +23,7 @@ a single instruction (usually a recipient).  Fields are separated by the
 vertical bar character ("|") and there will always be at least one field on
 each line.
  
+ -- Once per Queue-Item --
  
  INSTRUCTION:  msgid
  SYNTAX:       msgid|0000000
@@ -67,22 +67,25 @@ fails).
     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
+
+ INSTRUCTION:  envelope_from
+ SYNTAX:       envelope_from|blurdybloop@example.com
  DESCRIPTION:
-    Indicates the name of a recipient on the local system to which the
-    message must be delivered.  Almost never seen because most code delivers
-    directly.
- INSTRUCTION:  room
- SYNTAX:       room|Lobby|0
+    Sets a value to be used as the envelope sender during the 'MAIL FROM:'
+    phase of the SMTP transaction.  If an envelope sender is not supplied,
+    one is extracted from the message body.
+
+ INSTRUCTION:  source_room
+ SYNTAX:       source_room|Citadel Support
  DESCRIPTION:
-    Indicates the name of a room on the local system to which the message
-    must be copied.  Same implications as 'local'.
+    when sending mailinglist rooms this contains the source room for displaying
+    and messaging purposes.
+
+
+
+
+-- Once per Remote-part per Queue-Item --
+
  INSTRUCTION:  remote
  SYNTAX:       remote|friko@mumjiboolean.com|0|delivery status message
  DESCRIPTION:
@@ -90,14 +93,8 @@ fails).
     delivered.  The third parameter may contain any of the following values:
        0 = No delivery has yet been attempted
        2 = Delivery was successful
+       3 = transient error state; like connection failure or DNS lookup failure
        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|delivery status message
- DESCRIPTION:
-    Names a room on another Citadel node to which this message needs to be
-    spooled over the network.