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 \%[\-apop]
  24 \%[\-noapop]
  25 \%[\-kpop]
  26 \%[\-sasl]
  27 \%[\-saslmech \mechanism]
  28 \%[\-snoop]
  29 .br
  30 %nmhendpop%
  31 \%[users\ ...]
  32 \%[\-version]
  33 \%[\-help]
  34 .in -.5i
  35 .SH DESCRIPTION
  36 The \fImsgchk\fR program checks all known mail drops for mail waiting
  37 for you.  For those drops which have mail for you, \fImsgchk\fR will
  38 indicate if it believes that you have seen the mail in question before.
  39
  40 The `\-notify\ type' switch indicates under what circumstances
  41 \fImsgchk\fR should produce a message.  The default is `\-notify\ all'
  42 which says that \fImsgchk\fR should always report the status of the
  43 users maildrop.  Other values for `type' include `mail' which says that
  44 \fImsgchk\fR should report the status of waiting mail; and, `nomail'
  45 which says that \fImsgchk\fR should report the status of empty maildrops.
  46 The `\-nonotify\ type' switch has the inverted sense, so
  47 `\-nonotify\ all' directs \fImsgchk\fR to never report the status of
  48 maildrops.  This is useful if the user wishes to check \fImsgchk\fR's
  49 exit status.  A non\-zero exit status indicates that mail was \fBnot\fR
  50 waiting for at least one of the indicated users.
  51
  52 If \fImsgchk\fR produces output, then the `\-date' switch directs
  53 \fImsgchk\fR to print out the last date mail was read, if this can
  54 be determined.
  55 %nmhbeginpop%
  56
  57 .Uh "Using POP"
  58 \fImsgchk\fR will normally check all the local mail drops, but if
  59 the option \*(lqpophost:\*(rq is set in the mts configuration file
  60 \*(lqmts.conf\*(rq, or if the `\-host\ hostname' switch is given,
  61 \fImsgchk\fR will query this POP service host as to the status of
  62 mail waiting.
  63
  64 The default is for \fImsgchk\fR to assume that your account name
  65 on the POP server is the same as your current username.  To specify
  66 a different username, use the `\-user\ username' switch.
  67
  68 When using POP, you will normally need to type the password for
  69 your account on the POP server, in order to retrieve your messages.
  70 It is possible to automate this process by creating a \*(lq.netrc\*(rq
  71 file containing your login account information for this POP server.
  72 For each POP server, this file should have a line of the following
  73 form.  Replace the words mypopserver, mylogin, and mypassword with
  74 your own account information.
  75
  76 machine mypopserver login mylogin password mypassword
  77
  78 This \*(lq.netrc\*(rq file should be owned and readable only by
  79 you.
  80
  81 For debugging purposes, there is also a switch `\-snoop', which will
  82 allow you to watch the POP transaction take place between you and the
  83 POP server.
  84
  85 If nmh has been compiled with APOP #defined, the `\-apop' switch will cause
  86 \fImsgchk\fR to use APOP rather than standard POP3 authentication.  Under APOP,
  87 a unique string (generally of the format
  88 <\fIpid\fR.\fItimestamp\fR@\fIhostname\fR>) is announced by the POP server.
  89 Rather than `USER \fIuser\fR', `PASS \fIpassword\fR', msgchk sends `APOP
  90 \fIuser\fR \fIdigest\fR', where digest is the MD5 hash of the unique string
  91 followed by a `secret' shared by client and server, essentially equivalent to
  92 the user's password (though an APOP-enabled POP3 server could have separate APOP
  93 and plain POP3 passwords for a single user).  `\-noapop' disables APOP in cases
  94 where it'd otherwise be used.
  95
  96 If nmh has been compiled with KPOP #defined, the `\-kpop' switch will allow
  97 \fImsgchk\fR to use Kerberized POP rather than standard POP3 on a given
  98 invocation.  If POPSERVICE was also #defined to "kpop", \fImsgchk\fR will be
  99 hardwired to always use KPOP.
 100
 101 If nmh has been compiled with SASL support, the `\-sasl' switch will enable
 102 the use of SASL authentication.  Depending on the SASL mechanism used, this
 103 may require an additional password prompt from the user (but the
 104 \*(lq.netrc\*(rq file can be used to store this password).  The
 105 `\-saslmech' switch can be used to select a particular SASL mechanism.
 106
 107 If SASL authentication is successful, \fIinc\fR will attempt to negotiate
 108 a security layer for session encryption.  Encrypted traffic is labelled
 109 with `(encrypted)' and `(decrypted)' when viewing the POP transaction
 110 with the `\-snoop' switch.
 111 %nmhendpop%
 112 .Fi
 113 ^$HOME/\&.mh\(ruprofile~^The user profile
 114 ^%etcdir%/mts.conf~^nmh mts configuration file
 115 ^%mailspool%/$USER~^Location of mail drop
 116 .Pr
 117 None
 118 .Sa
 119 inc(1)
 120 .De
 121 `user' defaults to the current user
 122 .Ds
 123 `\-date'
 124 .Ds
 125 `\-notify\ all'
 126 .Co
 127 None
 128 .En