Merge branch 'master' of ssh://git.citadel.org/appl/gitroot/citadel
[citadel.git] / citadel / techdoc / hack.txt
index f8843269005be7c038ab1b2f3d81fb2e5f424604..1af927555f80139ae118509743c5f3dd9773da18 100644 (file)
@@ -229,97 +229,97 @@ all software should be written to IGNORE fields not currently defined.
 
                  The type bytes currently defined are:
 
-BYTE   Mnemonic        Enum / Comments
-
-A      Author          eAuthor
-                       Name of originator of message.
-B      Big message     eBig_message
-                       This is a flag which indicates that the message is
-                       big, and Citadel is storing the body in a separate
-                       record.  You will never see this field because the
-                       internal API handles it.
-C      RemoteRoom      eRemoteRoom
-                       when sent via Citadel Networking, this is the room
-                       its going to be put on the remote site.
-D      Destination     eDestination
-                       Contains name of the system this message should
-                       be sent to, for mail routing (private mail only).
-E      Exclusive ID    eExclusiveID
-                       A persistent alphanumeric Message ID used for
-                       network replication.  When a message arrives that
-                       contains an Exclusive ID, any existing messages which
-                       contain the same Exclusive ID and are *older* than this
-                       message should be deleted.  If there exist any messages
-                       with the same Exclusive ID that are *newer*, then this
-                       message should be dropped.
-F      rFc822 address  erFc822Addr
-                       For Internet mail, this is the delivery address of the
-                       message author.
-H      Human node name eHumanNode
-                       Human-readable name of system message originated on.
-I      Message ID      emessageId
-                       An RFC822-compatible message ID for this message.
-J      Journal         eJournal
-                       The presence of this field indicates that the message
-                       is disqualified from being journaled, perhaps because
-                       it is itself a journalized message and we wish to
-                       avoid double journaling.
-K      Reply-To        eReplyTo
-                       the Reply-To header for mailinglist outbound messages
-L      List-ID         eListID
-                       Mailing list identification, as per RFC 2919
-M      Message Text    eMesageText
-                       Normal ASCII, newlines seperated by CR's or LF's,
-                       null terminated as always.
-N      Nodename        eNodeName
-                       Contains node name of system message originated on.
-O      Room            eOriginalRoom - Room of origin.
-P      Path            eMessagePath
-                       Complete path of message, as in the UseNet news
-                       standard.  A user should be able to send Internet mail
-                       to this path. (Note that your system name will not be
-                       tacked onto this until you're sending the message to
-                       someone else)
-R      Recipient       eRecipient - Only present in Mail messages.
-S      Special field   eSpecialField
-                       Only meaningful for messages being spooled over a
-                       network.  Usually means that the message isn't really
-                       a message, but rather some other network function:
-                       -> "S" followed by "FILE" (followed by a null, of
-                          course) means that the message text is actually an
-                          IGnet/Open file transfer.  (OBSOLETE)
-                       -> "S" followed by "CANCEL" means that this message
-                          should be deleted from the local message base once
-                          it has been replicated to all network systems.
-T      date/Time       eTimestamp
-                       Unix timestamp containing the creation date/time of
-                       the message.
-U      sUbject         eMsgSubject - Optional.
-                       Developers may choose whether they wish to
-                       generate or display subject fields.
-V      enVelope-to     eenVelopeTo
-                       The recipient specified in incoming SMTP messages.
-W      Wefewences      eWeferences
-                       Previous message ID's for conversation threading.  When
-                       converting from RFC822 we use References: if present, or
-                       In-Reply-To: otherwise.
-                       (Who in extnotify spool messages which don't need to know
-                       other message ids)
-Y      carbon copY     eCarbonCopY
-                       Optional, and only in Mail messages.
-0      Error           eErrorMsg
-                       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.)
-1      suppress index  eSuppressIdx
-                       The presence of this field indicates that the message is
-                       disqualified from being added to the full text index.
-2      extnotify       eExtnotify - Used internally by the serv_extnotify module.
-3      msgnum          eVltMsgNum
-                       Used internally to pass the local message number in the
-                       database to after-save hooks.  Discarded afterwards.
+BYTE   Enum            Mnemonic        Enum / Comments
+                       
+A      eAuthor         Author          eAuthor
+                                       Name of originator of message.
+B      eBig_message    Big message     eBig_message
+                                       This is a flag which indicates that the message is
+                                       big, and Citadel is storing the body in a separate
+                                       record.  You will never see this field because the
+                                       internal API handles it.
+C      eRemoteRoom     RemoteRoom      eRemoteRoom
+                                       when sent via Citadel Networking, this is the room
+                                       its going to be put on the remote site.
+D      eDestination    Destination     eDestination
+                                       Contains name of the system this message should
+                                       be sent to, for mail routing (private mail only).
+E      eExclusiveID    Exclusive ID    eExclusiveID
+                                       A persistent alphanumeric Message ID used for
+                                       network replication.  When a message arrives that
+                                       contains an Exclusive ID, any existing messages which
+                                       contain the same Exclusive ID and are *older* than this
+                                       message should be deleted.  If there exist any messages
+                                       with the same Exclusive ID that are *newer*, then this
+                                       message should be dropped.
+F      erFc822Addr     rFc822 address  erFc822Addr
+                                       For Internet mail, this is the delivery address of the
+                                       message author.
+H      eHumanNode      Human node name eHumanNode
+                                       Human-readable name of system message originated on.
+I      emessageId      Message ID      emessageId
+                                       An RFC822-compatible message ID for this message.
+J      eJournal        Journal         eJournal
+                                       The presence of this field indicates that the message
+                                       is disqualified from being journaled, perhaps because
+                                       it is itself a journalized message and we wish to
+                                       avoid double journaling.
+K      eReplyTo        Reply-To        eReplyTo
+                                       the Reply-To header for mailinglist outbound messages
+L      eListID         List-ID         eListID
+                                       Mailing list identification, as per RFC 2919
+M      eMesageText     Message Text    eMesageText
+                                       Normal ASCII, newlines seperated by CR's or LF's,
+                                       null terminated as always.
+N      eNodeName       Nodename        eNodeName
+                                       Contains node name of system message originated on.
+O      eOriginalRoom   Room            eOriginalRoom - Room of origin.
+P      eMessagePath    Path            eMessagePath
+                                       Complete path of message, as in the UseNet news
+                                       standard.  A user should be able to send Internet mail
+                                       to this path. (Note that your system name will not be
+                                       tacked onto this until you're sending the message to
+                                       someone else)
+R      eRecipient      Recipient       eRecipient - Only present in Mail messages.
+S      eSpecialField   Special field   eSpecialField
+                                       Only meaningful for messages being spooled over a
+                                       network.  Usually means that the message isn't really
+                                       a message, but rather some other network function:
+                                       -> "S" followed by "FILE" (followed by a null, of
+                                          course) means that the message text is actually an
+                                          IGnet/Open file transfer.  (OBSOLETE)
+                                       -> "S" followed by "CANCEL" means that this message
+                                          should be deleted from the local message base once
+                                          it has been replicated to all network systems.
+T      eTimestamp      date/Time       eTimestamp
+                                       Unix timestamp containing the creation date/time of
+                                       the message.
+U      eMsgSubject     sUbject         eMsgSubject - Optional.
+                                       Developers may choose whether they wish to
+                                       generate or display subject fields.
+V      eenVelopeTo     enVelope-to     eenVelopeTo
+                                       The recipient specified in incoming SMTP messages.
+W      eWeferences     Wefewences      eWeferences
+                                       Previous message ID's for conversation threading.  When
+                                       converting from RFC822 we use References: if present, or
+                                       In-Reply-To: otherwise.
+                                       (Who in extnotify spool messages which don't need to know
+                                       other message ids)
+Y      eCarbonCopY     carbon copY     eCarbonCopY
+                                       Optional, and only in Mail messages.
+0      eErrorMsg       Error           eErrorMsg
+                                       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.)
+1      eSuppressIdx    suppress index  eSuppressIdx
+                                       The presence of this field indicates that the message is
+                                       disqualified from being added to the full text index.
+2      eExtnotify      extnotify       eExtnotify - Used internally by the serv_extnotify module.
+3      eVltMsgNum      msgnum          eVltMsgNum
+                                       Used internally to pass the local message number in the
+                                       database to after-save hooks.  Discarded afterwards.
   
                        EXAMPLE