home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / com / utils / elm / newmail.man < prev    next >
Text File  |  1992-02-01  |  5KB  |  120 lines
  1. NAME
  2.      newmail,wnewmail - programs to asynchronously notify of new mail
  3.  
  4. SYNOPSIS
  5.      newmail [-d] [-i interval] [-w] file-spec {file-spec...}
  6.      wnewmail [-d] [-i interval] [-w] file-spec {file-spec...}
  7.  
  8. DESCRIPTION
  9.      Newmail is a program to allow monitoring of mailboxes in  an  intelligent
  10.      fashion.   It is based loosely on biff(1) and the version of newmail that
  11.      was distributed with Elm 1.7.
  12.  
  13.      The basic operation is that the program will check the list of  specified
  14.      mailboxes  each  interval  seconds  and  will  list any new mail that has
  15.      arrived in any of the mailboxes, indicating  the  sender  name,  and  the
  16.      subject of the message.
  17.  
  18.      Each entry displayed can be in a number of different formats depending on
  19.      the  mode  of the program, the number of folders being monitored, and the
  20.      status of the message.  If you're running it as a window (e.g. ``-w''  or
  21.      invoked as wnewmail) then the output will be similar to:
  22.  
  23.         sender name - subject of message
  24.         Priority: sender name - subject of message
  25.  
  26.      where <sender name> is either the name  of  the  person  sending  it,  if
  27.      available  (the  ARPA  'From:'  line)  or  some other brief indication of
  28.      origin If there is no subject, the message "<no subject>" will appear  on
  29.      the screen.
  30.  
  31.      Folders are indicated by having the  folder  name  appear  first  on  the
  32.      output line, as in:
  33.  
  34.         folder: sender name - subject of message
  35.  
  36.      If you're running newmail without the windows option, then the output  is
  37.      more  suitable  for popping up on an otherwise active screen, and will be
  38.      formatted:
  39.  
  40.         >> New mail from sender name - subject of message
  41.         >> Priority mail from sender name - subject of message
  42.  
  43.      Again, with folder names indicated as a prefix.
  44.  
  45.      The flags available are:
  46.  
  47.      -d          This will turn on the debugging, verbose output mode.  It  is
  48.                  not  recommended  that  you  use  this  option  unless you're
  49.                  interested in actually debugging the program.
  50.  
  51.      -i interval This will change the frequency that the  program  checks  the
  52.                  folders  to  the interval specified, in seconds.  The default
  53.                  interval for the program is 60 seconds.  Note: if you  change
  54.                  the  interval  to less than 10 seconds, the program will warn
  55.                  you that it isn't recommended.
  56.  
  57.      -w          Use of the ``-w'' flag will simulate having the  program  run
  58.                  from  within  a window (e.g. the more succinct output format,
  59.                  and so on).  Most likely, rather than using this  option  you
  60.                  should be simply invoking wnewmail instead.
  61.  
  62.      File specs are made up of two components, the folder name and the  prefix
  63.      string,  the  latter  of  which  can  always  be  omitted.  The format is
  64.      foldername=prefixstring, and you can specify folders  by  full  name,  by
  65.      simply  the name of the user whose mailbox should be monitored, or by the
  66.      standard Elm metacharacters to specify your folder directory (e.g. ``+'',
  67.      ``='', or ``%'').
  68.  
  69.      Folders that cannot be opened due to permission mismatches will cause the
  70.      program to immediately abort.  On the other hand, files that do not exist
  71.      will continue to be checked every interval seconds, so some  care  should
  72.      be exercised when invoking the program.
  73.  
  74.      The program will run until you log out or explicitly  kill  it,  and  can
  75.      internally  reset  itself  if  any of the folders shrink in size and then
  76.      grow again.
  77.  
  78.      The default folder to monitor is always your incoming mailbox.
  79.  
  80. EXAMPLES
  81.      Some example invocations:
  82.  
  83.           $ newmail
  84.  
  85.      will check your imcoming mailbox every 60 seconds.
  86.  
  87.           $ newmail  -i  15  joe  root
  88.  
  89.      will monitor the incoming mailboxes for ``joe''  and  ``root'',  checking
  90.      every 15 seconds for new mail.
  91.  
  92.           $ newmail  "mary=Mary"  +postmaster=POBOX
  93.  
  94.      will monitor the  incoming  mailbox  for  user  ``mary'',  prefixing  all
  95.      messages  with  the  string ``Mary'', and the folder in the users maildir
  96.      directory called ``postmaster'', prefixing all  of  those  messages  with
  97.      ``POBOX''.
  98.  
  99.      You can also have more complex monitoring too, for example:
  100.  
  101.           $ newmail  -i  30  $LOGNAME=me  ${LOGNAME}su=myroot   /tmp/mbox
  102.  
  103.      will check every 30 seconds for the users mailbox, a mailbox that is  the
  104.      users   login-name  with  ``su''  appended  (e.g.  ``joe''  would  become
  105.      ``joesu'') and the file /tmp/mbox,  prefixing  new  mail  for  each  with
  106.      ``me'', ``myroot'' and ``mbox'' respectively.
  107.  
  108. AUTHOR
  109.      Dave Taylor, Hewlett-Packard Laboratories.
  110.  
  111. SEE ALSO
  112.      notify in sh(1) or csh(1)
  113.  
  114. BUG REPORTS TO
  115.      Syd Weinstein elm@DSI.COM (dsinc!elm)
  116.  
  117. COPYRIGHTS
  118.      (c) Copyright 1986, 1987 by Dave Taylor
  119.      (c) Copyright 1988, 1989, 1990 by The USENET Community Trust
  120.