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