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

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH MSGCHK %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   5 .SH NAME
   6 msgchk \- check for messages
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B msgchk
  11 .RB [ \-date " | " \-nodate ]
  12 .RB [ \-notify
  13 all/mail/nomail ]
  14 .RB [ \-nonotify
  15 all/mail/nomail ]
  16 %nmhbeginpop%
  17 .RB [ \-host
  18 .IR hostname ]
  19 .RB [ \-user
  20 .IR username ]
  21 .RB [ \-apop " | " \-noapop ]
  22 .RB [ \-kpop ]
  23 .RB [ \-sasl ]
  24 .RB [ \-saslmech
  25 .IR mechanism ]
  26 .RB [ \-snoop ]
  27 %nmhendpop%
  28 .RI [ users
  29 \&... ]
  30 .RB [ \-version ]
  31 .RB [ \-help ]
  32 .ad
  33 .SH DESCRIPTION
  34 The
  35 .B msgchk
  36 program checks all known mail drops for mail waiting
  37 for you.  For those drops which have mail for you,
  38 .B msgchk
  39 will
  40 indicate if it believes that you have seen the mail in question before.
  41 .PP
  42 The
  43 .B \-notify
  44 .I type
  45 switch indicates under what circumstances
  46 .B msgchk
  47 should produce a message.  The default is
  48 .B \-notify
  49 .I all
  50 which says that
  51 .B msgchk
  52 should always report the status of the
  53 users maildrop.  Other values for `type' include `mail' which says that
  54 .B msgchk
  55 should report the status of waiting mail; and, `nomail'
  56 which says that
  57 .B msgchk
  58 should report the status of empty maildrops.
  59 The
  60 .B \-nonotify
  61 .I type
  62 switch has the inverted sense, so
  63 .B \-nonotify
  64 .I all
  65 directs
  66 .B msgchk
  67 to never report the status of
  68 maildrops.  This is useful if the user wishes to check
  69 .BR msgchk 's
  70 exit status.  A non\-zero exit status indicates that mail was
  71 .B not
  72 waiting for at least one of the indicated users.
  73 .PP
  74 If
  75 .B msgchk
  76 produces output, then the
  77 .B \-date
  78 switch directs
  79 .B msgchk
  80 to print out the last date mail was read, if this can
  81 be determined.
  82 %nmhbeginpop%
  83
  84 .SS "Using POP"
  85 .B msgchk
  86 will normally check all the local mail drops, but if
  87 the option \*(lqpophost:\*(rq is set in the mts configuration file
  88 \*(lqmts.conf\*(rq, or if the
  89 .B \-host
  90 .I hostname
  91 switch is given,
  92 .B msgchk
  93 will query this POP service host as to the status of
  94 mail waiting.
  95 .PP
  96 The default is for
  97 .B msgchk
  98 to assume that your account name
  99 on the POP server is the same as your current username.  To specify
 100 a different username, use the `\-user\ username' switch.
 101 .PP
 102 When using POP, you will normally need to type the password for
 103 your account on the POP server, in order to retrieve your messages.
 104 It is possible to automate this process by creating a
 105 .RI \*(lq \&.netrc \*(rq
 106 file containing your login account information for this POP server.
 107 For each POP server, this file should have a line of the following
 108 form.  Replace the words
 109 .IR mypopserver ,
 110 .IR mylogin ,
 111 and
 112 .I mypassword
 113 with
 114 your own account information.
 115 .PP
 116 .RS 5
 117 machine
 118 .I mypopserver
 119 login
 120 .I mylogin
 121 password
 122 .I mypassword
 123 .RE
 124 .PP
 125 This
 126 .RI \*(lq \&.netrc \*(rq
 127 file should be owned and readable only by you.
 128 .PP
 129 For debugging purposes, there is also a switch
 130 .BR \-snoop ,
 131 which will
 132 allow you to watch the POP transaction take place between you and the
 133 POP server.
 134 .PP
 135 If
 136 .B nmh
 137 has been compiled with APOP support, the
 138 .B \-apop
 139 switch will cause
 140 .B msgchk
 141 to use APOP rather than standard POP3 authentication.  Under APOP,
 142 a unique string (generally of the format
 143 .RI < pid . timestamp @ hostname >)
 144 is announced by the POP server.
 145 Rather than `USER
 146 .IR user ',
 147 `PASS
 148 .IR password ',
 149 .B msgchk
 150 sends `APOP
 151 .I user
 152 .IR digest ',
 153 where digest is the MD5 hash of the unique string
 154 followed by a `secret' shared by client and server, essentially equivalent to
 155 the user's password (though an APOP-enabled POP3 server could have separate APOP
 156 and plain POP3 passwords for a single user).
 157 .B \-noapop
 158 disables APOP in cases
 159 where it'd otherwise be used.
 160 .PP
 161 If
 162 .B nmh
 163 has been compiled with KPOP support, the
 164 .B \-kpop
 165 switch will allow
 166 .B msgchk
 167 to use Kerberized POP rather than standard POP3 on a given
 168 invocation.  If
 169 .B POPSERVICE
 170 was also #defined to "kpop",
 171 .B msgchk
 172 will be
 173 hardwired to always use KPOP.
 174 .PP
 175 If
 176 .B nmh
 177 has been compiled with SASL support, the
 178 .B \-sasl
 179 switch will enable
 180 the use of SASL authentication.  Depending on the SASL mechanism used, this
 181 may require an additional password prompt from the user (but the
 182 .RI \*(lq \&.netrc \*(rq
 183 file can be used to store this password).  The
 184 .B \-saslmech
 185 switch can be used to select a particular SASL mechanism.
 186 .PP
 187 If SASL authentication is successful,
 188 .B inc
 189 will attempt to negotiate
 190 a security layer for session encryption.  Encrypted traffic is labelled
 191 with `(encrypted)' and `(decrypted)' when viewing the POP transaction
 192 with the
 193 .B \-snoop
 194 switch.
 195 %nmhendpop%
 196
 197 .SH FILES
 198 .fc ^ ~
 199 .nf
 200 .ta \w'%etcdir%/ExtraBigFileName  'u
 201 ^$HOME/\&.mh\(ruprofile~^The user profile
 202 ^%etcdir%/mts.conf~^nmh mts configuration file
 203 ^%mailspool%/$USER~^Location of mail drop
 204 .fi
 205
 206 .SH "PROFILE COMPONENTS"
 207 .fc ^ ~
 208 .nf
 209 .ta 2.4i
 210 .ta \w'ExtraBigProfileName  'u
 211 None
 212 .fi
 213
 214 .SH "SEE ALSO"
 215 inc(1)
 216
 217 .SH DEFAULTS
 218 .nf
 219 .RB ` user "' defaults to the current user"
 220 .RB ` \-date '
 221 .RB ` "\-notify\ all" '
 222 .fi
 223
 224 .SH CONTEXT
 225 None