home *** CD-ROM | disk | FTP | other *** search
/ Network Support Encyclopedia 96-1 / novell-nsepro-1996-1-cd2.iso / download / netware / smfsel.exe / SMFSEL.TXT < prev   
Text File  |  1993-09-17  |  12KB  |  279 lines
  1.  
  2.               NOVELL TECHNICAL INFORMATION DOCUMENT
  3.  
  4. TITLE:              SMFSEAL, MHS MAIL Utility
  5. DOCUMENT ID:        TID000382
  6. DOCUMENT REVISION:  A
  7. DATE:               01JUL93
  8. ALERT STATUS:       Yellow
  9. INFORMATION TYPE:   Symptom Solution
  10. README FOR:         SMFSEL.EXE
  11.  
  12. NOVELL PRODUCT and VERSION:
  13. NetWare MHS 1.5
  14. NetWare SMF v71 Developer's Kit for MHS
  15.  
  16. ABSTRACT:
  17. This file contains SMFSEAL, which is an MHS submission utility that allows
  18. simple messaging from applications.  A file with an address is created and
  19. copied to a mailbox.  SMFSEAL, running as an MHS gateway process, picks up
  20. the message and delivers it to MHS.  MHS handles it as any other E-Mail
  21. message, delivering it to the addressee's MHS mailbox. This file is a beta
  22. version, please report any errors or problems to SHOCHSCH NOVELL.
  23. _________________________________________________________________
  24.  
  25. DISCLAIMER
  26. THE ORIGIN OF THIS INFORMATION MAY BE INTERNAL OR EXTERNAL TO NOVELL. 
  27. NOVELL MAKES EVERY EFFORT WITHIN ITS MEANS TO VERIFY THIS INFORMATION. 
  28. HOWEVER, THE INFORMATION PROVIDED IN THIS DOCUMENT IS FOR YOUR INFORMATION
  29. ONLY.  NOVELL MAKES NO EXPLICIT OR IMPLIED CLAIMS TO THE VALIDITY OF THIS
  30. INFORMATION.
  31. _________________________________________________________________
  32.  
  33. Self-Extracting File Name:  SMFSEL.EXE
  34.  
  35. Files Included     Size     Date        Time
  36.  
  37.   SMFSEL.TXT          (This File)
  38.  SMFSEAL.EXE      69177   11-30-89      3:21p
  39.  
  40.  
  41.                                 SMFSEAL UTILITY
  42.  
  43. People who develop MHS applications may benefit from a new utility called
  44. SMFSEAL.  The SMFSEAL utility supports the full range of MHS services. 
  45. SMFSEAL packages the message and submits it to MHS; MHS then mails the
  46. message to the addressees.
  47.  
  48. INSTALLING SMFSEAL
  49. SMFSEAL can be installed to function as an automatic gateway submission
  50. process and also as a program executable from the DOS command line.
  51.  
  52. INSTALLING SMFSEAL AS A GATEWAY
  53. When you install SMFSEAL as a gateway, the SMFSEAL program is invoked once
  54. for every cycle scheduled by the MHS Connectivity Manager.  (This is how
  55. all MHS gateways operate.)
  56.  
  57. To install SMFSEAL as an automatic gateway process on an existing MHS host,
  58. perform the steps in this section.  Note that you must have Supervisor
  59. rights toperform the installation.
  60.  
  61. 1) Determine the location where MHS is currently installed.  The location
  62. is identified by the DOS environment variable MV on the MHS Connectivity
  63. Manager workstation.  The MV environment variable identifies the name of
  64. the drive and directory where the MHS programs are located. (If necessary,
  65. refer to the MHS Installation and Operation manual for more information
  66. about the MV variable and MHS directory structure.)
  67.  
  68. 2) Create a directory named MV\MHS\MAIL\SMF.  This directory is where
  69. applications place files for submission to MHS.
  70.  
  71. 3) Log in as the administrative user of MHS and start the MHS Directory
  72. Manager.
  73.  
  74. 4) From the Directory Manager menu, select "routes to workgroups, hosts,
  75. andgateways." Select "Add entry," and from the menu that appears next,
  76. select "Define a gateway."
  77.  
  78. 5) In the menu titled A GATEWAY, type "SMFSEAL" for the host name and press
  79. Enter.  For the description, type "SMFSeal gateway" and press Enter.  You
  80. do not need to enter any gateway commands.
  81.  
  82. 6) Select <Done> to complete the gateway definition.
  83.  
  84. 7) Exit the MHS Directory Manager and return to the DOS prompt.
  85.  
  86. 8) Copy the file SMFSEAL.EXE from the MHS Utilities diskette to the
  87. directory MV\MHS\MAIL\GATES\SMFSEAL\PUBLIC, giving SMFSEAL the filename
  88. INPOST.EXE.  For example, to copy SMFSEAL from a diskette in drive A to a
  89. network drive F and rename it INPOST.EXE, you would enter the following:
  90.  
  91. copy a:\smfseal.exe f:\mhs\mail\gates\smfseal\public\inpost.exe
  92.  
  93. 9) Start MHS.
  94.  
  95. Once every scheduled cycle, MHS will place a call to the SMFSEAL gateway
  96. running INPOST.EXE (which is really SMFSEAL.EXE).  When SMFSEAL is called
  97. in this way, it will seal every file that matches the wildcard pathname
  98. MV\MHS\MAIL\SMF\*.
  99.  
  100.  
  101.   NOTE:  Note that SMFSEAL returns an exit errorlevel code of 1 if it finds
  102. nothing to seal.  The MHS gateway processor displays an error report
  103. "Inpost Failed" when an Inpost process returns an exit code other than 0. 
  104. Therefore, when SMFSEAL is run as a gateway process, MHS will display the
  105. "Inpost Failed" error message any time the gateway process is run and there
  106. are no messages to seal. This is a normal condition for gateway operation
  107. of SMFSEAL.
  108.  
  109. INSTALLING AND RUNNING SMFSEAL
  110. AS AN EXECUTABLE PROGRAM
  111. Some developers may want to use SMFSEAL as a command-line executable
  112. program, such as for testing purposes.  To allow this, copy the file
  113. SMFSEAL.EXE from the MHS Utilities diskette to the MV\MHS\EXE directory. 
  114. This directory should be in the search path of a properly installed MHS
  115. workstation and all workstations set up to run MHS applications.
  116.  
  117. To execute SMFSEAL from the DOS command line, use the following syntax:
  118.  
  119.            smfseal [-F<pathname> | -D<directory name>] -V
  120.  
  121.     -F     Filename (including the full pathname if the file
  122.            is not in the current directory) of the file you
  123.            want to seal.  Wildcards are acceptable but the
  124.            filename cannot have an extension.  If the -F
  125.            switch is omitted, SMFSEAL attempts to seal all
  126.            files in the MV\MHS\MAIL\SMF\ directory.
  127.  
  128.     -D     Name of the directory that contains the files you
  129.            want to seal.  SMFSEAL will attempt to seal any
  130.            files that do not have an extension.
  131.  
  132.     -V     The optional -V parameter stands for verbose and
  133.            causes SMFSEAL to send status information and return
  134.            codes as it tries to seal each file.
  135.  
  136. SMFSEAL INPUT REQUIREMENTS
  137. SMFSEAL accepts messages in the form of DOS files.  The minimum fields
  138. required for submission to SMFSEAL are:
  139.  
  140.         Field                           Description
  141.  
  142.         SMF-64 or ^C<LF>                Signature field
  143.         From: user1 @ wkgroup1          Author
  144.         To: user2 @ wkgroup2            Recipient(s)
  145.         <CR><LF>                        Blank line terminator
  146.  
  147. Note that SMFSEAL will accept either the character string "SMF-64" or
  148. ^C<LF> as the signature field on the first line of a message file.  If the
  149. input file contains SMF-64 as the signature field, SMFSEAL replaces the
  150. string with a ^C<LF> in the message it constucts from the input file.
  151.  
  152. From the example input message shown, SMFSEAL would construct a message
  153. addressed to "user2 @ wkgroup2." If user2 were a user at the local MHS
  154. host, then SMFSEAL would deliver the message to the user.  Otherwise,
  155. SMFSEAL would prepend a routing envelope to the message and submit the
  156. message to MHS by placing the message file in the MV\MHS\MAIL\OUT
  157. directory.
  158.  
  159.  
  160. After the message is successfully sealed and submitted to MHS (or delivered
  161. to a local user), SMFSEAL deletes the message from the directory in which
  162. it was found.  If SMFSEAL cannot process a message, the message is left in
  163. the submission directory and renamed with a .BAD extension.
  164.  
  165. If SMFSEAL encounters multiple addresses (separated by commas) in the To
  166. field, SMFSEAL sends a copy of the message to each addressee.  An input
  167. file may contain a maximum of 30 comma-delimited addresses in the To
  168. field.
  169.  
  170. In addition to the required fields, SMFSEAL also will accept optional body
  171. text up to 8K in total length (including the message header).
  172.  
  173. SMFSEAL also will accept any other valid SMF (Standard Message Format)
  174. header field.  In particular, you may find the following fields useful.
  175.  
  176.     Field                                   Description
  177.  
  178.     Copies-to: u3 @ wg3, u4 @ wg4           Defines recipients
  179.                                             who receive copies
  180.     Attachment-name: c:\docs\mydoc.doc      Attachment filename
  181.     Send-to:                                Defines specific
  182.                                             recipients
  183.  
  184. Including a Copies-to field in a message causes SMFSEAL to generate copies
  185. of the message to each address specified in the field.  There can be a
  186. maximum of 30 comma-delimited addresses in the Copies-to field.
  187.  
  188. If an Attachment-name field is specified, SMFSEAL will include the
  189. specified file as an attachment to the message being sealed.  The original
  190. attachment file is not deleted after the message has been sealed.
  191.  
  192. The Send-to field may contain 1 to 30 comma-delimited addresses; this field
  193. allows for delivering blind copies of a message.  An example of using the
  194. Send-to field for this purpose is presented in the next section "Example
  195. SMFSEAL Files."
  196.  
  197. EXAMPLE SMFSEAL FILES
  198. In this section you will find examples of typical message files that can be
  199. submitted to SMFSEAL.
  200.  
  201. SIMPLE MESSAGE
  202. The following example illustrates the most simple form of message that can
  203. be submitted to SMFSEAL .
  204.  
  205.         SMF-64 <HR>
  206.         From: user1 @ wg1
  207.         To: user2 @ wg2
  208.         <CR><LF>
  209.         Optional body text of the message goes here.
  210.  
  211. MESSAGE WITH MULTIPLE RECIPIENTS
  212. The following example shows how to address a message intended for multiple
  213. recipients. Two recipients have been specified as the primary recipients of
  214. the message, and two others have been specified as recipients of copies of
  215. the message. SMFSEAL will generate a copy of this message to each recipient
  216. identified in the To and Copies-to fields.
  217.  
  218.         SMF-64
  219.         From: user1 @ wg1
  220.         To: user2 @ wg2, user3 @ wg3
  221.         Copies-to: user4 @ wg4, user5 @ wg5
  222.         <CR><LF>
  223.         Optional body text of the message goes here.
  224.  
  225.  
  226. MESSAGE WITH AN ATTACHMENT FILE
  227. This example shows how to send an attachment file with the message. 
  228. SMFSEAL attempts to send the file F:\DOCS\MYDOC.DOC with this message.  If
  229. SMFSEAL ca find and access the specified file, it sends a copy of the file
  230. with the message.  If SMFSEAL cannot find or access the file, it renames
  231. the message file with a .BAD extension and the message is not sent.
  232.  
  233.         SMF-64
  234.         From: user1 @ wg1
  235.         To: user2 @ wg2
  236.         Attachment-name: f:\docs\mydoc.doc
  237.         <CR><LF>
  238.         Optional body text of the message goes here.
  239.  
  240. MESSAGE WITH BLIND-COPY RECIPIENTS
  241. This example illustrates how to use an explicit Send-to field in a message
  242. submitted to SMFSEAL.  A copy of the message will be sent to all addressees
  243. in the Send-to field.  Note that each addressee identified in the To and
  244. Copies-to fields are repeated in the Send-to field. Any addressees
  245. specified in the To or Copies-to fields, but missing from the Send-to
  246. field, will not receive a copy of the message.
  247.  
  248. Any addressee included in the Send-to field but not in the To or Copies-to
  249. fields will receive a "blind-copy" of the message; that is, other
  250. recipients of the message will not know the message also was sent to this
  251. address.  In the following example "other @ recip" will receive a
  252. "blind-copy" of this message.
  253.  
  254.         SMF-64
  255.         Send-to: user2 @ wg2, user3 @ wg3, other @ recip
  256.         From: user1 @ wg1
  257.         To: user2 @ wg2
  258.         Copies-to: user3 @ wg3
  259.         <CR><LF>
  260.         Optional body text of the message goes here.
  261.  
  262. SMFSEAL ERROR CODES
  263. This section lists the errorlevel return codes that could be returned when
  264. you execute SMFSEAL from the DOS command line.
  265.  
  266. Error
  267. Level   Message
  268.  
  269. 0       SMFSEAL found files to seal.  (This does not indicate
  270.            that the files were sealed successfully.)
  271. 1       SMFSEAL found no files to seal.
  272. 50      Invalid filename specified to SMFSEAL in -F switch; or
  273.            invalid or nonexistent directory specified in -D
  274.            switch.
  275. 52      Environment error, such as the system date is not set
  276.            or the MV setting is missing or invalid.
  277. 255     Unknown other error.
  278.  
  279.