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 [ \-sasl ]
  22 .RB [ \-saslmech
  23 .IR mechanism ]
  24 .RB [ \-snoop ]
  25 %nmhendpop%
  26 .RI [ users
  27 \&... ]
  28 .RB [ \-version ]
  29 .RB [ \-help ]
  30 .ad
  31 .SH DESCRIPTION
  32 The
  33 .B msgchk
  34 program checks all known mail drops for mail waiting
  35 for you.  For those drops which have mail for you,
  36 .B msgchk
  37 will
  38 indicate if it believes that you have seen the mail in question before.
  39 .PP
  40 The
  41 .B \-notify
  42 .I type
  43 switch indicates under what circumstances
  44 .B msgchk
  45 should produce a message.  The default is
  46 .B \-notify
  47 .I all
  48 which says that
  49 .B msgchk
  50 should always report the status of the
  51 users maildrop.  Other values for `type' include `mail' which says that
  52 .B msgchk
  53 should report the status of waiting mail; and, `nomail'
  54 which says that
  55 .B msgchk
  56 should report the status of empty maildrops.
  57 The
  58 .B \-nonotify
  59 .I type
  60 switch has the inverted sense, so
  61 .B \-nonotify
  62 .I all
  63 directs
  64 .B msgchk
  65 to never report the status of
  66 maildrops.  This is useful if the user wishes to check
  67 .BR msgchk 's
  68 exit status.  A non\-zero exit status indicates that mail was
  69 .B not
  70 waiting for at least one of the indicated users.
  71 .PP
  72 If
  73 .B msgchk
  74 produces output, then the
  75 .B \-date
  76 switch directs
  77 .B msgchk
  78 to print out the last date mail was read, if this can
  79 be determined.
  80 %nmhbeginpop%
  81
  82 .SS "Using POP"
  83 .B msgchk
  84 will normally check all the local mail drops, but if
  85 the option \*(lqpophost:\*(rq is set in the mts configuration file
  86 \*(lqmts.conf\*(rq, or if the
  87 .B \-host
  88 .I hostname
  89 switch is given,
  90 .B msgchk
  91 will query this POP service host as to the status of
  92 mail waiting.
  93 .PP
  94 The default is for
  95 .B msgchk
  96 to assume that your account name
  97 on the POP server is the same as your current username.  To specify
  98 a different username, use the `\-user\ username' switch.
  99 .PP
 100 When using POP, you will normally need to type the password for
 101 your account on the POP server, in order to retrieve your messages.
 102 It is possible to automate this process by creating a
 103 .RI \*(lq \&.netrc \*(rq
 104 file containing your login account information for this POP server.
 105 For each POP server, this file should have a line of the following
 106 form.  Replace the words
 107 .IR mypopserver ,
 108 .IR mylogin ,
 109 and
 110 .I mypassword
 111 with
 112 your own account information.
 113 .PP
 114 .RS 5
 115 machine
 116 .I mypopserver
 117 login
 118 .I mylogin
 119 password
 120 .I mypassword
 121 .RE
 122 .PP
 123 This
 124 .RI \*(lq \&.netrc \*(rq
 125 file should be owned and readable only by you.
 126 .PP
 127 For debugging purposes, there is also a switch
 128 .BR \-snoop ,
 129 which will
 130 allow you to watch the POP transaction take place between you and the
 131 POP server.
 132 .PP
 133 If
 134 .B nmh
 135 has been compiled with SASL support, the
 136 .B \-sasl
 137 switch will enable
 138 the use of SASL authentication.  Depending on the SASL mechanism used, this
 139 may require an additional password prompt from the user (but the
 140 .RI \*(lq \&.netrc \*(rq
 141 file can be used to store this password).  The
 142 .B \-saslmech
 143 switch can be used to select a particular SASL mechanism.
 144 .PP
 145 If SASL authentication is successful,
 146 .B inc
 147 will attempt to negotiate
 148 a security layer for session encryption.  Encrypted traffic is labelled
 149 with `(encrypted)' and `(decrypted)' when viewing the POP transaction
 150 with the
 151 .B \-snoop
 152 switch.
 153 %nmhendpop%
 154
 155 .SH FILES
 156 .fc ^ ~
 157 .nf
 158 .ta \w'%etcdir%/ExtraBigFileName  'u
 159 ^$HOME/\&.mh\(ruprofile~^The user profile
 160 ^%etcdir%/mts.conf~^nmh mts configuration file
 161 ^%mailspool%/$USER~^Location of mail drop
 162 .fi
 163
 164 .SH "PROFILE COMPONENTS"
 165 .fc ^ ~
 166 .nf
 167 .ta 2.4i
 168 .ta \w'ExtraBigProfileName  'u
 169 None
 170 .fi
 171
 172 .SH "SEE ALSO"
 173 inc(1)
 174
 175 .SH DEFAULTS
 176 .nf
 177 .RB ` user "' defaults to the current user"
 178 .RB ` \-date '
 179 .RB ` "\-notify\ all" '
 180 .fi
 181
 182 .SH CONTEXT
 183 None