git.marmaro.de Git - mmh/blob - man/msgchk.man

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH MSGCHK %manext1% MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 msgchk \- check for messages
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 msgchk
  15 \%[\-date] \%[\-nodate]
  16 \%[\-notify\ all/mail/nomail]
  17 .br
  18 \%[\-nonotify\ all/mail/nomail]
  19 .br
  20 %nmhbeginpop%
  21 \%[\-host\ hostname]
  22 \%[\-user\ username]
  23 \%[\-kpop]
  24 \%[\-sasl]
  25 \%[\-saslmech \mechanism]
  26 .br
  27 %nmhendpop%
  28 \%[users\ ...]
  29 \%[\-version]
  30 \%[\-help]
  31 .in -.5i
  32 .SH DESCRIPTION
  33 The \fImsgchk\fR program checks all known mail drops for mail waiting
  34 for you.  For those drops which have mail for you, \fImsgchk\fR will
  35 indicate if it believes that you have seen the mail in question before.
  36
  37 The `\-notify\ type' switch indicates under what circumstances
  38 \fImsgchk\fR should produce a message.  The default is `\-notify\ all'
  39 which says that \fImsgchk\fR should always report the status of the
  40 users maildrop.  Other values for `type' include `mail' which says that
  41 \fImsgchk\fR should report the status of waiting mail; and, `nomail'
  42 which says that \fImsgchk\fR should report the status of empty maildrops.
  43 The `\-nonotify\ type' switch has the inverted sense, so
  44 `\-nonotify\ all' directs \fImsgchk\fR to never report the status of
  45 maildrops.  This is useful if the user wishes to check \fImsgchk\fR's
  46 exit status.  A non\-zero exit status indicates that mail was \fBnot\fR
  47 waiting for at least one of the indicated users.
  48
  49 If \fImsgchk\fR produces output, then the `\-date' switch directs
  50 \fImsgchk\fR to print out the last date mail was read, if this can
  51 be determined.
  52 %nmhbeginpop%
  53
  54 .Uh "Using POP"
  55 \fImsgchk\fR will normally check all the local mail drops, but if
  56 the option \*(lqpophost:\*(rq is set in the mts configuration file
  57 \*(lqmts.conf\*(rq, or if the `\-host\ hostname' switch is given,
  58 \fImsgchk\fR will query this POP service host as to the status of
  59 mail waiting.
  60
  61 The default is for \fImsgchk\fR to assume that your account name
  62 on the POP server is the same as your current username.  To specify
  63 a different username, use the `\-user\ username' switch.
  64
  65 When using POP, you will normally need to type the password for
  66 your account on the POP server, in order to retrieve your messages.
  67 It is possible to automate this process by creating a \*(lq.netrc\*(rq
  68 file containing your login account information for this POP server.
  69 For each POP server, this file should have a line of the following
  70 form.  Replace the words mypopserver, mylogin, and mypassword with
  71 your own account information.
  72
  73 machine mypopserver login mylogin password mypassword
  74
  75 This \*(lq.netrc\*(rq file should be owned and readable only by
  76 you.
  77
  78 For debugging purposes, there is also a switch `\-snoop', which will
  79 allow you to watch the POP transaction take place between you and the
  80 POP server.
  81
  82 If nmh has been compiled with KPOP #defined, the `\-kpop' switch will allow
  83 \fImsgchk\fR to use Kerberized POP rather than standard POP3 on a given
  84 invocation.  If POPSERVICE was also #defined to "kpop", \fImsgchk\fR will be
  85 hardwired to always use KPOP.
  86
  87 If nmh has been compiled with SASL support, the `\-sasl' switch will enable
  88 the use of SASL authentication.  Depending on the SASL mechanism used, this
  89 may require an additional password prompt from the user (but the
  90 \*(lq.netrc\*(rq file can be used to store this password).  The
  91 `\-saslmech' switch can be used to select a particular SASL mechanism.
  92
  93 If SASL authentication is successful, \fIinc\fR will attempt to negotiate
  94 a security layer for session encryption.  Encrypted traffic is labelled
  95 with `(encrypted)' and `(decrypted)' when viewing the POP transaction
  96 with the `\-snoop' switch.
  97 %nmhendpop%
  98 .Fi
  99 ^$HOME/\&.mh\(ruprofile~^The user profile
 100 ^%etcdir%/mts.conf~^nmh mts configuration file
 101 ^%mailspool%/$USER~^Location of mail drop
 102 .Pr
 103 None
 104 .Sa
 105 inc(1)
 106 .De
 107 `user' defaults to the current user
 108 .Ds
 109 `\-date'
 110 .Ds
 111 `\-notify\ all'
 112 .Co
 113 None
 114 .En