home *** CD-ROM | disk | FTP | other *** search
/ CD-ROM Magic 1995 #1 / CDM_5.ISO / shell / mailers / im / imdev.arj / EXTFREQ.DOC < prev    next >
Encoding:
Text File  |  1994-01-25  |  4.1 KB  |  87 lines

  1.  
  2.              InterMail External File Request Processor Interface
  3.  
  4.                   Copyright 1993 InterZone Software, Inc.
  5.                            All rights reserved.
  6.  
  7. =========================================================================
  8.   * Support for External file request processors has been added.
  9.     See IMSETUP, under Mailer/File Requests/External. The following
  10.     is an example of how a request processor could be installed:
  11.  
  12.     [path]\MYFREQ.EXE %A %F %N %P
  13.  
  14.     The pseudo parameters would in this case give the request
  15.     processor the following information: network Address,
  16.     List file, User name, Password.
  17.  
  18.     In all the parameters, any spaces are replaced with underscore
  19.     characters (_). These are the available parameters:
  20.  
  21.       %A   Network address of the remote system, e.g.: 1:369/35
  22.       %B   Link rate for the connection in bps, e.g.: 14400
  23.       %C   Session cost per minute, as defined in the cost table in
  24.            FDNODE.CTL, e.g.: 25
  25.       %D   "INBOUND" or "OUTBOUND", depending on whether it's an
  26.            incoming call or not.
  27.       %F   Pathname of the request list to be processed, e.g.:
  28.            C:\IM\IMFILREQ.001
  29.       %L   Location provided by remote system's site info, e.g.:
  30.            Pembroke_Pines_FL
  31.       %M   Minutes left to the next event when requests aren't
  32.            allowed.
  33.       %N   Name of remote system, e.g.: InterZone_Cafe
  34.       %O   Name of remote system's SysOp, e.g.: Peter_Stewart
  35.       %P   Sessionlevel password given by remote system.
  36.       %X   "SECURE", "UNSECURE" or "UNLISTED" depending on whether the
  37.            session is password protected or not.
  38.       %Z   Type of session: "WAZOO", "EMSI" or "OTHER" (the last is
  39.            unlikely, since the external processor currently won't
  40.            be invoked for BARK requests).
  41.  
  42.     The external request processor is executed in a shell from
  43.     InterMail. It should finish processing within the timeout
  44.     limits of the Zmodem protocol. The following should be returned
  45.     by the file request processor:
  46.  
  47.       1) The processed request list, using the same filename as the
  48.          original list and containing the fully resolved pathname
  49.          of each file that is to be sent.
  50.  
  51.          The request processor must handle all magic filenames,
  52.          timestamps for update requests, as well as all password
  53.          protection. Timestamps and passwords are supplied in the
  54.          standard WaZOO request list format, since IM doesn't
  55.          pre-process the contents of the request file in any way.
  56.  
  57.          A minus in front of a filename means that IM should delete
  58.          the file after the session has been completed.
  59.  
  60.       2) (Optional) Up to 255 return message files. These should
  61.          be placed in the same directory as the request list and
  62.          must use the following naming convention: IMRMSGnn.ext,
  63.          where "nn" is the number of the message ("00"-"FE"), and
  64.          ".ext" is the same extension as that of the request list
  65.          (e.g. ".001", ".002", etc.).
  66.  
  67.          The name of the "sender" of the message can be inserted
  68.          as a kludge line at the start of the message. If the first
  69.          character is ^A (0x01), then IM will use the first line
  70.          of the message (up to 35 characters) as the name of the
  71.          sender. Otherwise the sender will be "InterMail". For the
  72.          developer, this means that if you intend to use any other
  73.          "kludge lines", e.g. MSGID, you must insert the sending
  74.          program's name as the first line. NOTE: The message should
  75.          contain text only and no message header beyond the name of
  76.          the sender: IM will create the packed message header with
  77.          all the required address information.
  78.  
  79.          The message text should be plain ASCII, and the only
  80.          control characters should be ^A, CR and LF. InterMail
  81.          will do no other processing of the text than creating
  82.          a packet and message header, inserting any required INTL
  83.          and FMPT/TOPT lines, and transmitting the message text
  84.          unchanged.
  85.  
  86.                                  -*-
  87.