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