Magimail documentation

docs/docs/guide/msgs/ftn/magimail.md

@@ -1,9 +1,11 @@
 # Magimail configuration
 
-TODO.
+Magimail is a fork of Crashmail-II and is configured using a `magimail.prefs` file in the working directory that you call magimail from. I usually put my prefs file in the `MagickaBBS/ftn/` directory.
 
 ## Example magimail.prefs file
 
+Here is a sample template you can use to get started configuring magimail, along with explainations for each command. Please note there are many more commands you can use for more advanced setup. The full documentation is in `MagickaBBS/utils/magimail/doc/example.prefs`.
+
     SYSOP "Your Name"
     BBSNAME "Some BBS"
 
@@ -32,10 +34,8 @@ TODO.
     ANSWERRECEIPT
     ANSWERAUDIT
     CHECKSEENBY
-    PATH3D
     IMPORTAREAFIX
     IMPORTSEENBY
-    AREAFIXREMOVE
     WEEKDAYNAMING
     ADDTID
     ALLOWRESCAN
@@ -58,6 +58,7 @@ TODO.
     JAM_LINK
     JAM_QUICKLINK
     JAM_MAXOPEN 5
+
     NETMAIL "NETMAIL" 637:1/999 JAM "/path/to/MagickaBBS/msgs/hpy_netmail"
 
     AREA "BAD" 637:1/999 JAM "/path/to/MagickaBBS/msgs/bad"
@@ -68,6 +69,115 @@ TODO.
     EXPORT %637:1/100.0
     GROUP A
 
+### General Configuration
+
+**SYSOP** This is your name
+
+**BBSNAME** This is the name of your BBS
+
+**BROADCAST** This is the address and port to send broadcast notifications to, if you're not using MagickaNotify on your LAN, **remove this line**.
+
+**LOGFILE** The file to use as a log.
+
+**LOGLEVEL** The amount of verbosity to use, 3 is normal, 1 is minimal and 6 is debug mode.
+
+**DUPEFILE** The name of the DUPE file, and the number of messages to store.
+
+**DUPEMODE** This can be **BAD** for moving dupes to a BAD area (defined later) **KILL** to kill them or **IGNORE** to pass them.
+
+**LOOPMODE** When magimail encounters a netmail stuck in a loop it can, **LOG** it, **LOG+BAD** log it and send it to the **BAD** area, or IGNORE it.
+
+**MAXPKTSIZE** The maximum size of a packet before magimail creates a new packet. In KB.
+
+**MAXBUNDLESIZE** The maximum size of a bundle of packets, In KB.
+
+**DEFAULTZONE** This is the default zone, if magimail can't figure out the zone any other way, it uses this.
+
+**INBOUND** The directory magimail looks for packets and bundles to toss.
+
+**OUTBOUND** The directory magimail writes flow files that tells binkd what files to send.
+
+**TEMPDIR** The directory magimail unpacks incoming bundles.
+
+**CREATEPKTDIR** Packets are created in this directory before they are moved to the **PACKETDIR**
+
+**PACKETDIR** This directory is where magimail stores bundles.
+
+**STATSFILE** This file stores stats about the usage of magimail. You can view the stats with the magistats utility.
+
+**FORCEINTL** Magimail should add an INTL line to netmails even if the sender and recipient are in the same zone.
+
+**ANSWERRECIPT** Magimail will honour recipt requests.
+
+**ANSWERAUDIT** Magimail will honour audit requests.
+
+**CHECKSEENBY** Magimail should never send a message to a node in the SEEN-BY lines.
+
+**IMPORTAREAFIX** Import magimail's areafix into the netmail area.
+
+**IMPORTSEENBY** Import seen-by lines.
+
+**WEEKDAYNAMING** Name bundles according to the weekday they were created.
+
+**ADDTID** Add a TID line to all messages exported by magimail.
+
+**ALLOWRESCAN** Allow nodes to rescan areas with Areafix.
+
+**INCLUDEFORWARD** Include all forward-requestable areas in the area lists generated by the Areafix.
+
+**ALLOWKILLSENT** Magimail will delete netmails that have the KILLSENT flag after they have been exported.
+
+### Group Names
+
+These are description for groups for use by areafix, there can be multiple entries.
+
+**GROUPNAME** This is the letter for the group and a description in quotation marks.
+
+### Packers
+
+Here you configure the external packers that CrashMail uses. %a stands for archive name and %f stands for file name. The recog string is used when CrashMail detects the packer used to pack a bundle. If the beginning of the bundle matches the recog string, CrashMail uses that packer. ? can be used as a wildcard and you can use $xx to specify a hexadecimal number.
+
+**PACKER** [name] [pack command] [unpack command] [recog]
+
+### AKA
+
+You can have multiple AKAs, these are your addresses given to you by networks.
+
+**AKA** A network address
+**DOMAIN** The domain for the network.
+
+### Nodes
+
+You should configure a node section for every node you export packets to, in a typical setup, there will only be one for your hub.
+
+**NODE** [address] [packer] [packet password] [flags] Flags in the example config are **AUTOADD** to automatically add areas you receive mail for, and **PACKNETMAIL** to pack netmail along with the echomail.
+
+**DEFAULTGROUP** The default group this node has access to.
+
+### Routing
+
+Netmails who's destination matches a pattern are routed to destination pattern using the specified AKA
+
+**ROUTE** [pattern] [destination pattern] [aka]
+
+### JAM Configuration Options
+
+**JAM_HIGHWATER** Use a highwater mark to speed up scanning.
+
+**JAM_LINK** Do reply-linking based on MSGID and REPLY after import.
+
+**JAM_QUICKLINK** Just compare the CRC of MSGID/REPLY when linking and don't read the strings from the messagebase. This makes linking quicker, but messages that don't match may be linked by mistake.
+
+**JAM_MAXOPEN** The maximum number of JAM areas opened at one time.
+
+### Areas
+
+**AREA/NETMAIL/LOCALAREA** [tagname] [aka] [messagebase] [path]
+
+**EXPORT** Nodes to export to.
+
+**GROUP** The letter of the group this area is in.
+
 ## Example magitoss.sh
 
     #!/bin/sh