citadel/techdoc/delivery-list.txt

   1 Description of the custom MIME type "application/x-citadel-delivery-list"
   2
   3  This MIME type may be found in the outbound queue room on Citadel systems,
   4 which is typically called "__CitadelSMTPspoolout__".  The room is flagged as
   5 private, but we will eventually hide it even to Aides.
   6
   7  Messages in this format contain delivery instructions.  Therefore, for each
   8 message in the queue to be delivered to one or more recipients, there will be
   9 *two* messages in the room: one containing the actual message, and the other
  10 containing delivery instructions.  It is expected that the instructions
  11 message may be replaced at any time (using an Extended ID field) if delivery
  12 to only some of the recipients has been accomplished.
  13
  14  Citadel keeps reference counts of each message on disk.  Therefore if a
  15 message contains a mixture of local and remote recipients, there may be two
  16 or more references to the message itself, one of them being the one in the
  17 queue.
  18
  19  A delivery list contains one or more lines of text, each line containing
  20 a single instruction (usually a recipient).  Fields are separated by the
  21 vertical bar character ("|") and there will always be at least one field on
  22 each line.
  23
  24
  25
  26  INSTRUCTION:  msgid
  27  SYNTAX:       msgid|0000000
  28  DESCRIPTION:
  29     Defines the actual message for which we are providing delivery
  30     instructions.  This instruction must precede all the others.  When
  31     all deliveries have either succeeded or failed, both the instructions and
  32     the copy of the message itself in the queue room should be deleted.  The
  33     second parameter specifies the message ID in the local database.
  34
  35
  36  INSTRUCTION:  local
  37  SYNTAX:       local|Friko Mumjiboolean|0
  38  DESCRIPTION:
  39     Indicates the name of a recipient on the local system to which the
  40     message must be delivered.  Almost never seen because most code delivers
  41     directly.
  42
  43
  44  INSTRUCTION:  room
  45  SYNTAX:       room|Lobby|0
  46  DESCRIPTION:
  47     Indicates the name of a room on the local system to which the message
  48     must be copied.  Same implications as 'local'.
  49
  50
  51  INSTRUCTION:  remote
  52  SYNTAX:       remote|billg@microsoft.com|0
  53  DESCRIPTION:
  54     Names a recipient on a remote system to which the message should be
  55     delivered.  (FIX ... this is where we have to keep track of multiple
  56     delivery attempts and transient errors)
  57
  58
  59  INSTRUCTION:  ignet
  60  SYNTAX:       ignet|uncnsrd|Lobby|0
  61  DESCRIPTION:
  62     Names a room on another Citadel node to which this message needs to be
  63     spooled over the network.