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

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH INC %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 inc \- incorporate new mail
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 inc
  15 \%[+folder]
  16 \%[\-audit\ audit\-file] \%[\-noaudit]
  17 \%[\-changecur]
  18 .br
  19 \%[\-nochangecur]
  20 \%[\-form\ formatfile]
  21 \%[\-format\ string]
  22 .br
  23 \%[\-file\ name]
  24 \%[\-silent] \%[\-nosilent]
  25 \%[\-truncate]
  26 .br
  27 \%[\-notruncate]
  28 \%[\-width\ columns]
  29 %nmhbeginpop%
  30 \%[\-host\ hostname]
  31 .br
  32 \%[\-user\ username]
  33 \%[\-pack\ file]
  34 \%[\-nopack]
  35 \%[\-apop]
  36 \%[\-noapop]
  37 \%[\-kpop]
  38 \%[\-sasl]
  39 \%[\-saslmech\ mechanism]
  40 \%[\-snoop]
  41 .br
  42 %nmhendpop%
  43 \%[\-version]
  44 \%[\-help]
  45 .in -.5i
  46 .SH DESCRIPTION
  47 \fIInc\fR incorporates mail from the user's incoming mail drop into
  48 an \fInmh\fR folder.
  49
  50 You may specify which folder to use with `+folder'.  If no folder
  51 is specified, then \fIinc\fR will use either the folder given by a
  52 (non\-empty) \*(lqInbox:\*(rq entry in the user's profile, or the folder
  53 named \*(lqinbox\*(rq.  If the specified (or default) folder doesn't
  54 exist, the user will be queried prior to its creation.
  55
  56 When the new messages are incorporated into the folder, they are assigned
  57 numbers starting with the next highest number for the folder.  As the
  58 messages are processed, a \fIscan\fR listing of the new mail is produced.
  59
  60 If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
  61 will be used as the protection on the newly created messages, otherwise
  62 the \fInmh\fR default of 0644 will be used.  For all subsequent operations
  63 on these messages, this initially assigned protection will be preserved.
  64
  65 If the switch `\-audit\ audit\-file' is specified (usually as a default
  66 switch in the profile), then \fIinc\fR will append a header line and a
  67 line per message to the end of the specified audit\-file with the format:
  68
  69 .nf
  70 .ti 1i
  71 \*(<<inc\*(>> date
  72 .ti 1.5i
  73 <scan line for first message>
  74 .ti 1.5i
  75 <scan line for second message>
  76 .ti 2.5i
  77 <etc.>
  78 .fi
  79
  80 This is useful for keeping track of volume and source of incoming mail.
  81 Eventually, \fIrepl\fR, \fIforw\fR, \fIcomp\fR, and \fIdist\fR
  82 may also produce audits to this (or another) file, perhaps with
  83 \*(lqMessage\-Id:\*(rq information to keep an exact correspondence
  84 history.  \*(lqAudit\-file\*(rq will be in the user's nmh directory unless
  85 a full path is specified.
  86
  87 \fIInc\fR will incorporate even improperly formatted messages into the
  88 user's nmh folder, inserting a blank line prior to the offending component
  89 and printing a comment identifying the bad message.
  90
  91 In all cases, the user's mail drop will be zeroed, unless the
  92 `\-notruncate' switch is given.
  93
  94 If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
  95 then \fIinc\fR will add each of the newly incorporated messages to
  96 each sequence named by the profile entry.  \fIInc\fR will not zero each
  97 sequence prior to adding messages.
  98
  99 The interpretation of the `\-form\ formatfile', `\-format\ string', and
 100 `\-width\ columns' switches is the same as in \fIscan\fR\0(1).
 101
 102 By using the `\-file\ name' switch, one can direct \fIinc\fR to
 103 incorporate messages from a file other than the user's maildrop.
 104 Note that the name file will NOT be zeroed, unless the `\-truncate'
 105 switch is given.
 106
 107 If the environment variable \fB$MAILDROP\fR is set, then \fIinc\fR
 108 uses it as the location of the user's maildrop instead of the default
 109 (the `-file\ name' switch still overrides this, however).  If this
 110 environment variable is not set, then \fIinc\fR will consult the profile
 111 entry \*(lqMailDrop\*(rq for this information.  If the value found is
 112 not absolute, then it is interpreted relative to the user's \fInmh\fR
 113 directory.  If the value is not found, then \fIinc\fR will look in the
 114 standard system location for the user's maildrop.
 115
 116 The `\-silent' switch directs \fIinc\fR to be quiet and not ask any
 117 questions at all.  This is useful for putting \fIinc\fR in the background
 118 and going on to other things.
 119 %nmhbeginpop%
 120
 121 .Uh "Using POP"
 122 \fIinc\fR will normally check local mail drops for mail, as covered above.  But
 123 if the option \*(lqpophost:\*(rq is set in \*(lqmts.conf\*(rq, or if the
 124 `\-host\ hostname' switch is given, or if the \fB$MAILHOST\fR environment
 125 variable is set, then \fIinc\fR will query this POP service host for mail to
 126 incorporate.  If \fB$MAILHOST\fR is set and \-host is specified as well, the
 127 commandline switch will override the environment variable.
 128
 129 The default is for \fIinc\fR to assume that your account name on
 130 the POP server is the same as your current username.  To specify
 131 a different username, use the `\-user\ username' switch.
 132
 133 When using POP, you will normally need to type the password for
 134 your account on the POP server, in order to retrieve your messages.
 135 It is possible to automate this process by creating a \*(lq.netrc\*(rq
 136 file containing your login account information for this POP server.
 137 For each POP server, this file should have a line of the following
 138 form.  Replace the words mypopserver, mylogin, and mypassword with
 139 your own account information.
 140
 141 machine mypopserver login mylogin password mypassword
 142
 143 This \*(lq.netrc\*(rq file should be owned and readable only by
 144 you.
 145
 146 If \fIinc\fR uses POP, then the `\-pack\ file' switch is considered.
 147 If given, then \fIinc\fR simply uses the POP to \fIpackf\fR\0(1) the
 148 user's maildrop from the POP service host to the named file.  This switch
 149 is provided for those users who prefer to use \fImsh\fR to read their
 150 maildrops.
 151
 152 For debugging purposes, you may give the switch `\-snoop', which will
 153 allow you to watch the POP transaction take place between you and the
 154 POP server.
 155
 156 If nmh has been compiled with APOP #defined, the `\-apop' switch will cause
 157 \fIinc\fR to use APOP rather than standard POP3 authentication.  Under APOP, a
 158 unique string (generally of the format
 159 <\fIpid\fR.\fItimestamp\fR@\fIhostname\fR>) is announced by the POP server.
 160 Rather than `USER \fIuser\fR', `PASS \fIpassword\fR', inc sends `APOP \fIuser\fR
 161 \fIdigest\fR', where digest is the MD5 hash of the unique string followed by a
 162 `secret' shared by client and server, essentially equivalent to the user's
 163 password (though an APOP-enabled POP3 server could have separate APOP and plain
 164 POP3 passwords for a single user).  `\-noapop' disables APOP in cases where it'd
 165 otherwise be used.
 166
 167 If nmh has been compiled with KPOP #defined, the `\-kpop' switch will allow
 168 \fIinc\fR to use Kerberized POP rather than standard POP3 on a given invocation.
 169 If POPSERVICE was also #defined to "kpop", \fIinc\fR will be hardwired to always
 170 use KPOP.
 171
 172 If nmh has been compiled with SASL support, the `\-sasl' switch will enable
 173 the use of SASL authentication.  Depending on the SASL mechanism used, this
 174 may require an additional password prompt from the user (but the
 175 \*(lq.netrc\*(rq file can be used to store this password).  The
 176 `\-saslmech' switch can be used to select a particular SASL mechanism.
 177
 178 If SASL authentication is successful, \fIinc\fR will attempt to negotiate
 179 a security layer for session encryption.  Encrypted traffic is labelled
 180 with `(encrypted)' and `(decrypted)' when viewing the POP transaction
 181 with the `\-snoop' switch.
 182 %nmhendpop%
 183 .Fi
 184 ^$HOME/\&.mh\(ruprofile~^The user profile
 185 ^%etcdir%/mts.conf~^nmh mts configuration file
 186 ^%mailspool%/$USER~^Location of mail drop
 187 .Pr
 188 ^Path:~^To determine the user's nmh directory
 189 .Ps
 190 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 191 .Ps
 192 ^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq
 193 .Ps
 194 ^Folder\-Protect:~^To set mode when creating a new folder
 195 .Ps
 196 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
 197 .Ps
 198 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 199 .Sa
 200 mhmail(1), scan(1), mh\-mail(5), post(8)
 201 .De
 202 `+folder' defaulted by \*(lqInbox\*(rq above
 203 .Ds
 204 `\-noaudit'
 205 .Ds
 206 `\-changecur'
 207 .Ds
 208 `\-format' defaulted as described above
 209 .Ds
 210 `\-nosilent'
 211 .Ds
 212 `\-truncate' if `\-file\ name' not given, `\-notruncate' otherwise
 213 .Ds
 214 `\-width' defaulted to the width of the terminal
 215 %nmhbeginpop%
 216 .Ds
 217 `\-nopack'
 218 %nmhendpop%
 219 .Co
 220 The folder into which messages are being incorporated will become the
 221 current folder.  The first message incorporated will become the current
 222 message, unless the `\-nochangecur' option is specified.  This leaves
 223 the context ready for a \fIshow\fR of the first new message.
 224 .Bu
 225 The argument to the `\-format' switch must be interpreted as a single
 226 token by the shell that invokes \fIinc\fR.  Therefore, one must usually
 227 place the argument to this switch inside double\-quotes.
 228 .En