home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 1 / HamRadio.cdr / packet / bb211 / action.doc < prev    next >
Text File  |  1991-03-02  |  8KB  |  227 lines
  1. The action file includes all sorts of things to be done with messages.  The
  2. operations are shown below.  {search} is any search for a message as
  3. specified in SEARCH.DOC.  Comments are any line that starts with ; or *
  4. There are two types of operations:  Immediate and Deferred.  Immediate
  5. actions occur on messages being received.  Deferred actions occur only when
  6. the proper "A" command is executed.
  7.  
  8. IMMEDIATE ACTIONS
  9. --------- -------
  10.  
  11.     HOLD {search}
  12.  
  13.       This says to hold a message that matches the search.  Files will be
  14.       marked as held by SYSOP.  {search} is any search for a message as
  15.       specified in SEARCH.DOC.
  16.  
  17.       Example:
  18.  
  19.           HOLD < AA4RE
  20.  
  21.           Holds all messages from AA4RE
  22.  
  23.     HOLD_OLD {search}
  24.  
  25.       This says to hold a message that matches the search but reason will
  26.       be too old rather than help by operator.  {search} is any search for
  27.       a message as specified in SEARCH.DOC.
  28.  
  29.       Example:
  30.  
  31.           HOLD < AA4RE
  32.  
  33.           Holds all messages from AA4RE
  34.  
  35.     REJECT {search}
  36.  
  37.       This says to reject a message that matches the search.  A rejected
  38.       message may not even arrive at the BBS.  Also see the parameter
  39.       REJECT_ACTION in PARMS.DOC.  {search} is any search for a message as
  40.       specified in SEARCH.DOC.
  41.  
  42.       Example:
  43.  
  44.           REJECT > SALE & @ USA
  45.  
  46.           Rejects all messages addressed to SALE @ USA
  47.  
  48.       Note:  The first pass at a reject action occurs when just the
  49.       the send command is received.  Some fields are not available
  50.       for testing like SUBJECT and FROM-BBS.
  51.  
  52.     DENY_NEW_MSG {message_num} {search}
  53.  
  54.       This says to not permit a user to originate a message at this BBS.
  55.       The {message_num} parameter indicates which message is to be
  56.       displayed if the {search} is met.  It will be between 0 at 9. The
  57.       real message number will be 140 + this parameter.  {search} is any
  58.       search for a message as specified in SEARCH.DOC.
  59.  
  60.       Examples:
  61.  
  62.           DENY_NEW_MSG 3 > SALE & @ USA
  63.  
  64.              Rejects all messages addressed to SALE @ USA and uses
  65.              message # 143
  66.  
  67.           DENY_NEW_MSG 2 C U & ^ > SYSOP
  68.  
  69.              Reject any messages from new or unregistered users unless
  70.              addressed to SYSOPand uses message # 142
  71.  
  72.       Note:  The deny action will be checked twice.  Once before the
  73.       subject is available and once afterwards.
  74.  
  75.       Note 2:  DENY_NEW_MSG should appear before REJECT and HOLD in the
  76.       ACTION.BB
  77.  
  78.     CHANGE_ADR {search} => {address}
  79.  
  80.       Changes an address.  {search} is any search for a message as
  81.       specified in SEARCH.DOC.  {address} is a standard packet address in
  82.       the form of "xxxx @ yyyy.zzzz". xxxx must be supplied and valid.  The
  83.       others can be omitted but the defaults may not fit what you want.
  84.       Any of the three (xxxx, yyyy, or zzzz) can be "=" which means leave
  85.       the same as before or the special word "NONE" which means to erase
  86.       this part of the address.
  87.  
  88.       Examples:
  89.  
  90.          CHANGE_ADR & @ USA => = @ ALLUS
  91.          CHANGE_ADR > 4SALE & @ USA => SALE @ =
  92.  
  93.     DISTRIBUTE {name} {search}
  94.  
  95.       Specifies which distribution/carbon-copy list is to be used.  If
  96.       {name} is a simple word, it will follow the normal name resolution.
  97.       If {name} is an actual file, that will supercede the name resolution
  98.       system.  {search} is any search for a message as specified in
  99.       SEARCH.DOC.
  100.  
  101.       Examples:
  102.  
  103.           DISTRIBUTE ALLCA @ ALLUS
  104.  
  105.              Use ALLCA for messages addressed to ALLUS.  First ALLCA.CC
  106.              will be tried then ALLCA.DIS
  107.  
  108.           DISTRIBUTE C:\BB\DISTINFO\ALLCA.DIS @ ALLUS
  109.  
  110.              Use the file C:\BB\DISTINFO\ALLCA.DIS for messages addressed
  111.              to ALLUS.
  112.  
  113.  
  114.  
  115. DEFERRED ACTIONS
  116. -------- -------
  117.  
  118.     MAKE_FILE            {fileid} {search}
  119.     MAKE_FILE_REPLACE
  120.     MAKE_FILE_APPEND
  121.  
  122.       Makes a file from a message.  {fileid} is the file to be used be
  123.       used.  Susbstitution parameters that are the same as for messages
  124.       (see MESSAGE.BB) can be used.  The file must not exist for MAKE_FILE.
  125.       If MAKE_FILE_REPLACE is used, then if the file already exists, it
  126.       will be replaced.  If MAKE_FILE_APPEND is used, the the message will
  127.       be added at the end of the file; if the file doesn't exist, it will
  128.       be created.  {search} is any search for a message as specified in
  129.       SEARCH.DOC.
  130.  
  131.       Examples:
  132.  
  133.          MAKE_FILE C:\RACES\$b > RACES & $ RACESBUL.*
  134.  
  135.          Change anything addressed to RACES with a BID of RACESBUL into a
  136.          file and stick it into the RACES subdirectory
  137.  
  138.          MAKE_FILE_REPLACE C:\ARRL\ARRLPROP $ ARLP*
  139.  
  140.          A propagation bulletin will replace its predessor in the file
  141.          called ARRLPROP.
  142.  
  143.     CLEAN_MSGS {type} {search}
  144.  
  145.       Used for general message housekeeping.  Its purpose is to remove
  146.       superceded messages like AMSAT orbitial data.  {type} indicates ARRL,
  147.       AMSAT, RACES, RTTYDX, GENERATE, or DATE.  This refers to how the BID
  148.       is used.  Both RACES and ARRL bids end in numbers but the ARRL
  149.       numbers are recycled at the end of the year.  AMSAT news and orbital
  150.       data have the format that looks like xxx-ddd.vv where the applicable
  151.       number (ddd) is just in front of the "."  RTTYDX uses a format of
  152.       xxxxxxxdddx.  If the GENERATE {type} is used, the standarded
  153.       generated bid of dddddd_bbs is assumed.  If {type} is DATE, then only
  154.       the last message received will be kept and the bid is ignored.
  155.       {search} is any search for a message as specified in SEARCH.DOC.
  156.  
  157.       Examples:
  158.  
  159.          CLEAN_MSGS ARRL  $ ARLP###
  160.          CLEAN_MSGS ARRL  $ ARLD###
  161.          CLEAN_MSGS ARRL  $ ARLS###
  162.          CLEAN_MSGS AMSAT $ ORBS-###.*
  163.          CLEAN_MSGS AMSAT $ ANS-###.##
  164.          CLEAN_MSGS RACES $ RACESBUL.###
  165.          CLEAN_MSGS RTTYDX $ RTDX####=
  166.  
  167.       These examples clean away old ARRL DX bulletins, prop bulletins,
  168.       satellite bulletins, AMSAT orbitial data, AMSAT news, and RACES
  169.       bulletins.
  170.  
  171.       Note 1:  Both AMSAT and ARRL types have special code to cover the
  172.       yearend wrap (Example: when ARLD052 is followed by ARLD001)
  173.  
  174.       Note 2:  GENERATE has special code to ignore the distant BBS doing
  175.       a message renumber.
  176.  
  177.  
  178. ORDERING
  179. --------
  180.  
  181. The first match that is seen will be acted on.  Example
  182.  
  183.    REJECT > SALE & @ USA
  184.    HOLD @ USA
  185.  
  186. A message addressed to SALE @ USA will be rejected because the REJECT is
  187. seen first.  The message addressed to ALL @ USA will just be held.
  188.  
  189. Also, the order is import for CHANGE_ADR and HOLD.  Example:
  190.  
  191.    HOLD @ ALLUS
  192.    CHANGE @ USA => = @ ALLUS
  193.  
  194. Messages @ USA will NOT be held since the change action is executed
  195. after the HOLD action.
  196.  
  197. One further example:
  198.  
  199.    CHANGE_ADR > SYSOP & @ AA4RE => AA4RE
  200.    CHANGE_ADR @ AA4RE => = @ NONE
  201.  
  202.       If a message comes in addressed to SYSOP @ AA4RE, it is readdressed
  203.       to AA4RE @ AA4RE.  Why not AA4RE @ (blank)?  The first line satisfied
  204.       the search so the search stopped.  The correct way to do this is:
  205.  
  206.    CHANGE_ADR > SYSOP & @ AA4RE => AA4RE @ NONE
  207.    CHANGE_ADR @ AA4RE => = @ NONE
  208.  
  209. You must make all the action happen with the one line!
  210.  
  211.  
  212. NEGATION
  213. --------
  214.  
  215. Putting a NO in front of a word will negate it.  Example:
  216.  
  217.    NOHOLD > SALE & @ USA
  218.    HOLD @ USA
  219.  
  220. A message addressed to SALE @ USA will go thru because the NOHOLD is
  221. seen first.  The message addressed to ALL @ USA will be held.
  222.  
  223. Note:  NOCHANGE_ADR does not require the => xxxx @ yyyy.ZZZZ portion.
  224. Example:
  225.  
  226.    NOCHANGE > ALL & @ USA
  227.