clients/zmailnotify/zmailnotify.1

   1 .\"     $Id: zmailnotify.1,v 1.8 1999/01/22 23:18:38 ghudson Exp $
   2 .\"
   3 .\" Copyright 1988 by the Massachusetts Institute of Technology
   4 .\" All rights reserved.  The file /usr/include/zephyr/mit-copyright.h
   5 .\" specifies the terms and conditions for redistribution.
   6 .\"
   7 .TH ZMAILNOTIFY 1 "July 8, 1988" "MIT Project Athena"
   8 .ds ]W MIT Project Athena
   9 .SH NAME
  10 zmailnotify \- retrieve mail headers from post office and transmit via Zephyr
  11 .SH SYNOPSIS
  12 .B zmailnotify
  13 .SH DESCRIPTION
  14 .I zmailnotify
  15 connects to the invoking user's POP post office and retrieves the From,
  16 To, and Subject fields of waiting messages, and then sends one Zephyr
  17 notice per message to class MAIL, instance POPRET, recipient
  18 .I <user@realm>,
  19 where <user@realm> is the invoking user's username concatenated with the
  20 local Zephyr realm (e.g. jruser@ATHENA.MIT.EDU).
  21 .PP
  22 .I zmailnotify
  23 is intended to be executed by
  24 .I zwgc(1)
  25 when notifications of spooled mail (such
  26 as those generated by \fIzpopnotify(8)\fR) are delivered.
  27 By default, these notifications are not delivered, nor are they acted
  28 upon.  To receive the notices, you must subscribe to class MAIL,
  29 instance POP, recipient username@realm  (see \fIzctl\fR(1)).
  30 Once you subscribe to these notices, by default they will be simply
  31 displayed on your display or terminal by
  32 .I zwgc(1).
  33 To have
  34 .I zmailnotify
  35 executed when they are delivered, you must copy the system default
  36 windowgram description file (\fI/usr/athena/lib/zephyr/zwgc.desc\fR) to your home
  37 directory as filename
  38 .I ~/.zwgc.desc
  39 and follow the directions contained in that file pertaining to
  40 .B MAIL NOTIFICATION.
  41 .PP
  42 .I zmailnotify
  43 only retrieves four headers at one time in order to reduce the
  44 competition for the mailbox lock on the post office.  If more than four mail
  45 messages are waiting,
  46 .I zmailnotify
  47 will only retrieve the four most recent mail headers.
  48 .PP
  49 To check for mail already waiting when you log in, use the standard MH
  50 program
  51 .I msgchk(1).
  52 .SH BUGS
  53 .I zmailnotify
  54 only sends notification of mail which appears to be unique.
  55 Uniqueness is determined by comparing the To:, From:, and Subject:
  56 fields of the message with the last checked mail message; if the
  57 three fields match exactly, the new message is
  58 not considered unique.  The To:, From:, and Subject: fields of the last
  59 message are stored in the file
  60 .IR $HOME/.maillock .
  61 .SH FILES
  62 $HOME/.maillock
  63 .SH SEE ALSO
  64 msgchk(1), zctl(1), zephyr(1), zwgc(1), zhm(8), zephyrd(8),
  65 zpopnotify(8), popd(8)
  66 .br
  67 Project Athena Technical Plan Section E.4.1, `Zephyr Notification
  68 Service'
  69 .SH AUTHOR
  70 .PP
  71 Robert S. French (MIT-Project Athena)
  72 .SH RESTRICTIONS
  73 Copyright (c) 1987,1988 by the Massachusetts Institute of Technology.
  74 All Rights Reserved.
  75 .br
  76 .I zephyr(1)
  77 specifies the terms and conditions for redistribution.