@database "FoXGate.guide"
@author "Dave Naylor"
@remark "$VER: FoXGate Guide 1.0 (2. April 1997)"
@remark "Created with GoldED 4.6.0 (28.3.97)"
@index INDEX

@node MAIN "Welcome"

 @{FG fill}FoXGate@{FG text} © by Dave Naylor

 @{b}Contents@{ub}

 @{"What is FoXGate" link FOXGATEINTRO}
 @{"What's Required" link REQUIREDUTILS}
 @{"Configuration  " link Configuration}
 @{"Use            " link Use}
 @{"Credits        " link Credits}
 @{"New Versions   " link NewVersions}
 @{"Future         " link Future}
 @{"Author         " link Author}


@endnode
@node AUTHOR "Author"

 @{FG fill}FoXGate@{FG text} is written by @{b}Dave Naylor@{ub}.

 Dave is the sysop of Frost Free Amiga BBS in England

 You can contact him by writing to :-

 Dave Naylor 2:250/366.0

 difontaine@bigfoot.com

 And you can often catch him on IRC in #FrostFree

@endnode
@node FOXGATEINTRO "FoXGate Intro"

 @{FG fill}FoXGate@{FG text} is a utility to exchange Fidonet Style Mail between two systems via
 E-Mail.  It  sends  mail bundles from a Fidonet style Outbound directory to
 YAM where they are then transmitted as  E-Mail via your ISP.

 The mail bundles can be encoded with Base64 or UUEncode.

 @{FG fill}FoXGate@{FG text}  will  deal  with  archived Mail Bundles, unarchived netmails, file
 attaches and .tic files. It will send files found in .FLO|.HLO  files  and  .OUT|.HUT
 mail  packets.  FoXGate will disregard .DLO, .CLO, .DUT and .CUT files.




@endnode

@node REQUIREDUTILS "Required Utils"

 @{FG fill}FoXGate@{FG text} is a compiled Arexx utility, it therefore obviously needs RexxMast
 to be running on your machine.


 YAM Version 2.0 (Well >= 2P6 to be precise)

 It requires the following Libraries :-

 rexxtricks.library (Version 38.6)
 rexxsupport.library

 It also needs the following C= utilities, normally found in C:

 Delete
 Rename
 Copy

 And lastly it needs :-

 Base64decode (Included)

 and the Env Variable HOST (e.g. frost.free-online.co.uk)

 I have these as permanent fixtures here so for me it's not a worry :)

@endnode

@node CONFIGURATION "Configuration"

 @{FG fill}FoXGate@{FG text} requires a configuration file, FoXGate.cfg which by default should
 be placed in S:

 An example Configuration file is supplied with the FoXGate archive.

 @{b}Configuration Keywords and their use.@{ub}

 Keywords in @{b}Bold@{ub} must be present and defined in all cases.


 @{b}#SYSOP@{ub}

 - Sysop Name

 @{b}#BBS@{ub}

 - BBS Name

 @{b}#YAMCMD@{ub}

 - Full command to start YAM (e.g. YAM:YAM ) but without any USER= reference (See below)

 #YAMUSER

 - Configured YAM User, e.g BBS, leave out if only one.

 @{b}#INPATH@{ub}

 - Fidonet Inbound

 @{b}#OUTPATH@{ub}

 - Fidonet Outbound

 @{b}#FLOTYPE@{ub}

 - Set to NORMAL to just process .FLO type files, set to BOTH to process both .FLO and .HLO

 @{b}#LOGFILE@{ub}

 - Path and name to a Logfile for @{FG fill}Foxgate@{FG text} (e.g. Logs:Foxgate.log)

 @{b}#ADDRESS@{ub}

 - Set to your default Email address for @{FG fill}FoXGate@{FG text} (e.g. fido@frost3.demon.co.uk)

 #FLOPATH

 - Set to where your .FLO or .HLO files reside.  This may be the same as #OUTPATH, if so you
   may leave this entry out.

 #REPLYADDRESS

 - Set to an address where users can contact you personally rather than the email
   being processed by Foxgate

 #CONFIRM

 - If this is set a receipt will be returned to the sender of
   any mail you receive.

 #BACKUP

 - If this Keyword is set, FoXGate will backup mail before it
   encodes it.  The backed up mail is placed in a holding
   directory where it can be re-requested within a specified
   number of days by your Email downlinks.  The @BACKUP
   keyword requires the following arguments :-

   <Path to Dir> <Days Before Deletion> <Trigger Word to Re-Send>
   (e.g. #BACKUP Mail:Foxbackup/ 5 RESEND)

   To re-request a mail bundle all a downlink need do is to
   write to your #ADDRESS and use the Trigger Word
   followed by the Mail Bundle name, e.g. RESEND 12345678.WE0


 #SUBJECT <Subject to use>

 - By inserting this config entry Foxgate will only act on messages in YAM
   using this Subject, it will disregard user entries.

 #HIDE

 - Iconify YAM when processing mail.

 #DELOUT

 - Delete mail from the YAM Sent folder once sent.  This only occurs on a new
   Foxgate operation.

 #QUIT

 - Quit YAM once processing has terminated


 @{b}#NODE@{ub}         -

 - Nodes for which to process mail.  This keyword requires the
   following arguments :-

   <4D Node Number> <Email> <Encoding Type> <Minimum Filesize> <Subject>

   4d number means 2:250/194.0

   Email is the recipients Email address

   Encoding Type should be set to :-

       MM  for Base64
       UU  for UUencode

   Minimum File Size is a byte size before ANY mail will be sent.  FoXGate
   will calculate the bundle size of ALL mail for this node.

   Subject is the Subject line for the Email.  If you set this to FILENAME
   then FoXGate will insert the Bundle Name and Filesize in the subject
   line.

   E.G.

   #NODE 2:250/194.0 fido@timp8.demon.co.uk  MM 0 FILENAME

 @{b}#USER@{ub}

 - User names to act upon. (e.g. #USER Fido).  Foxgate will only act on emails to this user
   if you only have one email address to which mail is sent, you still must inlude this here.


@endnode

@node USE "USe"

FoXGate Useage :-

FoXgate can be used with the following CLI arguments....

FoXGate

-  This expects FoXGate.Cfg to be in S: and performs a In/Out mail
   run.

FoXGate IN

-  As before except only an inward mail run is undertaken.

FoXGate OUT

-  Ahem :)


@endnode

@node CREDITS "Credits"

 A big round of applause for :-


 @{"rexxtricks.library" link rexxtricks} -  Copyright (C) 1994,95 Jürgen Kohrmeyer,
                      <J_Kohrmeyer@wilam.north.de>

 @{"Base64Coders" link base64coders}       -  Edmund Vermeulen
                       <edmundv@grafix.xs4all.nl>

 @{"YAM" link yam}                -  Marcel Beck
                       mbeck@access.ch




@endnode

@node NEWVERSIONS "New Versions"

New Versions of FoXGate can be obtained from Aminet in comm/mail, by File
Requesting FOXGATE from 2:250/366.0 or by writing to :-

mailserver@frost.free-online.co.uk

and placing %GET FOXGATE.LHA in the body of
the message.


@endnode

@node FUTURE "The Future"

Who knows :)

@endnode

@node BASE64CODERS "Base64Coders"

Base64Decode & Base64Encode are a fast decoder and encoder for base64 (MIME)
encoded binaries that can be sent through electronic mail.

Base64 encoding is very much like uuencoding, only it is part of the much
more comprehensive MIME format. MIME allows you to send pictures, sound and
other binary files via e-mail. If you do not use a MIME aware mail reader
then you will not see the effect of this, but at least you can now decode
the included binaries thanks to Base64Decode! Simply save the base64 encoded
part as a text file and have Base64Decode decode it for you. If you are a
Spot user then you can use the included ARexx script for this.

@endnode


@node YAM "YAM"

 YAM (abbreviation for 'Yet Another Mailer') is a combined Mailer/POP/SMTP
 client for the Amiga.

 Author - Marcel Beck
 Email  - mbeck@access.ch
 WWW    - http://www.yam.ch


@endnode

@node REXXTRICKS "rexxtricks"

##########################################################################

                    'rexxtricks.library' 38.6 (12.4.96)

                     Copyright (C) 1994,95 Jürgen Kohrmeyer,
                     <J_Kohrmeyer@wilam.north.de>
##########################################################################

 'rexxtricks.library' is an ARexx function library.

 The functions cannot be assigned to a special purpose, it's just a
 collection of functions I missed when programming with ARexx. Let me know if
 you have any ideas for other useful functions.

@endnode


