home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / OFFLINE / MAILGATE.ZIP / MAILGATE.TXT < prev   
Text File  |  1993-09-03  |  14KB  |  489 lines
  1.             MailGate Gateway 1.0
  2.  
  3.     
  4.                 Introduction
  5.  
  6.                                  by
  7.  
  8.                   Icon Systems Ltd
  9.            A division of Rabbits Foot Worldwide Enterprises
  10.            an ecologically sane wholly owned subsidiary of a
  11.            diversified company, Inc.
  12.  
  13.  
  14.  
  15.                 Table of Contents    
  16.  
  17.             Introduction        3
  18.             Address Formats.    4
  19.                 cc:Mail:    4
  20.                 QBBS/RA        5
  21.                 Netmail        5
  22.                 MHS SMF-70    5
  23.                 Packet Format    6
  24.             Requirements:        6
  25.                 For cc:Mail    6
  26.                 MHS (SMF-70)    6
  27.                 FidoNet Netmail    7
  28.             MailGate Configuration    7
  29.                 <fido.cfg>    7
  30.                 COMMAND LINES    8
  31.                     <key>    8
  32.                 <gateway to>    9
  33.         Gating to and from cc:Mail    9
  34.                 From cc:Mail    9
  35.                 To cc:Mail    9
  36.         Gateway to MHS and others.    10
  37.         Sample batch file commands:    10
  38.         FidoNet (Netmail) to cc:Mail    10
  39.             sample for QBBS to MHS    10
  40.         Sample for MHS to NETMAIL    10
  41.         License                10
  42.             Corporate License    11
  43.         Support                11
  44.         Registration            11
  45.         Limit of Liability        11
  46.  
  47.  
  48.  
  49.  
  50.  
  51. Introduction
  52.  
  53. MailGate is a gateway program designed to convert MHS SMF-70, cc:Mail,
  54. Netmail (FTS-001), FidoNet Packet (.PKT) format, QBBS/RA message base formats 
  55. and back.
  56. MailGate can be used as a stand-alone message generator/routing engine.
  57. To use this feature simply tell it what message format to read and
  58. what format to re-write it to.
  59. If you want to use it to generate a message for automated purposes simply 
  60. create a text formatted message then run MailGate using the option 
  61. key to read the text message and convert to the desired format.
  62. This will work to send automated messages to any of the available formats.
  63. The format of the text message is outlined below under the cc:Mail formatted
  64. message.
  65.  
  66. Because of the design of the gateway, it can be used in any combination.
  67.  
  68. FTS-001 - cc:Mail          QBBS/RA - cc:Mail
  69. FTS-001 - SMF-70           QBBS/RA - SMF-70
  70. FTS-001 - QBBS/RA        QBBS/RA - FTS-001
  71. FTS-001 - Packet           QBBS/RA - Packet
  72.  
  73. SMF-70  - FTS-001       cc:Mail - SMF-70
  74. SMF-70  - QBBS/RA       cc:Mail - FTS-001
  75. SMF-70  - cc:Mail       cc:Mail - QBBS/RA
  76. SMF-70  - packet        cc:Mail - Packet
  77.  
  78. MailGate supports, MHS SMF-70 mailers, cc:Mail Import/Export format, cc:Mail
  79. Remote, FTS-001 FidoNet Netmail standard, FidoNet .PKT format, QBBS/RA message
  80. base or other programs that do this.
  81. Currently in this pre-release release the file attach facility is not
  82. fully implemented. 
  83.  
  84. It will not work in the following configurations.
  85.  
  86. cc:Mail - cc:Mail
  87. cc:Mail - SMF-70
  88. Netmail - Netmail
  89. Packet  - Netmail
  90. Packet  - Anything (wait for ver 1.1)
  91.  
  92.  
  93.  
  94. Address Formats.
  95.  
  96. cc:Mail:
  97.  
  98. cc:Mail address' are the cc:Mail user name as listed in the cc:mail
  99. directory for the Post Office. "r", "R", "L" or "a" users are supported. 
  100. Post Office addressing is also supported.
  101.  
  102. cc:mail (Text) Format    (omit ---'s and comments)
  103. ------------------------------------------------------------------------------
  104. Message:                         ' start of a new message
  105. To: User Name and address        ' Put in the user name for the
  106. From: Username and address       ' appropriate destination.
  107. Subject: the subject.
  108. Contents:                        ' This tells us where the message text begins
  109. This is the body of the message
  110. You can type as much text here as is available
  111. in the mail program you are using to read it with.
  112. ------------------------------------------------------------------------------
  113.  
  114. To attach a file item to the message add a line after the text as follows
  115. File Item: <drive:path\filename>
  116. This will send the message with the file attached.
  117. File attaches are supported in the following instances.
  118. QBBS/RA - cc:Mail
  119. cc:Mail - QBBS/RA
  120. QBBS/RA - MHS
  121. MHS     - QBBS/RA
  122.  
  123. There are bugs in this feature and it will not be fully implemented
  124. until the next release use at your own risk.
  125.  
  126. Messages addresed from cc:Mail to other mail systems can be done 
  127. using the PO addressing or FAN addressing. 
  128. Simply select the address of the gateway PO and when prompted
  129. enter the address of the destination user.
  130.        
  131.     To: NETMAIL 
  132.  
  133.     User Name@Zone:Net/Node.point
  134.        
  135.     This includes the user name and the zone/net/node number seperated
  136.     by the @ symbol.
  137.  
  138.     To: MHS 
  139.  
  140.     Userid@hostname
  141.  
  142.  
  143.     To: QBBS
  144.  
  145.     User Name (MsgArea n)
  146.     Where n is the QBBS area you want the message to go to.
  147.  
  148.     To: Packet
  149.  
  150.     User Name (AreaName <name>)
  151.     Where <name> is the message area name for messages
  152.     The default is the NETMAIL area with a destination address of the 
  153.     origionating system.
  154.  
  155.  
  156.  
  157. QBBS/RA
  158.  
  159. Simply enter the name of the user the mail is intended for. If you want to
  160. send a message to a user in an area other than the default, simply place
  161. the area number in parenthesis after the name. 
  162.  
  163. Example:
  164.  
  165.     John User
  166.     or
  167.     John User (MsgArea 3)
  168.  
  169.  
  170. Netmail
  171.  
  172. Use the user name followed by the Netmail address.
  173.  
  174. Example:
  175.  
  176.     John User@Zone:Net/Node.Point
  177.  
  178.  
  179. MHS SMF-70
  180.  
  181. Use the userID of the recipient and the hostname that the user resides on.
  182. This feature requires the use of an MHS mailer capable of supporting SMF-70
  183. messages.
  184.  
  185. Example:
  186.  
  187.     JUser@HOST
  188.  
  189. This is the simplest format of the To: field in the MHS message.
  190. If the To: field of the SMF-70 message uses this format MailGate will
  191. use information in the address translation file "MHS.ADR" to expand the address.
  192. The next format will not use the .ADR file at all as it is very explicit.
  193. JUser@HOST (John User)
  194. This format will have the To: username expanded to only the "John User"
  195. Alternativley you may include additional information in the to field.
  196.  
  197. Examples:
  198.  
  199.     JUser@HOST (John User (MsgArea 2))
  200.     JUser@HOST (John User (AreaName: UUCP))
  201.  
  202. Or you may list this information in the MHS.ADR file
  203.  
  204.     <MHS.ADR>
  205.     JUser@HOST<=>John User (MsgArea 2)
  206.     JUser@HOST<=>John User (AreaName: UUCP)
  207.  
  208.  
  209. The message will be placed in the "OUT" directory for your HOST as defined
  210. in the MAIL.CFG file.
  211.  
  212.  
  213. Packet Format
  214.  
  215. This is probably the most usefull method of converting mail and will be used
  216. by most systems unless you do not have a mail processor.
  217.  
  218. Simply use the command line for generating .PKT format messages and use the
  219. To: address syntax of
  220.  
  221.     John User@1:143/226.0  
  222. or 
  223.     John User (AREANAME <areaname>)
  224.  
  225. both formats are acceptable.
  226.  
  227. The first format will generate a netmail message addressed to the user John User
  228. at the specified FidoNet Address.
  229.  
  230. The second option will send a message addressed to John User in the message
  231. area "<areaname>" This can be used for echomail messages. 
  232. The message will be placed in the appropriate area by your mailer.
  233.  
  234.  
  235. Requirements:
  236.  
  237. For cc:Mail
  238. cc:Mail Import/Export.
  239.  
  240. MHS (SMF-70)
  241. requires an MHS gateway that supports SMF-70 message structures.
  242. May also be used in conjunction with any email system  which supports 
  243. SMF-70.
  244.  
  245.  
  246. FidoNet Netmail
  247. A fidoNet Mailer capable of delivering FTS-001 (.MSG) style netmail messages
  248.  
  249. or
  250.  
  251. A FidoNet Mailer capable of reading a standard FTS Packet (.PKT)
  252. Binkley, D'Bridge, FrontDoor etc
  253.  
  254.  
  255. MailGate Configuration
  256.  
  257. MailGate requires that a configuration file be kept in the 
  258. current directory. It may contain the following information.
  259. All paths must include a trailing "\".
  260.  
  261. <mail.cfg>
  262.  
  263. LOG <logname>
  264. What you want to call your log file 
  265.  
  266. NETNODE <IFNA>
  267. Your International FidoNet Addrress. 
  268. zone:net/node.pnt number
  269.  
  270. OFFSET -800             
  271. your offset from Greenwich Time
  272.  
  273. SYSOP <Name>
  274. name of the SysOp
  275.  
  276. PONAME <poname> 
  277. name of the cc:Mail Post Office for replies
  278.  
  279. IMPFILE <CCMAIL.EXP>     
  280. what you call ccmail file we read
  281.  
  282. EXPFILE <ccmail.imp>      
  283. what you call the file you want import to read
  284.  
  285. MAILDIR <drive:path> 
  286. your FTS-001 netmail directory
  287.  
  288. QBBSDIR <drive:path> 
  289. your QBBS message base directory
  290.  
  291. TEARLINE <text>
  292. Your tearline
  293.  
  294. DEFAULTREPLY <n>          
  295. Default area to put replies in for QBBS
  296.  
  297. FROMBOARD <x> REPLYTO <y>   
  298. QBBS area to scan and the area to send replies to 
  299. if gating from one area to the other. 
  300. This over-rides the DEFAULTREPLY parameter if used
  301. to gate qbbs - qbbs mail. Up to 200 areas may be defined.
  302.  
  303. RATTACH <drive:path> 
  304. Directory that is used for QBBS/RA file attachments.
  305.  
  306. MSGID NO
  307. Include QBBS/RA msgID's as part of the msg text.
  308.  
  309. EXCLUDE <name>
  310. QBBS/RA user name to exclude. You may exclude up to 50 users
  311.  
  312. MHSGATEDIR <drive:path>
  313. This is the path to the gates directory of your MHS system.
  314. Example:
  315. c:\mhs\mail\gates\
  316.  
  317.  
  318. MHSGATENAME <Your HOST name>
  319. The name of your HOST as defined in the MHS Admin program.
  320. In the example FIDO.CFG file it is defined as "FIDO"
  321.  
  322. PACKETDIR <drive:path>
  323. This is the directory that MailGate will place the .PKT files into
  324.  
  325. AREANAME <areaname>
  326. The default is NETMAIL if not specified. Address information
  327. overrides this. Adding AREA:<area> to the address filed of messages
  328. will send the message to the desired areaname.
  329.  
  330. PASSWORD <8 chars or less>
  331. This is the password to be added to .PKT messages if you are running
  332. a secure mailer.
  333.  
  334. COST <n>
  335. The cost in cents to be added to the .PKT messages.
  336.  
  337.  
  338. COMMAND LINES
  339. There are three command line options. Each time you run the gateway you 
  340. MUST include at least the first two of them.
  341.  
  342. MailGate -F<key> <GateTo>  -C<config file name>
  343.  
  344. where -F means "From" and GateTo is where
  345. your want to send the message to.
  346.  
  347. <key>
  348. This is the key that tells us what type of message structure
  349. we are reading.
  350. Valid options are: 
  351.             C - cc:Mail
  352.             N - Netmail
  353.             Q - QBBS
  354.             M - MHS (SMF-70)
  355.             P - Packet       version 1.1
  356. <gateway to>
  357. This is what we want to gateway our mail to.
  358. Valid keywords are:
  359.             NETMAIL
  360.             MHS
  361.             QBBS
  362.             CCMAIL
  363.             PACKET 
  364.  
  365.  
  366.     MailGate -FC PACKET
  367.  
  368. This will read a cc:Mail format message and convert it to FidoNet .PKT
  369. format and place it into the inbound Packet directory of your mailer.
  370.  
  371. <config file name> 
  372. The -C parameter can be followed by the name of an alternate configuration
  373. file name. The default is MAIL.CFG.
  374.  
  375.  
  376. Gating to and from cc:Mail
  377.  
  378. From cc:Mail
  379.  
  380. 1. Set up a "P" post office entry in the cc:Mail directory (FIDO). 
  381.    Alternativley you may use cc:Remote to import messages to using
  382.    Remote Import Export that comes with cc:Remote.
  383.  
  384. 2. If you are using cc:Mails gateway/router program, setup a call list
  385.    entry to call this post office at regular intervals.
  386.    This batch process should place the ccmail.exp file in a directory accessible 
  387.    to MailGate.EXE. It should then run the gateway with the following parameters.
  388.   
  389.    Add the following lines to a batch file that is named the first eight 
  390.    characters of the PO name configured in step 1 (FIDO.BAT).
  391.    Refer to the GATELINK parameter in the cc:Mail documentation for more
  392.    details.
  393.  
  394.     EXPORT <PoName> password path @<expfile>
  395.     MailGate -FC <gateto>
  396.  
  397. To cc:Mail
  398.  
  399.     MailGate -F<key> CCMAIL
  400.     IMPORT  PO password path @<impfile>    
  401.  
  402. This will export any mail from desired source <key> and create a cc:Mail
  403. Importable file <IMPFILE>. The batch process then runs cc:Mail IMPORT.EXE
  404. and imports the message into the main PO for your cc:Mail users (not the
  405. gateway POName).
  406. Gateway to MHS and others.
  407.  
  408. The configuration to use MailGate with other mail systems is similiar to the 
  409. way we setup the gateway for ccmail except we do not need the Import and export
  410. programs. These are specific to cc:Mail.
  411.  
  412. Simply create an event on your FidoNet mailer to export the new messages when
  413. they are entered. You can do this with most mailers by trapping an error level
  414. or telling it that when new mail is entered/received that it should exit to
  415. a batch file. 
  416.  
  417. The batch file should do two things.
  418.  
  419. 1. Run MailGate and export the mail messages to the desired type and then 
  420. 2. Run MailGate in a mode that will check if mail is to go in the
  421.    other direction.
  422.  
  423.         Sample batch file commands:
  424.  
  425.         MailGate -F<key> <Gate to>  ' to export the message and send
  426.                         ' it to the desired mail system.
  427.         MailGate -F<key> <Gate To>  ' to read messages coming the 
  428.                         ' other direction.
  429.         Sample for FidoNet (Netmail) to cc:Mail
  430.  
  431.         MailGate -FC NETMAIL
  432.         MailGate -FN CCMAIL
  433.  
  434.         sample for QBBS to MHS
  435.  
  436.         MailGate -FQ MHS
  437.         MailGate -FM QBBS
  438.  
  439.         Sample for MHS to NETMAIL
  440.  
  441.         MailGate -FM NETMAIL
  442.         MailGate -FN MHS
  443.  
  444.         You get the picture.
  445.  
  446.  
  447. Address Translation Files (Optional)
  448.  
  449. You may set up a translation file for each mail system you plan 
  450. on routing mail to. The formats for these files is as follows.
  451.  
  452. To:<=>New To:
  453. Mike Faul<=>Mike Faul@143/226
  454. Mike Faul<=>SysOp
  455.  
  456. When using the Gateto keyword on the commandline and when you want to have a 
  457. translation file simply name the file <gateto>.ADR.
  458. For more details see the section for the .ADR file under MHS routing.
  459.  
  460.  
  461. License
  462. This product is distributed as SHAREWARE except as outlined below for corporations.
  463. The SHAREWARE fee is $25.00 
  464.  
  465. Corporate License
  466. The License fee for this product is $495.00 per copy.
  467. Site License is available, please contact the author.
  468.  
  469. Support
  470. Support is available on Compuserve to 72500,1727 or via FidoNet (preferred) at
  471. 1:143/226.0  or to FidoNet via the inetrnet at SysOp@z1.n143.f226@fidonet.org
  472.  
  473. Registration
  474. Send all registrations to:
  475.  
  476.         Icon Systems Ltd.
  477.         1035 Aster Ave. #2185
  478.         Sunnyvale, CA. 94086
  479.  
  480. Limit of Liability
  481.  
  482.     MailGate is distributed as-is.  The author disclaims all warranties,
  483.     expressed or implied.  The author will assume no liability for damages
  484.     either from the direct use of this product or as a consequence of the
  485.     use of this product.
  486.  
  487.     MailGate is guaranteed to do nothing more than take up space on your
  488.         disk drive, while it attempts to translate messages.
  489.