citadel/docs/netconfigs.txt

   1
   2 Description of "netconfigs" records
   3
   4 These files contain a set of network configurations for a room.  They are
   5 stored in the directory $CTDLDIR/netconfigs and are named according to each
   6 room's internal ID number.  When a room is deleted, its network configuration
   7 file is deleted as well.
   8
   9 The configuration file contains one or more lines of text, each line
  10 containing a configuration option.  These lines may specify message pointers,
  11 room sharing instructions, mailing list recipients, etc.  Fields are separated
  12 by the vertical bar character ("|") and there will always be at least one
  13 field on each line.
  14
  15
  16 INSTRUCTION:  lastsent
  17 SYNTAX:       lastsent|0000000
  18 DESCRIPTION:
  19 Defines the *local* message number of the last message in this room which
  20 we have performed outbound network processing on.  Any batch job which sends
  21 out messages should do stuff.
  22
  23
  24 INSTRUCTION:  listrecp
  25 SYNTAX:       listrecp|friko@mumjiboolean.com
  26 DESCRIPTION:
  27 Defines a recipient to whom all messages in this room should be sent.  This
  28 is used for "list serve" applications.
  29
  30
  31 INSTRUCTION:  digestrecp
  32 SYNTAX:       digestrecp|friko@mumjiboolean.com
  33 DESCRIPTION:
  34 Defines a recipient to whom all messages in this room should be sent.  This
  35 is used for "list serve" applications.  The difference between listrecps and
  36 digestrecps is that the latter will have messages embedded inside a message
  37 sent by the listserver.  The message will appear to be sent by the room's
  38 e-mail address instead of the sender's e-mail address.
  39
  40
  41 INSTRUCTION:  subpending
  42 SYNTAX:       subpending|friko@mumjiboolean.com|listrecp|A234Z|1234567890|http://foo.com/lists
  43 "Subscription pending" for the specified address.  This means that
  44 someone has requested to subscribe an e-mail address (in this case,
  45 friko@mumjiboolean.com) to the list.  The third parameter is either "list"
  46 or "digest" to specify a normal subscription or a digest subscription.
  47 The fourth parameter is an authentication token which is generated by the server
  48 and e-mailed to the specified address.  When the user comes back and supplies
  49 this token, the subscription is complete.  The fifth parameter is a simple
  50 timestamp, so that we may purge old records which were never confirmed.
  51
  52 The sixth field is the URL of the web page used to enter the subscription
  53 request, minus any parameters.
  54
  55
  56 INSTRUCTION:  unsubpending
  57 SYNTAX:       unsubpending|friko@mumjiboolean.com|A234Z|1234567890|http://foo.com/lists
  58 Similar to the 'subpending' command, except this one is for unsubscribe
  59 requests.  The same rules apply with regard to the token and the web page.
  60
  61
  62 INSTRUCTION:  participate
  63 SYNTAX:       participate|list-addr@example.com
  64 This allows a room to be a  *subscriber* to an external mailing list
  65 somewhere.  The room's email address should be subscribed to the list, and the
  66 external listserv should be told "do not send me my own messages."  Any
  67 messages which originated on Citadel (as opposed to messages which arrived via
  68 email, such as those from the list) will be sent to the list, with the display
  69 name of the author kept intact, but the email address changed to the address of
  70 the room.
  71
  72 This is somewhat finicky, which is why it is not officially supported, and
  73 why there are no facilities in the user interface to configure it.  If you want
  74 to use this option you are on your own.
  75
  76
  77 INSTRUCTION:  pop3client
  78 SYNTAX:       pop3client|hostname|username|password|keep|interval
  79 Periodically fetch messages from a remote POP3 account and store them in this
  80 room.  Messages will be deleted from the remote account once successfully stored.
  81 if Keep is set, messages won't be erased on the remote host.
  82 Interval can specify a bigger value than the system configs value.
  83
  84
  85 INSTRUCTION:    rssclient
  86 SYNTAX:         rssclient|url
  87 Periodically scrape an external RSS or Atom feed and store new items in this
  88 room.  We try to positively identify unique messages and avoid storing them
  89 multiple times.