Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

You can donate to the Synchronet project using PayPal.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
util:sbbsecho [2017/11/09 11:16] – [Using echocfg] Added SCFG section digital manutil:sbbsecho [2022/11/30 13:49] – Remove viewcvs link (no longer valid) digital man
Line 1: Line 1:
-====== SBBSecho ======+====== SBBSecho - FidoNet Tosser ======
    
 Synchronet's FidoNet EchoMail Program Synchronet's FidoNet EchoMail Program
  
 ===== Introduction ===== ===== Introduction =====
-SBBSecho is an FTN echomail program (tosser/scanner) for Synchronet BBS version 2.0 and higher. SBBSecho is not a [[resource:FidoNet mailer]] (you'll still need [[resource:fidonet_mailer|one of those]]).+SBBSecho is an FTN echomail program (tosser/scanner) for Synchronet BBS version 2.0 and higher. SBBSecho is not a [[resource:FidoNet mailer]] (you'll still need [[resource:fidonet_mailer|one of those]], e.g. [[module:BinkIT]]).
  
 As of SBBSecho v2.30 (Nov-2015), SBBSecho will also export FTN NetMail from the Synchronet mail base (''data/mail'' message base) to FTS-1 (''*.msg'') files. As of SBBSecho v2.30 (Nov-2015), SBBSecho will also export FTN NetMail from the Synchronet mail base (''data/mail'' message base) to FTS-1 (''*.msg'') files.
-  * This feature allows the gating of SMTP (Internet e-mail) to FTN netmail by sending email to "**//name//@p//<point>//.f//<node>//.n//<net>//.z//<zone>//.fidonet**" or "**//name//@.f//<node>//.n//<net>//.z//<zone>//.fidonet**". The [[server:Mail|Synchronet Mail Server]] rev 1.588 (Nov-24-2015) or later will accept email addressed in this manner and save the messages in the mail base as FidoNet netmail. +  * This feature allows the gating of SMTP (Internet e-mail) to FTN netmail by sending email to "**//name//@p//<point>//.f//<node>//.n//<net>//.z//<zone>//.fidonet**" or "**//name//@f//<node>//.n//<net>//.z//<zone>//.fidonet**". The [[server:Mail|Synchronet Mail Server]] rev 1.588 (Nov-24-2015) or later will accept email addressed in this manner and save the messages in the mail base as FidoNet netmail, when addressed to a local BBS user name or alias
-  * This feature allows FidoNet netmail to be sent using JavaScript methods (e.g. via the [[server:web|Synchronet Web Server]])+  * This feature allows FidoNet netmail to be sent using JavaScript methods (e.g. via the [[server:web|Synchronet Web Server]]) as well as [[util:smbutil]] and [[module:postmsg]].
  
 In 2016, SBBSecho was overhauled and christened //version 3//. The documentation here is in the process of being updated to reflect all the changes in SBBSecho version 3. For more details about SBBSecho version 3, see [[#Version 3]]. In 2016, SBBSecho was overhauled and christened //version 3//. The documentation here is in the process of being updated to reflect all the changes in SBBSecho version 3. For more details about SBBSecho version 3, see [[#Version 3]].
Line 14: Line 14:
 ===== Terminology ===== ===== Terminology =====
  
-The terminology used with FidoNet networking technology can be as confusing as it is particular. Here we attempt to define some terms we will be using through this article to describe the features and functions of SBBSecho.+The terminology used with FidoNet networking technology can be as confusing as it is particular. In our [[ref:FidoNet Glossary]] we attempt to define some terms we will be using through-out this article to describe the features and functions of SBBSecho. If you come across a term you aren't familiar with, please check the [[ref:FidoNet Glossary]].
    
-==== FTN ==== +===== Install =====
-FidoNet Technology Network: Any network using FidoNet standards for addressing, +
-mail packets, mail sessions, node lists, etc.+
  
-==== ZonesNetsNodes, and Points? ==== +SBBSecho and its configuration programEchoCfgcome with Synchronet BBS software (i.e. their executables can be found in your Synchronet ''[[dir:exec]]'' directory). So the program itself usually requires no special installation steps of its own.
-FTN node addresses are like phone numbers, they are made up of multiple +
-components (four usually, but sometimes three and sometimes five)+
  
-The main four components are: zonenet, node, and point. +Things you should have before you proceed: 
-Each component is specified by decimal (base-10number, separated by symbols +  - Your hub/uplink's FidoNet address 
-(no spaces):+  - Your hub/uplink's Internet hostname or IP address 
 +  - Your own FidoNet address (use ''<//zone//>:<//net//>/9999'' if you have not yet been assigned FidoNet address) 
 +  - Your hub-agreed-upon BinkP session password 
 +  - Your hub-agreed-upon packet password (optional) 
 +  Your hub-agreed-upon AreaFix password (optional
 +  - An //EchoList// file for the network (e.g. ''BACKBONE.NA'')
  
- Zone:Net/Node.Point+==== Message Group ==== 
  
-The zone represents the continent (if FidoNet) or the network number (if other +Create a message group called "FidoNet" (or whatever is most appropriate for the network) in [[util:SCFG]]->Message Areas: 
-FTN network). All FidoNet nodes in North America have a zone 1 address. When +<file> 
-the zone is specified in an address, it is the first component and must be +╔══════════════════════════════════════════════════════════╗ 
-followed by a colonIf the zone is not present in an address, the local +║                       FidoNet Group                      ║ 
-system's zone is assumed.+╠══════════════════════════════════════════════════════════╣ 
 +║ │Long Name                  FidoNet                      ║ 
 +║ │Short Name                 FidoNet                      ║ 
 +║ │Internal Code Prefix       FIDONET_                     ║ 
 +║ │Access Requirements                                     ║ 
 +║ │Sort Group by Sub-board    Index Position               ║ 
 +║ │Clone Options                                           ║ 
 +║ │Export Areas...                                         ║ 
 +║ │Import Areas...                                         ║ 
 +║ │Message Sub-boards...                                   ║ 
 +╚══════════════════════════════════════════════════════════╝
  
-The net represents the network number of the FTN node. Duplicate net numbers +</file>
-may exist between zones. If the net number is not present, the local system'+
-net is assumed.+
  
-The node number specifies an exact FTN node within a network. The node number +==== EchoList ====
-is the only required element of an FTN node address. +
-The point is an optional component which specifies a sub-node that does not +
-directly receive mail and is also not listed in the main FTN node list, but +
-instead gets all its mail from its boss-node (zone:net/node.0). When the point +
-is not specified, 0 (zero) is assumed (i.e. ''1:2/3'' and ''1:2/3.0'' are identical) +
-which indicates the system with that address is **not** a point node.+
  
-Zones can be grouped into named domains (e.g. ''@fidonet''), but FTN domains +Now, import a list of the public message areas ("echoes") from the network's standard EchoList (e.g. FidoNet'''BACKBONE.NA'' fileinto your new message group using the Message Group "Import Areas..." option in [[util:SCFG]]: 
-are pretty rarely used in the twenty-first century.+<file> 
 +╔═════════════════════════════════════════╗ 
 +║         Import Area File Format         ║ 
 +╠═════════════════════════════════════════╣ 
 +║ │subs.txt        Synchronet Sub-boards  ║ 
 +║ │control.dat     QWK Conference List    ║ 
 +║ │areas.bbs       Generic Area File      ║ 
 +║ │areas.bbs       SBBSecho Area File     ║ 
 +->│backbone.na     FidoNet EchoList      <- 
 +║ │badareas.lst    SBBSecho Bad Area List ║ 
 +╚═════════════════════════════════════════╝ 
 +</file>
  
-A 2D (2 dimensionaladdress refers to an FTN address containing just the +An alternative method is to instead subscribe/link to the echoes (on your hub/uplinkyou wish to carry on your BBS (e.g. via AreaFix request netmail message) and then as SBBSecho attempts to import received packets, it will add unknown areas to your ''[[dir:data]]/badareas.lst'' file. Import that file (''badareas.lst''into SCFG->Message Areas->FidoNetSBBSecho will automatically remove "known" areas from the ''badareas.lst'' file after they've been added to SCFG. You will lose some EchoMail messages using this scheme. 
-net and node numbers (e.g. ''103/705'').+===== Area File =====
  
-A 3D (3 dimensional) address refers to an FTN address containing the zone, +By default, SBBSecho will try to open an //Area File// (by default, ''[[dir:data]]/areas.bbs''). The Area File can be used to associate FidoNet EchoTags with sub-boards configured in [[util:SCFG]]->Message Areas. You can also specify downlinks and pass-through areas in an Area File, if need be. The Area File is optional, not strictly needed, when you have the "Automatically Add New Subs to Area List" option enabled and set to "List Only" in [[util:EchoCfg]]->EchoMail Settings.
-net, and node numbers (e.g. ''1:103/705''), specifically excluding the point number +
-if it exists.+
  
-A 4D (4 dimensional) address refers to an FTN address containing the zone, +To successfully operate without an Area Fileyou must have your hub configured in [[util:EchoCfg]]->Linked Nodes with its "Uplink for Message Groups" setting set to the //short name// of the message group you created for this network in [[util:SCFG]]->Message Areas.
-net, node, and optional point numbers (e.g. ''1:103/705.1'').+
  
-A 5D (5 dimensional) address refers to an FTN address consisting of a standard +You will need an Area File if you are to have any downlinks (nodes for which you are //their// hub to the network).
-3D or 4D address with an appended "@domain" (e.g. ''1:103/705@fidonet'').+
  
-==== Node ==== +[[util:SCFG]] can also export a group of message areas (sub-boards) to an SBBSecho-compatible Area File using the Message Group "Export Areas..." option: 
-All FidoNet node-listed systems are //nodes// of the network. +<file> 
- +╔═══════════════════════════════════════╗ 
-**Normal Nodes** do not have a //point// value, so a ''.0'' suffix on their address is implied. The addresses ''1:103/705'' and ''1:103/705.0'' are the same node, a normal node (sometimes also called a //boss node//). +║        Export Area File Format        ║ 
- +╠═══════════════════════════════════════╣ 
-**Point Nodes** (nodes with non-zero point value) may only directly connect and communicate with their //boss node//. The boss node of a point node with the address ''1:103/705.1'' would be ''1:103/705'' (the ''.0'' point value is implied). Point nodes are not listed in the network's official nodelist. Some network regions distribute a //pointlist// containing only point nodes. +║ │subs.txt       Synchronet Sub-boards ║ 
- +->│areas.bbs      SBBSecho Area File   <- 
-A **Boss Node** is just a normal node that has one or more //point nodes// for which they are responsible to deliver and receive messages and files. +║ │backbone.na    FidoNet EchoList      ║ 
- +╚═══════════════════════════════════════╝ 
-A **Linked Node** is a node which is linked with your system in some pre-arranged way and is reflected in your SBBSecho configuration (e.g. packet password, AreaFix password, packet type, archive type, etc.).  Linked Nodes may also be linked with one or more EchoMail message areas on your system as reflected in your Area File. +</file>
- +
-==== Uplink ==== +
- +
-An //Uplink// is a Linked Node which is your system's pre-arranged conduit to the rest of the message network (a.k.a. your hub). +
- +
-==== Downlink ==== +
- +
-A //Downlink// is a Linked Node which your system "feeds" messages and for which your system is responsible for routing received messages from. +
- +
-==== Attach or FLO Mailer? ==== +
- +
-If you are using FrontDoor, InterMail, D'bridge, SEAdog, Dutchie, or any other +
-ArcMail *.MSG attach-style mailer, you are using what we will refer to as an +
-"ArcMail/Attach-style Mailer". Support for ArcMail/Attach-style mailers has been deprecated in SBBSecho v3 and unless there is anyone coming forward to test what support does remain, it will be removed in the future. +
- +
-If you are using BinkD (Binkley daemon), Argus/Radius/Taurus, BinkleyTerm, Portal of Power, or any other mailer that uses Binkley-Style-Outbound (BSO) directories and FLO/CLO/HLO/DLO files (a.k.a. FLO-files), you are using what we will refer to as a "Binkley/FLO-Style Mailer"+
- +
-It is very important that you select the correct "Mailer Type" in the ''[[util:echocfg]]'' utility (or ''sbbsecho.ini'' file). +
- +
-==== NetMail ==== +
- +
-Point-to-point (usually person-to-person) directly-delivered or routed messages (now more commonly referred to as "e-mail" or just "mail"). +
- +
-==== EchoMail ==== +
- +
-Group or conference messages of a particular subject matter (a.k.a. Message Area). Usually +
-distributed on a regional or continental scale (e.g. FidoNet Zone 1 backbone). +
-FTN style echomail areas have a unique name associated with them to +
-distinguish each area from the others. These agreed upon area names are called //Area Tags// or //Echo Tags//. +
- +
-==== Toss ==== +
- +
-To //toss// EchoMail packets or messages means to //import// the packed messages into your BBS's local message bases where your users can read and reply to the messages. FidoNet EchoMail programs, like SBBSecho, are often referred to as "Tossers" for this reason. +
- +
-==== Scan ==== +
- +
-To //scan// message bases means to //export// locally-posted messages from your BBS's local message bases into EchoMail packets to be sent to your upstream link (hub) and any downstream linked nodes you may have. +
- +
-==== Packet ==== +
- +
-An FTN packet is a group of one or more messages contained in a single +
-uncompressed file. Packets may contain echomail and/or netmail messages. +
-Packets files usually have a ''.pkt'' extension, although outbound NetMail packets for +
-Binkley/FLO Mailers will have ''.?ut'' extensions (where ? is either ''o'', ''c'', ''d'', or ''h'', e.g ''.out'', ''.cut'', etc.). The +
-first eight characters of the filename may be anything, but are usually decimal or hexadecimal +
-digits representing the date and time the packet was created. +
- +
-You can use the [[person:digital man]]'s ''pktdump'' utility to view packet headers and help identify and fix problems with inbound and outbound packets. +
- +
-=== Bad Packet === +
-If SBBSecho cannot process an inbound packet file, it will rename the file, giving it a ''.bad'' extension. Checking the SBBSecho log file  (e.g. ''[[dir:data]]/sbbsecho.log'') for the reason for the ''Bad packet detected'', if you can then remedy the problem and rename the ''*.bad'' files to ''*.pkt'', SBBSecho will rediscover and attempt to re-process the packet files. Alternatively, you can just delete ''.bad'' packets and perform a hub re-scan if you expect the packets contain only EchoMail (no NetMail) and you want the missing EchoMail messages from the packets.  +
- +
-== Identifying Bad Packets == +
- +
-  - File length is shorter than a packet header (58 bytes) +
-  - Packet terminator (''0x0000'', 2 NUL bytes) missing from end of the file +
-  - File read failure (e.gpermissions or file locking issue) +
-  - Source address does not match expected address (e.g. for packets found in //inboxes//+
-  - Packet header cannot be parsed (e.g. is not a ''type 2'' packet header) +
-  - Packet header contains incorrect packet password +
-  - Packet contains one or more "grunged messages" (e.g. packed //message type// is not ''2'') +
-==== Bundle ==== +
- +
-An FTN bundle is a single file archive of one or more (usually compressed) +
-packets. Bundles will have file extensions where the first two characters +
-represent the day of the week the bundle was created (MO, TU, WE, TH, FR, SA, +
-and SU) and the third character of the extension is a number or letter. The +
-first eight characters of the filename may be anything, but are usually +
-hexadecimal digits representing the FTN node address (or relative address) of +
-the system that created the bundleSBBSecho changes the file extension of bad +
-inbound bundles to ''.?_?'' or ''.?-?'' (e.g. ''*.mo0'' would be renamed to ''*.m_0''). +
- +
-==== AreaFix/Area Manager ==== +
- +
-AreaFix is a synonym for area manager (the very first FTN area manager +
-program was called "AreaFix"). Area manager capabilities (remote adding/removing +
-of areas, changing compression type, etc) are built into SBBSecho, so therefore +
-no external area manager program is requiredIf you are not an FTN hub, then +
-the area manager portion of SBBSecho will probably not get much use on your +
-system+
- +
- +
-===== Installation ===== +
- +
-SBBSecho expects to find an area file (e.g. ''areas.bbs'') in your Synchronet ''[[dir:data]]'' +
-directory. You will need to create the Area File in order for SBBSecho to do anything with EchoMail message areas.+
  
-[[util:SCFG]] can also export a group of message areas (sub-boardsto an SBBSecho-compatible Area File+If the ''AutoAddSubs'' feature is enabled, sub-boards configured in SCFG->Message Areas may be //automatically// added to your Area File when the network hub (your uplinkhas be configured in EchoCfg->Linked Nodes and the "Group Hub" setting for that link set to the name of the corresponding message group in SCFG->Message Areas. This Auto-Add procedure happens during SBBSecho initialization and is not dependent upon receiving any echomail messages for the configured message areas.
-You may want to import a network's EchoList (e.g. FidoNet's ''BACKBONE.NA''into a message group (using [[util:SCFG]]) first and then export the networked message group(s) from [[util:SCFG]] to the SBBSecho-compatible Area File once you're linked successfully with your network hub.+
  
-===== Area File Format =====+==== Format ====
  
 Each line of the SBBSecho Area File (e.g. ''areas.bbs'') represents an EchoMail message //area// in the following format: Each line of the SBBSecho Area File (e.g. ''areas.bbs'') represents an EchoMail message //area// in the following format:
Line 170: Line 93:
 Where each field is separated by white-space (space or tab characters) and the fields are: Where each field is separated by white-space (space or tab characters) and the fields are:
  
-==== CODE ====+=== CODE ===
 The ''CODE'' field is the internal code of the sub-board. The ''CODE'' field is the internal code of the sub-board.
  
 Internal codes consist of a combination of the Message Group's "code prefix" and the Sub-board's "code suffix". The full internal code may be as long as 16 characters and may not contain white-space or any invalid filename characters. Internal codes consist of a combination of the Message Group's "code prefix" and the Sub-board's "code suffix". The full internal code may be as long as 16 characters and may not contain white-space or any invalid filename characters.
  
-=== Pass-through Areas ===+== Pass-through Areas ==
 Any unrecognized internal codes are considered //pass-through// (not imported into your BBS's message areas). Using "''P''" for the internal code of pass-through areas will prevent warnings from being logged about the internal code not being found in your BBS's message base configuration (i.e. in ''[[util:SCFG]]''->Message Areas). Any unrecognized internal codes are considered //pass-through// (not imported into your BBS's message areas). Using "''P''" for the internal code of pass-through areas will prevent warnings from being logged about the internal code not being found in your BBS's message base configuration (i.e. in ''[[util:SCFG]]''->Message Areas).
  
-==== TAG ====+=== TAG ===
 The ''TAG'' field is the FTN area tag (or echo tag) as shown in your FTN network's agreed upon echo list file (e.g. ''BACKBONE.NA'' for the FidoNet North American backbone). Area tags may not contain white-space characters. The ''TAG'' field is the FTN area tag (or echo tag) as shown in your FTN network's agreed upon echo list file (e.g. ''BACKBONE.NA'' for the FidoNet North American backbone). Area tags may not contain white-space characters.
  
-=== Long Tags === +== Long Tags == 
-Although standard FidoNet echo tags may be as long as 35 characters, Synchronet's Sub-board //short names// are limited to 25 characters. When importing and exporting FTN areas (e.g. to/from ''areas.bbs'' or EchoList files), usually the echo tag is copied to or derived from the associated Sub-board'short name. For this reasonecho tags longer than 25 characters in length may present problem for some import/export or auto-create scenarios.+Although standard FidoNet echo tags (AKA "area tag"may be as long as 35 characters, Synchronet's Sub-board //short names// are limited to a length of 25 characters. As of July 28, 2018, Synchronet v3.17a will import (e.g. from ''BACKBONE.NA'' file) echo tags longer than 25 characters into the "Newsgroup" name of the sub-board. Each sub-board'"Newsgroup" name can accommodate a length of up to 63 characters (no spaces)Likewisewhen exporting message areas from SCFG or SBBSecho (e.g. to an ''areas.bbs'' file), if "Newsgroup" name is defined for a message area, it will be used for the exported echo tag of that exported area.
  
-=== Bad Echo Area ===+== Bad Echo Area ==
  
 If an area's ''TAG'' field value is a ''*'' (asterisk), then the area will be considered a "bad echo" area and will receive all messages for areas not otherwise specified in this file (sort of a 'catch-all' bin for 'unknown' areas). You can have **only one** "bad echo" area configured in your Area File. To //re-toss// (move) messages from the "bad echo" area into newly added or linked sub-boards, run SBBSecho with the ''-r'' command-line option.  If an area's ''TAG'' field value is a ''*'' (asterisk), then the area will be considered a "bad echo" area and will receive all messages for areas not otherwise specified in this file (sort of a 'catch-all' bin for 'unknown' areas). You can have **only one** "bad echo" area configured in your Area File. To //re-toss// (move) messages from the "bad echo" area into newly added or linked sub-boards, run SBBSecho with the ''-r'' command-line option. 
  
-==== LINK ====+=== LINK ===
 Each ''LINK'' field is an FTN address which you wish to import mail from and export mail to. At the very least, your uplink's (hub's) address should be listed here. Your address should **NOT** be listed here. If multiple link fields are specified, you should specify the full 3D or 4D address for each. Links can be remotely added or removed from the Area File by authenticated Nodes using AreaFix. Each ''LINK'' field is an FTN address which you wish to import mail from and export mail to. At the very least, your uplink's (hub's) address should be listed here. Your address should **NOT** be listed here. If multiple link fields are specified, you should specify the full 3D or 4D address for each. Links can be remotely added or removed from the Area File by authenticated Nodes using AreaFix.
  
 Lines beginning with a semicolon (;) are considered comments, and are ignored. Lines beginning with a semicolon (;) are considered comments, and are ignored.
-==== Area File Example ====+==== Example ====
  
 <file> <file>
Line 200: Line 123:
 </file> </file>
  
-The amount of spacing (white-space characters including horizontal tabs and spaces) between each element in the line is not important. Each +The amount of spacing (white-space characters including horizontal tabs and spaces) between each element in the line is not important. Each line may be up to 1024 characters in length.
-line may be up to 1024 characters in length.+
  
-===== Configuration =====+===== Configure =====
    
-In order to set up SBBSecho for your system you must run the included ''[[util:echocfg]]'' utility (highly recommended) or edit your ''[[dir:ctrl]]/sbbsecho.ini'' configuration (text) file by hand.+In order to set up SBBSecho for your system you must
 +  - Configure your fundamental FTN settings (e.g. system address) in [[util:SCFG]]->Networks->FidoNet. 
 +  - Use the ''[[util:EchoCfg]]'' utility (highly recommended) or edit your ''[[dir:ctrl]]/sbbsecho.ini'' configuration (text) file by hand
  
 ==== SCFG ==== ==== SCFG ====
Line 215: Line 139:
 ╠══════════════════════════════════════════════════════════╣ ╠══════════════════════════════════════════════════════════╣
 ║ │System Addresses                                        ║ ║ │System Addresses                                        ║
-║ │Default Outbound Address   No                           ║ 
 ║ │Default Origin Line                                     ║ ║ │Default Origin Line                                     ║
 ║ │NetMail Semaphore          %jfidoout.now                ║ ║ │NetMail Semaphore          %jfidoout.now                ║
 ║ │EchoMail Semaphore         %jfidoout.now                ║ ║ │EchoMail Semaphore         %jfidoout.now                ║
-║ │NetMail Directory          /sbbs/netmail\               ║ +║ │NetMail Directory          ../fido/netmail/             ║ 
-║ │Allow Sending of NetMail   No                           ║ +║ │Allow Sending of NetMail   Yes                          ║ 
-║ │Allow File Attachments     Yes                          +║ │Allow File Attachments     No                           
 ║ │Send NetMail Using Alias   No                           ║ ║ │Send NetMail Using Alias   No                           ║
 ║ │NetMail Defaults to Crash  No                           ║ ║ │NetMail Defaults to Crash  No                           ║
Line 231: Line 154:
 </file> </file>
  
-The settings used by SBBSecho include:+The settings from this SCFG menu used by SBBSecho include:
  
   * System Addresses (Main and AKAs)   * System Addresses (Main and AKAs)
Line 237: Line 160:
   * Default Origin Line   * Default Origin Line
  
-At the minimum, you will need to configure your //Main// FTN system address here.+At the minimum, you will need to configure your //Main// FTN System Address here.
  
-SBBSecho also expected to find the file ''areamgr.hlp'' in the [[dir:exec]] directory defined in SCFG->System->Advanced Options.+=== System Addresses === 
 +Set your main/primary FidoNet address and AKAs (secondary/othernet FTN addresses) here. If you only have a temporary address, set your //Main// address to that value. 
 + 
 +Only 3D (zone:net/node) and 4D (zone:net/node.point) addresses are supported in this setting. 
 + 
 +=== NetMail Directory === 
 +This is the path to a directory on your local system where both inbound and outbound FTN NetMail will be stored. The only files placed in this directory should be FTN [[ref:fidonet_files#stored_message|Stored Messages]] (''*.msg'' format). 
 + 
 +Synchronet can create ''*.msg'' files in this directory when sending NetMail from the terminal server. 
 + 
 +SBBSecho will create ''*.msg'' files in this directory when creating NetMail messages (e.g. auto-responding to ''PING'' or ''AreaFix'' requests, notices to the //Area Manager//, or exporting NetMail from the "mail" msgbase) or unpacking NetMail from inbound [[ref:fidonet_files#packet|Packets]]. SBBSecho will discover ''*.msg'' files in this directory when Packing outbound NetMail, importing into the "mail" msgbase, or handling AreaFix and PING requests. 
 + 
 +The other NetMail-related settings on this [[util:SCFG]] menu affect only FidoNet NetMail messages created by users of the Synchronet [[:server:Terminal]] Server; they are not used by SBBSecho. 
 + 
 +=== Default Origin Line === 
 +Standard FTN EchoMail messages contain a terminating ''* Origin'' line. The default Origin Line, or at least the portion between the ''* Origin'' prefix and your system's address in parenthesis, is configured here. You do not have to enter an Origin Line here, but it is customary to enter the name, hostname or IP address and/or phone number of your BBS here. SBBSecho will use the text in this setting as the default Origin Line to append to outbound EchoMail messages (posted locally or gated from other network technologies). 
 + 
 +It is possible to over-ride this default Origin Line for specific message areas (sub-boards), if so desired by the sysop. 
 + 
 +=== Inbound File Directory === 
 +Older versions of SCFG (e.g. v3.16) contained this FidoNet setting which was used to specify the directory where non-secure inbound FidoNet files would be received by your FTN mailer. SBBSecho v2 used this setting, however Synchronet itself did not, so it was deprecated with SBBSecho v3  (replaced with the ''Non-secure Inbound Directory'' setting in EchoCfg/''[[config:sbbsecho.ini]]'' and removed from future versions of [[SCFG]]).
  
  
 ==== EchoCfg ==== ==== EchoCfg ====
  
-The SBBSecho Config program (echocfg) is the program used to configure all the SBBSecho-specific settings saved exclusively in the SBBSecho configuration file (''[[config:sbbsecho.ini]]'').+The SBBSecho Config program (''echocfg'') is the program used to configure all the SBBSecho-specific settings saved exclusively in the SBBSecho configuration file (''[[config:sbbsecho.ini]]'').
  
 === Command-line Syntax === === Command-line Syntax ===
Line 282: Line 225:
 <code> <code>
 ╔═════════════════════════╗ ╔═════════════════════════╗
-║    Configure SBBSecho   +║    Configure FidoNet    
 ╠═════════════════════════╣ ╠═════════════════════════╣
 ║ │Global Settings...     ║ ║ │Global Settings...     ║
Line 290: Line 233:
 ║ │EchoMail Settings...   ║ ║ │EchoMail Settings...   ║
 ║ │Paths and Filenames... ║ ║ │Paths and Filenames... ║
 +║ │Domains...             ║
 ║ │EchoLists...           ║ ║ │EchoLists...           ║
 ╚═════════════════════════╝ ╚═════════════════════════╝
 +
 </code> </code>
  
-==== Saving Changes ====+=== Saving Changes ===
 When any unsaved changes have been made to the configuration, an additional option appears allowing you to save the changes to the configuration file: When any unsaved changes have been made to the configuration, an additional option appears allowing you to save the changes to the configuration file:
 <code> <code>
Line 312: Line 257:
 EchoCfg will normally automatically make a backup of an existing configuration file before over-writing it. For example, ''[[dir:ctrl]]/sbbsecho.0.ini'' will be the most recently backed-up version of ''sbbsecho.ini''. This feature can be disabled if so desired by setting ''Config File Backups'' to ''0''. EchoCfg will normally automatically make a backup of an existing configuration file before over-writing it. For example, ''[[dir:ctrl]]/sbbsecho.0.ini'' will be the most recently backed-up version of ''sbbsecho.ini''. This feature can be disabled if so desired by setting ''Config File Backups'' to ''0''.
  
-==== Global Settings ====+=== Global Settings ===
 <code> <code>
-╔══════════════════════════════════════════════╗ +═══════════════════════════════════════════════════╗ 
-║                Global Settings               ║ +║                  Global Settings                  ║ 
-╠══════════════════════════════════════════════╣ +═══════════════════════════════════════════════════╣ 
-║ │Mailer Type               Binkley/FLO       ║ +║ │Mailer Type                    Binkley/FLO       ║ 
-║ │Log Level                 Informational     ║ +║ │Log Level                      Debugging         ║ 
-║ │Log Timestamp Format      %m/%d/%y %H:%M:%S ║ +║ │Log Timestamp Format           %m/%d/%y %H:%M:%S ║ 
-║ │Strict Packet Passwords   Enabled           ║ +║ │Strict Packet Passwords        Enabled           ║ 
-║ │Use FTN Domain/Zone Map   Disabled          ║ +║ │Config File Backups            10                ║ 
-║ │BSY Mutex File Timeout    12 hours          ║ +║ │Minimum Free Disk Space        10G bytes         ║ 
-║ │BSO Lock Attempt Delay    10 seconds        ║ +║ │Strip Incoming Soft CRs        No                ║ 
-║ │BSO Lock Attempt Limit    60                ║ +║ │Strip Outgoing Line Feeds      No                ║ 
-║ │Config File Backups       100               ║ +║ │Use Outboxes for Mail Files    Yes               ║ 
-╚══════════════════════════════════════════════╝+║ │BSY Mutex File Timeout         12 hours          ║ 
 +║ │BSO Lock Attempt Delay         10 seconds        ║ 
 +║ │BSO Lock Attempt Limit         60                ║ 
 +║ │BinkP Capabilities                               ║ 
 +║ │BinkP Sysop Name               Your Name         ║ 
 +║ │BinkP Authentication           Plain or CRAM-MD5 ║ 
 +║ │BinkP Encryption               Supported         ║ 
 +═══════════════════════════════════════════════════╝
 </code> </code>
 === Mailer Type === === Mailer Type ===
Line 338: Line 290:
 Selecting this menu item will toggle between the mailer types supported Selecting this menu item will toggle between the mailer types supported
 by SBBSecho, either ArcMail/Attach-style mailers or (the preferred) Binkley/FLO-style mailers.  Choose the one that matches your FTN by SBBSecho, either ArcMail/Attach-style mailers or (the preferred) Binkley/FLO-style mailers.  Choose the one that matches your FTN
-mailer type.+mailer type (e.g. [[module:BinkIT]] is a Binkley/FLO-style mailer).
  
-=== Log Level ===+== Log Level ==
 The //Log Level// menu option will allow you to determine the minimum severity of log entries that will be written to your SBBSecho log file (e.g. ''[[dir:data]]/sbbsecho.log''): The //Log Level// menu option will allow you to determine the minimum severity of log entries that will be written to your SBBSecho log file (e.g. ''[[dir:data]]/sbbsecho.log''):
  
Line 360: Line 312:
 Log Level should normally be set to ''Informational'' but if you're          Log Level should normally be set to ''Informational'' but if you're         
 experiencing problems with SBBSecho and would like more verbose log  experiencing problems with SBBSecho and would like more verbose log 
-output, set this to Debugging. If you want less verbose logging,    +output, set this to ''Debugging''. If you want less verbose logging,    
 set to higher-severity levels to reduce the number of log messages.  set to higher-severity levels to reduce the number of log messages. 
  
-=== Log Timestamp Format ===+== Log Timestamp Format ==
 Log Timestmap Format defines the format of the date/time-stamps added   Log Timestmap Format defines the format of the date/time-stamps added  
 along with each log message to the log file (e.g. ''sbbsecho.log'').    along with each log message to the log file (e.g. ''sbbsecho.log'').   
-The timestamp format is defined using standard C ''strftime'' notation.+The timestamp format is defined using standard C ''[[custom:strftime]]'' notation.
 The default format is: ''%Y-%m-%d %H:%M:%S''           The default format is: ''%Y-%m-%d %H:%M:%S''          
 For SBBSecho v2 timestamp format, use ''%m/%d/%y %H:%M:%S''            For SBBSecho v2 timestamp format, use ''%m/%d/%y %H:%M:%S''           
  
-=== Strict Packet Passwords ===+== Strict Packet Passwords ==
 Strict Packet Passwords, when enabled, requires that Packet Passwords   Strict Packet Passwords, when enabled, requires that Packet Passwords  
 must match the password for the linked-node from which the packet   must match the password for the linked-node from which the packet  
Line 378: Line 330:
 Default: Enabled                                                    Default: Enabled                                                   
  
-=== Use FTN Domain/Zone Map === +== BSY Mutex File Timeout ==
-Use FTN Domain/Zone Map, when enabled, uses the configuration file    +
-''ctrl/ftn_domains.ini'' to determine the mapping between FTN domains +
-and FTN zones and the relevant BSO outbound directory.            +
-Default: Disabled                                                 +
- +
-=== BSY Mutex File Timeout ===+
 BSY Mutex File Timeout determines the maximum age of an existing       BSY Mutex File Timeout determines the maximum age of an existing      
 mutex file (*.bsy) before SBBSecho will act as though the mutex    mutex file (*.bsy) before SBBSecho will act as though the mutex   
Line 392: Line 338:
 Default: 12 hours                                                  Default: 12 hours                                                 
  
-=== BSO Lock Attempt Delay ===                                                                      +== BSO Lock Attempt Delay ==                                                                      
 BSO Lock Attempt Delay determines the amount of time between BSO       BSO Lock Attempt Delay determines the amount of time between BSO      
 node lock attempts (via *.bsy files in the relevant outbound       node lock attempts (via *.bsy files in the relevant outbound      
Line 398: Line 344:
 Default: 10 seconds                                                Default: 10 seconds                                               
  
-=== BSO Lock Attempt Limit ===                                                                      +== BSO Lock Attempt Limit ==                                                                      
 BSO Lock Attempt Limit determines the maximum number of BSO node lock  BSO Lock Attempt Limit determines the maximum number of BSO node lock 
 attempts before SBBSecho will give-up and move on to another node  attempts before SBBSecho will give-up and move on to another node 
Line 405: Line 351:
 Default: 60 attempts                                               Default: 60 attempts                                              
  
-=== Config File Backups === +== Config File Backups == 
 Config File Backups determines the number of automatic backups of your  Config File Backups determines the number of automatic backups of your 
 SBBSecho configuration file (e.g. ''sbbsecho.ini'') that will be        SBBSecho configuration file (e.g. ''sbbsecho.ini'') that will be       
 maintained by SBBSecho Config and SBBSecho AreaFix.                 maintained by SBBSecho Config and SBBSecho AreaFix.                
  
-==== Linked Nodes ====+== BinkP Capabilities == 
 +Set this value if you need to override the the text in the BinkP ''M_NUL NDL'' line, from the default of "115200,TCP,BINKP"
 + 
 +== BinkP Sysop Name == 
 +Set this value if you'd like to over-ride the BinkP Sysop Name (''ZYZ'') value (e.g. to send the sysop's real name, rather than alias). 
 + 
 +=== Linked Nodes ===
 This menu item allows you to add, remove, and configure nodes that you This menu item allows you to add, remove, and configure nodes that you
 will be sending mail to and accepting mail from.  Selecting this option will bring you to will be sending mail to and accepting mail from.  Selecting this option will bring you to
Line 426: Line 378:
 add a new node, pressing the DELete key will remove the currently add a new node, pressing the DELete key will remove the currently
 highlighted node. A //Node// here does not necessarily identify a single FidoNet node, but can also be used to identify a group of nodes by using the ''ALL'' wildcard (indicating that a node configuration will be used for *all* nodes with a specific zone or zone:net). highlighted node. A //Node// here does not necessarily identify a single FidoNet node, but can also be used to identify a group of nodes by using the ''ALL'' wildcard (indicating that a node configuration will be used for *all* nodes with a specific zone or zone:net).
 +
 +**Note:**\\
 +The hexadecimal numbers in parentheses are provided as an aide when correlating FidoNet files and BSO directories with node numbers.   
 <code> <code>
-╔═══════════════════════════════════╗ +══════════════════════════════════════════════════╗ 
-║            Linked Nodes           ║ +║                   Linked Nodes                   ║ 
-╠═══════════════════════════════════╣ +══════════════════════════════════════════════════╣ 
-║ │2:280/464                        ║ +║ │ALL                          Everyone           ║ 
-║ │3:712/848                        ║ +║ │21:ALL           (.015)      fsxNet             ║ 
-║ │1:218/700                        ║ +║ │1:218/700        (00da02bc)  Kurt Weiske        ║ 
-║ │ALL                     Everyone ║ +║ │3:712/848        (02c80350)  Scott Little       ║ 
-║ │                                 ║ +║ │2:280/464        (011801d0)  Wilfred van Velzen ║ 
-╚═══════════════════════════════════╝+║ │1:124/5016       (007c1398)  Nigel Reed         ║ 
 +║ │1:153/757        (009902f5)  Al                 ║ 
 +║ │1:320/219        (014000db)                     ║ 
 +║ │1:320/119        (01400077)                     ║ 
 +║ │21:1/100         (00010064)  Paul Hayton (Avon) ║ 
 +║ │                                                ║ 
 +══════════════════════════════════════════════════╝
 </code> </code>
  
-Pressing ENTER on the currently+Pressing ENTER on currently
 highlighted node will allow you to edit the settings for that particular highlighted node will allow you to edit the settings for that particular
 node from a menu like the following (note that the node number you are node from a menu like the following (note that the node number you are
Line 445: Line 406:
 <code> <code>
 ╔═════════════════════════════════════════════╗ ╔═════════════════════════════════════════════╗
-║          Linked Node - Kurt Weiske          +║           Linked Node - 1:218/700           
 ╠═════════════════════════════════════════════╣ ╠═════════════════════════════════════════════╣
 ║ │Address                        1:218/700   ║ ║ │Address                        1:218/700   ║
-║ │Comment                        Kurt Weiske ║+║ │Domain                         fidonet     ║ 
 +║ │Name                           Kurt Weiske ║ 
 +║ │Comment                                    
 ║ │Archive Type                   ZIP         ║ ║ │Archive Type                   ZIP         ║
 ║ │Packet Type                    2+          ║ ║ │Packet Type                    2+          ║
 ║ │Packet Password                            ║ ║ │Packet Password                            ║
 +║ │Session Password                           ║
 ║ │TIC File Password                          ║ ║ │TIC File Password                          ║
 +║ │AreaFix Support                Yes         ║
 ║ │AreaFix Password                           ║ ║ │AreaFix Password                           ║
-║ │AreaFix Keys                               +║ │EchoList Keys                              
 ║ │Status                         Normal      ║ ║ │Status                         Normal      ║
 ║ │Direct                         No          ║ ║ │Direct                         No          ║
Line 460: Line 425:
 ║ │Send Notify List               No          ║ ║ │Send Notify List               No          ║
 ║ │Uplink for Message Groups      FidoNet     ║ ║ │Uplink for Message Groups      FidoNet     ║
 +║ │Local Address (AKA)            Best Match  ║
 ║ │Route To                       Disabled    ║ ║ │Route To                       Disabled    ║
 ║ │Inbox Directory                            ║ ║ │Inbox Directory                            ║
 ║ │Outbox Directory                           ║ ║ │Outbox Directory                           ║
 +║ │BinkP Settings...                          ║
 ╚═════════════════════════════════════════════╝ ╚═════════════════════════════════════════════╝
 </code> </code>
  
-=== Address ===+== Address ==
 This is the address of the node you are editing, selecting it This is the address of the node you are editing, selecting it
 will allow you to change this to a different address. Using will allow you to change this to a different address. Using
Line 475: Line 442:
 as ''1:103/ALL''). as ''1:103/ALL'').
  
-=== Comment ===+== Comment ==
 Comment is a note to yourself about this node. Setting this to the   Comment is a note to yourself about this node. Setting this to the  
 user or sysop name corresponding with the configured node can be user or sysop name corresponding with the configured node can be
 a helpful reminder to yourself later.                            a helpful reminder to yourself later.                           
  
-=== Archive Type ===+== Archive Type ==
 Archive Type is the name of an archive type corresponding with one of   Archive Type is the name of an archive type corresponding with one of  
 your configured archive types or 'None' This archive type will    your configured archive types or 'None' This archive type will   
Line 515: Line 482:
  
  
-=== Packet Type === +== Packet Type == 
-This is the packet type that will be used when creating mail+This is the type of [[ref:fidonet packets]] that will be used when creating mail
 packets for this node. The default packet type used by SBBSecho packets for this node. The default packet type used by SBBSecho
-is 2+. If you are a "point" address (e.g. ''1:100/100.1'') you +is 2+. If you are a "point" address (e.g. ''1:100/100**.1**'') you 
-should use either a type 2+ or 2.2 packet since type 2 packets+should use either a type 2+, 2e, or 2.2 packet since type 2 packets
 do not support point numbers. Selecting this option will allow do not support point numbers. Selecting this option will allow
 you to choose from a menu of currently supported packet types: you to choose from a menu of currently supported packet types:
- 
 <code> <code>
 ╔═════════════╗ ╔═════════════╗
Line 534: Line 500:
 </code> </code>
  
-=== Packet Password ===+== Packet Password ==
 Packet Password is an optional password that may be added to outbound    Packet Password is an optional password that may be added to outbound   
 packets for this node.  Incoming packet passwords are compared with  packets for this node.  Incoming packet passwords are compared with 
Line 542: Line 508:
 This setting may be managed by the node using AreaFix requests.      This setting may be managed by the node using AreaFix requests.     
  
-=== TIC File Password ===+== Session Password == 
 +When using [[module:BinkIT]] as your mailer, this setting will determine the BinkP session password used when communicating with this linked node. 
 + 
 +== TIC File Password ==
 TIC File Password is an optional password that may be configured here  TIC File Password is an optional password that may be configured here 
 (and in your sbbsecho.ini file) for use by ticket.js when creating (and in your sbbsecho.ini file) for use by ticket.js when creating
Line 548: Line 517:
 This setting may be managed by the node using AreaFix requests.    This setting may be managed by the node using AreaFix requests.   
  
-=== AreaFix Password === +== AreaFix Support =
-AreaFix Password is an optional password used to enable AreaFix      +Remote area management (via AreaFix requests from this linked node) may be enabled (set to Yes) or disabled (set to No) using this menu option. 
-NetMail requests (Remote Area Managementfrom this node      + 
 +== AreaFix Password == 
 +AreaFix passwords are required to be included in the //Subject// line of received AreaFix requests (NetMail messages).
 AreaFix Passwords are case insensitive.                          AreaFix Passwords are case insensitive.                         
 This setting may be managed by the node using AreaFix requests.  This setting may be managed by the node using AreaFix requests. 
  
-=== Areafix Keys ===+== EchoList Keys ==
 When echo lists have been defined (from the When echo lists have been defined (from the
 'EchoLists...' sub-menu) these keys determine 'EchoLists...' sub-menu) these keys determine
 which EchoLists can be used by this node when processing Area Manager add requests. which EchoLists can be used by this node when processing Area Manager add requests.
  
-=== Status ===+== Status ==
 This option determines the netmail status that will be set This option determines the netmail status that will be set
 when SBBSecho sends out an areafix message or a file attach. when SBBSecho sends out an areafix message or a file attach.
Line 565: Line 536:
 status. status.
  
-=== Direct ===+== Direct ==
 When set to ''Yes'' this option will add a Direct kludge line When set to ''Yes'' this option will add a Direct kludge line
 to messages that SBBSecho sends out (or create DLO/DUT files to messages that SBBSecho sends out (or create DLO/DUT files
 for FLO mailers). for FLO mailers).
  
-=== Passive ===+== Passive ==
 Setting this option to 'Yes' will prevent messages from being Setting this option to 'Yes' will prevent messages from being
 sent to this node without the need for altering the Area sent to this node without the need for altering the Area
Line 577: Line 548:
 via an area manager request. via an area manager request.
  
-=== Send Notify List ===+== Send Notify List ==
 This determines whether or not this node is sent a Notify List This determines whether or not this node is sent a Notify List
 when using that command line option in SBBSecho. when using that command line option in SBBSecho.
Line 584: Line 555:
 areas. areas.
  
-=== Uplink for Message Groups ===+== Uplink for Message Groups ==
 Uplink for Message Groups is an optional list of Message Groups (short  Uplink for Message Groups is an optional list of Message Groups (short 
 names) for which this node is a hub/uplink for your system.  This   names) for which this node is a hub/uplink for your system.  This  
Line 590: Line 561:
 to auto-link hubs with the newly added areas in your Area File.     to auto-link hubs with the newly added areas in your Area File.    
  
-=== Route To ===+== Route To ==
 When configured for Binkley/FLO-style mailers, this option allows any mail sent to nodes matching this node entry's address (including the ''ALL'' wildcard matches), to be routed to a different address (e.g. your uplink/hub's address). This option is particularly useful for routed NetMail. When configured for Binkley/FLO-style mailers, this option allows any mail sent to nodes matching this node entry's address (including the ''ALL'' wildcard matches), to be routed to a different address (e.g. your uplink/hub's address). This option is particularly useful for routed NetMail.
  
 Attach-style mailers have their own routing configuration and that is why this option is not available in ''echocfg'' when configured for FrontDoor/Attach-style mailers. Attach-style mailers have their own routing configuration and that is why this option is not available in ''echocfg'' when configured for FrontDoor/Attach-style mailers.
  
-=== Inbox Directory ===+== Inbox Directory ==
 Inbox Directory is only used in BSO operating mode and is an optional Inbox Directory is only used in BSO operating mode and is an optional
-alternate directory to search for incoming files from this node   +alternate directory to search for incoming files from this node 
-(e.g. used in combination with BinkD's ibox setting).            +(e.g. used in combination with BinkD'''ibox'' setting).
  
-=== Outbox Directory === +Note: [[module:BinkIT]] does **not support** inboxes at this time. 
-Outbox Directory is only used in BSO operating mode and is an optional  + 
 +== Outbox Directory == 
 +Outbox Directory is only used in BSO operating mode and is an optional
 alternate directory to place outbound files for this node (e.g. used alternate directory to place outbound files for this node (e.g. used
-in combination with BinkD's obox setting).                          +in combination with BinkD'''obox'' setting). 
 + 
 +Note: [[module:BinkIT]] has //experimental support// for outboxes at this time. 
 + 
 +== BinkP Settings == 
 + 
 +BinkP Settings are settings specific to BinkP/BinkIT mailer operation. 
 + 
 +<file> 
 +╔═════════════════════════════════════╗ 
 +║       1:218/700 BinkP Settings      ║ 
 +╠═════════════════════════════════════╣ 
 +║ │Host                               ║ 
 +║ │Port                 24554         ║ 
 +║ │Poll                 Yes           ║ 
 +║ │Authentication       CRAM-MD5 Only ║ 
 +║ │Encryption           Supported     ║ 
 +║ │Source Address                     ║ 
 +╚═════════════════════════════════════╝ 
 +</file> 
 + 
 +**Host** defines the TCP/IP address or host name with which to connect for sessions with this linked node.  If the host is not set, then a DNS-based look-up will be attempted (e.g. the IP address for 1:103/705 would be looked-up via host name f705.n103.z1.binkp.net). Nodelist-based look-ups are also supported.                          
 +                                                                         
 +**Port** defines the TCP port used by this linked node for BinkP sessions. The default BinkP TCP port is 24554.                                 
 +                                                                         
 +**Poll** defines whether or not to periodically poll this linked node. 
 + 
 +**Authentication** determines what types of authentication will be supported during both inbound and outbound sessions with this linked node. The supported BinkP-auth methods are //Plain-Password// and //CRAM-MD5//
 +                                                                         
 +**Encryption** determines whether unencrypted data transfers will be supported or required when communicating with this linked node. With this setting set to ''Required'', only BinkD-style-encrypted BinkP sessions will be supported. //CRAM-MD5// authentication must be used when encrypting BinkP sessions. 
 +                                                                         
 +**Source** Address allows you to override the source FTN address used with outgoing BinkP mailer sessions with this linked node. Normally, this setting is left blank (not set).                     
  
-==== Archive Types ====+=== Archive Types ===
  
 This option allows you to add or remove archive programs from SBBSecho. This option allows you to add or remove archive programs from SBBSecho.
Line 644: Line 648:
 </code> </code>
  
-=== Archive Type ===+== Archive Type ==
 This is the identifying name of the archive file type. Usually this name This is the identifying name of the archive file type. Usually this name
 corresponds with the common file extension or suffix denoting this type  corresponds with the common file extension or suffix denoting this type 
Line 654: Line 658:
 remotely. remotely.
  
-=== Signature ===+== Signature ==
 This is the identifying signature of the archive file format (in       This is the identifying signature of the archive file format (in      
 hexadecimal notation).  This signature is used in combination with the hexadecimal notation).  This signature is used in combination with the
Line 660: Line 664:
 program to extract (unarchive) inbound EchoMail bundle files.          program to extract (unarchive) inbound EchoMail bundle files.         
  
-=== Signature Offset ===+== Signature Offset ==
 This is the byte-offset of the identifying signature of the archive file This is the byte-offset of the identifying signature of the archive file
 format.  This offset is used in combination with the Archive Signature   format.  This offset is used in combination with the Archive Signature  
Line 666: Line 670:
 (unarchive) inbound EchoMail bundle files.                               (unarchive) inbound EchoMail bundle files.                              
  
-=== Pack Command Line ===+== Pack Command Line ==
 This is the command-line to execute to create an archive file of the    This is the command-line to execute to create an archive file of the   
 selected type.  The following command-line specifiers may be used for   selected type.  The following command-line specifiers may be used for  
Line 684: Line 688:
 | ''%g'' | The configured temporary file directory                          | | ''%g'' | The configured temporary file directory                          |
  
-=== Unpack Command Line ===+== Unpack Command Line ==
 This is the command-line to execute to extract an archive file of the This is the command-line to execute to extract an archive file of the
 selected type. selected type.
Line 693: Line 697:
  
  
-==== NetMail Settings ====+=== NetMail Settings ===
  
 <code> <code>
Line 706: Line 710:
 ║ │Ignore NetMail Destination Address      No    ║ ║ │Ignore NetMail Destination Address      No    ║
 ║ │Ignore NetMail 'Sent' Attribute         No    ║ ║ │Ignore NetMail 'Sent' Attribute         No    ║
 +║ │Ignore NetMail 'KillSent' Attribute     No    ║
 ║ │Ignore NetMail 'Received' Attribute     No    ║ ║ │Ignore NetMail 'Received' Attribute     No    ║
 ║ │Ignore NetMail 'Local' Attribute        No    ║ ║ │Ignore NetMail 'Local' Attribute        No    ║
Line 711: Line 716:
 ╚════════════════════════════════════════════════╝ ╚════════════════════════════════════════════════╝
 </code> </code>
-=== Fuzzy Zone Operation ===+== Fuzzy Zone Operation ==
 Some mail programs do not create netmail messages with zone Some mail programs do not create netmail messages with zone
 information (INTL kludge line) or may only do so when sending information (INTL kludge line) or may only do so when sending
Line 721: Line 726:
 address in netmail message. address in netmail message.
  
-==== EchoMail Settings ====+=== EchoMail Settings ===
 <code> <code>
 ╔═════════════════════════════════════════════════════════╗ ╔═════════════════════════════════════════════════════════╗
Line 732: Line 737:
 ║ │Notify Users of Received EchoMail            Yes       ║ ║ │Notify Users of Received EchoMail            Yes       ║
 ║ │Convert Existing Tear Lines                  No        ║ ║ │Convert Existing Tear Lines                  No        ║
-║ │Strip Line Feeds from Outgoing Messages      No        ║ +║ │Automatically Add New Subs to Area List      List/File ║
-║ │Automatically Add New Subs to Area File      Yes       +
 ║ │Allow Nodes to Add Areas from Area File      Yes       ║ ║ │Allow Nodes to Add Areas from Area File      Yes       ║
 ║ │Maximum Backups to Maintain of Area File     100       ║ ║ │Maximum Backups to Maintain of Area File     100       ║
Line 744: Line 748:
 </code> </code>
  
-=== Area Manager ===+== Area Manager ==
 This is the name or alias of the BBS user where notification of AreaFix This is the name or alias of the BBS user where notification of AreaFix
 failures should be sent (default: ''SYSOP'').  AreaFix failures include nodes sending AreaFix requests which are not failures should be sent (default: ''SYSOP'').  AreaFix failures include nodes sending AreaFix requests which are not
Line 750: Line 754:
 the like.  Setting this option to a blank string will disable the notification feature. the like.  Setting this option to a blank string will disable the notification feature.
  
-=== Maximum Packet Size ===+== Maximum Packet Size ==
 This menu item allows you to set the maximum size of each outgoing This menu item allows you to set the maximum size of each outgoing
 echomail packet. echomail packet.
  
-=== Maximum Bundle Size ===+== Maximum Bundle Size ==
 Mail packets are normally packed into what are called "bundles" (unless Mail packets are normally packed into what are called "bundles" (unless
 a node is set up to receive uncompressed mail packets).  This menu item a node is set up to receive uncompressed mail packets).  This menu item
 allows you to specify the maximum size of each outgoing mail bundle. allows you to specify the maximum size of each outgoing mail bundle.
  
-=== Secure Operation === +== Secure Operation == 
-When set to ''Yes'', SBBSecho will compare the origin of any +Secure Operation tells SBBSecho to check the Area File (e.g. ''areas.bbs'') to insure that the packet origin (FTN //address//of each inbound EchoMail message is already linked to the EchoMail //area// where the message was postedMessages denied import due to this setting are logged as a ''Security violation''. This setting defaults to ''No''                                       
-incoming mail packets to the nodes in the Area File +
-as messages are imported If a packet password has been +
-defined for that node, it will also be compared to the +
-password contained in the mail packet. Packets and messages +
-failing this security will not be imported.+
  
- +== Allow Nodes to Add Areas from Area File ==
-=== Allow Nodes to Add Areas from Area File ===+
 When set to ''Yes'', SBBSecho will allow nodes to add areas When set to ''Yes'', SBBSecho will allow nodes to add areas
 (via area manager) which are listed in your Area File. (via area manager) which are listed in your Area File.
Line 775: Line 773:
 access to. access to.
  
-==== Paths and Filenames ====+== Zone Blind SEEN-BY and PATH Lines == 
 +Zone Blind SEEN-BY and PATH Lines when Enabled will cause SBBSecho to assume that node numbers are not duplicated across zones and that a net/node combination in either of these Kludge lines should be used to identify a spcific node regardless of which zone that node is located in (thus breaking the rules of FidoNet 3D addressing). 
 + 
 +If you are having trouble with FidoNet echomail crossing Zone boundaries which does not add all the SEEN-BY and PATH nodes, then enable this option with the limit of "4"
 + 
 +=== Paths and Filenames ===
 This menu item allows you to configure the paths and filenames which are This menu item allows you to configure the paths and filenames which are
 used by SBBSecho.  Selecting this option will bring you to the used by SBBSecho.  Selecting this option will bring you to the
Line 784: Line 787:
 ║                  Paths and Filenames                  ║ ║                  Paths and Filenames                  ║
 ╠═══════════════════════════════════════════════════════╣ ╠═══════════════════════════════════════════════════════╣
-║ │Non-secure Inbound Directory   e:\binkd\nonsecure    ║ +║ │Non-secure Inbound Directory   ../fido/nonsecure     ║ 
-║ │Secure Inbound Directory       e:/binkd/inbound      ║ +║ │Secure Inbound Directory       ../fido/inbound       ║ 
-║ │Outbound Directory             e:\binkd\outbound\    +║ │Outbound Directory             ../fido/outbound/     
 ║ │Area File                      ../data/areas.bbs     ║ ║ │Area File                      ../data/areas.bbs     ║
 ║ │Bad Area File                  ../data/badareas.lst  ║ │Bad Area File                  ../data/badareas.lst 
Line 792: Line 795:
 ║ │Echo Statistics File           ../data/echostats.ini ║ ║ │Echo Statistics File           ../data/echostats.ini ║
 ║ │Temporary File Directory       ../temp/sbbsecho      ║ ║ │Temporary File Directory       ../temp/sbbsecho      ║
-║ │Outgoing Semaphore File                              +║ │Outgoing Semaphore File        ../data/binkout.now   
 ╚═══════════════════════════════════════════════════════╝ ╚═══════════════════════════════════════════════════════╝
 </code> </code>
  
-=== Non-secure Inbound Directory ===+== Non-secure Inbound Directory ==
 This is the path where your FTN mailer stores, and where SBBSecho will This is the path where your FTN mailer stores, and where SBBSecho will
 look for, incoming files (potentially including message bundles and    look for, incoming files (potentially including message bundles and   
Line 803: Line 806:
 Default value is ''../fido/nonsecure''                                 Default value is ''../fido/nonsecure''                                
  
-=== Secure Inbound Directory ===+== Secure Inbound Directory ==
 This is the path where your FTN mailer stores, and where SBBSecho will This is the path where your FTN mailer stores, and where SBBSecho will
 look for, incoming message bundles and packets for Secure (password    look for, incoming message bundles and packets for Secure (password   
Line 811: Line 814:
  
  
-=== Outbound Directory ===+== Outbound Directory ==
 This is the path where your FTN mailer will look for, and where SBBSecho This is the path where your FTN mailer will look for, and where SBBSecho
 will place, outgoing message bundles and packets.                        will place, outgoing message bundles and packets.                       
Line 820: Line 823:
 Default value is ''../fido/outbound''                                      Default value is ''../fido/outbound''                                     
  
-=== Area File ===+== Area File ==
 This is the path and filename of the file that SBBSecho will This is the path and filename of the file that SBBSecho will
 use as it's EchoMail Message Area File.  By default SBBSecho looks for use as it's EchoMail Message Area File.  By default SBBSecho looks for
 the file ''areas.bbs'' in the //data// directory defined in SCFG. the file ''areas.bbs'' in the //data// directory defined in SCFG.
  
-=== Bad Area File ===+== Bad Area File ==
  
 This is the path of the file SBBSecho will use to record the names      This is the path of the file SBBSecho will use to record the names     
Line 838: Line 841:
   * SBBSecho will automatically sort and maintain this list, removing areas if they are added to your configuration (SCFG->Message Areas) and your Area File.                                                    * SBBSecho will automatically sort and maintain this list, removing areas if they are added to your configuration (SCFG->Message Areas) and your Area File.                                                 
  
-=== Log File ===+== Log File ==
 This is the path of the file SBBSecho will use to log information each This is the path of the file SBBSecho will use to log information each
 time it is run (default is ''../data/sbbsecho.log'').  time it is run (default is ''../data/sbbsecho.log''). 
  
-=== Echo Statistics File ===+== Echo Statistics File ==
 This is the path of the file SBBSecho will use to track statistics for This is the path of the file SBBSecho will use to track statistics for
 EchoMail message areas (default is ''../data/echostats.ini'').             EchoMail message areas (default is ''../data/echostats.ini'').            
  
-=== Temporary File Directory ===+== Temporary File Directory ==
                                                                                                                                              
 This is the directory where SBBSecho will store temporary files that   This is the directory where SBBSecho will store temporary files that  
 it creates and uses during its run-time (default is ''../temp/sbbsecho''). it creates and uses during its run-time (default is ''../temp/sbbsecho'').
  
-=== Outgoing Semaphore File ===+== Outgoing Semaphore File ==
                                                                                                                                                  
 This is an optional file to create/touch whenever there are new outbound This is an optional file to create/touch whenever there are new outbound
-files created or updated by SBBSecho.                                   +files created or updated by SBBSecho.  If you're using [[module:BinkIt]] as your mailer, then this should normally be set to ''../data/binkout.now''.
  
-==== EchoLists ====+=== Domains ==
 + 
 +Here you can configure the so-called "5th dimension" of FidoNet addresses, //"domains"//, here. 
 + 
 +These are the domain->zone mapping that //used// to be configured via the file: ''ftn_domains.ini'' (but is now configured in ''sbbsecho.ini'' and this utility). 
 + 
 +<file> 
 +╔══════════════════════╗ 
 +║        Domains       ║ 
 +╠══════════════════════╣ 
 +║ │fidonet   binkp.net ║ 
 +║ │fsxnet              ║ 
 +║ │                    ║ 
 +╚══════════════════════╝ 
 +</file> 
 + 
 +Selecting a node to configure will display a dialog like the following: 
 +<file> 
 +╔══════════════════════════════════════════════════════╗ 
 +║                   Domain - fidonet                   ║ 
 +╠══════════════════════════════════════════════════════╣ 
 +║ │Name                           fidonet              ║ 
 +║ │Zones                          1,2,3,4,5,         ║ 
 +║ │DNS Suffix                     binkp.net            ║ 
 +║ │Outbound Root                  ../fido/outbound/    ║ 
 +║ │NodeList                                            ║ 
 +╚══════════════════════════════════════════════════════╝ 
 +</file> 
 + 
 +=== EchoLists ===
 This menu item allows you to add and remove additional echo lists which This menu item allows you to add and remove additional echo lists which
 can be used by SBBSecho for area manager add requests. Normally these can be used by SBBSecho for area manager add requests. Normally these
Line 893: Line 925:
 </code> </code>
  
-=== EchoList Path/Name ===+== EchoList Path/Name ==
 This is the full path and filename of the echo list you are This is the full path and filename of the echo list you are
 defining.  This list should contain the areatag names of areas, defining.  This list should contain the areatag names of areas,
Line 899: Line 931:
 at least one space. at least one space.
  
-=== Hub Address ===+== Hub Address ==
 This is the address of the hub of the conferences contained This is the address of the hub of the conferences contained
 in this list.  If an area is remotely added from this list in this list.  If an area is remotely added from this list
 (using Areafix) this address is automatically added to the (using Areafix) this address is automatically added to the
-AREAS.BBS file.+Area File.
  
-=== Forward Password ===+== Forward Password ==
 This is the area manager password to use when forwarding This is the area manager password to use when forwarding
 requests. requests.
  
-=== Forward Requests ===+== Forward Requests ==
 Setting this option to 'Yes' will cause SBBSecho to send a Setting this option to 'Yes' will cause SBBSecho to send a
 request to the Hub Address specified to turn on an area from request to the Hub Address specified to turn on an area from
 this list.  This happens when users remotely add areas using this list.  This happens when users remotely add areas using
-Areafix and is not necessary if you are already receiving the +AreaFix and is not necessary if you are already receiving the 
-conferences in this list (i.e.: from Planet Connect).+conferences in this list.
  
-=== AreaFix Keys ===+== AreaFix Keys ==
 These are the keys required for a node to be able to gain These are the keys required for a node to be able to gain
 access to this particular echo list.  These flags are defined access to this particular echo list.  These flags are defined
Line 928: Line 960:
 ==== Environment Variable ==== ==== Environment Variable ====
 SBBSecho requires that the system ''[[config:env#SBBSCTRL]]'' environment variable be set correctly before it may be executed. When SBBSecho is executed from the Synchronet Terminal Server's Event Thread (e.g. due to ''FIDOIN'' or ''FIDOOUT'' timed events), this environment variable will always be set correctly, automatically. SBBSecho requires that the system ''[[config:env#SBBSCTRL]]'' environment variable be set correctly before it may be executed. When SBBSecho is executed from the Synchronet Terminal Server's Event Thread (e.g. due to ''FIDOIN'' or ''FIDOOUT'' timed events), this environment variable will always be set correctly, automatically.
 +
 ==== Instances ==== ==== Instances ====
  
-SBBSecho is designed to run only one instance at a time. A mutual-exclusion file (''[[dir:ctrl]]/sbbsecho.bsy'') is used to insure that multiple instances of SBBSecho are not allowed to execute concurrently. If SBBSecho crashes or is externally-killed without being able clean up after itself, it's possible this mutex file will be left behind and prevent SBBSecho from running normally for quite some time (depending on the configuration value of ''BSY Mutex File Timeout'').+SBBSecho is designed to run only one instance at a time. A mutual-exclusion file (''[[dir:ctrl]]/sbbsecho.bsy'') is used to insure that multiple instances of SBBSecho are not allowed to execute concurrently. If SBBSecho crashes or is externally-killed without being able to clean up after itself, it's possible this mutex file will be left behind and prevent SBBSecho from running normally for quite some time (depending on the configuration value of ''BSY Mutex File Timeout'').
  
 If you get the following error message (on the console and/or the log file) and you can confirm that SBBSecho is not actually running, you can safely delete the mutex file to allow SBBSecho to again run normally: If you get the following error message (on the console and/or the log file) and you can confirm that SBBSecho is not actually running, you can safely delete the mutex file to allow SBBSecho to again run normally:
Line 995: Line 1028:
 Remote area manager, or AreaFix, commands are used by linked nodes in order to Remote area manager, or AreaFix, commands are used by linked nodes in order to
 turn echo areas off and on, list currently connected areas, and more. turn echo areas off and on, list currently connected areas, and more.
-The following text is from the file ''[[http://cvs.synchro.net/cgi-bin/viewcvs.cgi/exec/areamgr.hlp|areangr.hlp]]'' which, after installation of+The following text is from the file ''[[https://gitlab.synchro.net/main/sbbs/-/raw/master/exec/areamgr.hlp|areamgr.hlp]]'' which, after installation of
 SBBSecho, should be located in your Synchronet ''[[dir:exec]]'' directory. This file lists the SBBSecho, should be located in your Synchronet ''[[dir:exec]]'' directory. This file lists the
 area manager commands available to the linked nodes which have been configured using area manager commands available to the linked nodes which have been configured using
Line 1032: Line 1065:
  
 ==== Changes in Version 3 ==== ==== Changes in Version 3 ====
- 
-For a detailed list of changes and code differences introduced in v3.0, see [[http://cvs.synchro.net/cgi-bin/viewcvs.cgi/src/sbbs3/sbbsecho.c?revision=3.0&view=markup|This page in CVS]]. 
  
 The most major changes introduced in v3.0 are: The most major changes introduced in v3.0 are: