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

   1 .TH INC %manext1% "November 6, 2012" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 inc \- incorporate new mail
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B inc
  11 .RI [ +folder ]
  12 .RB [ \-audit
  13 .IR audit\-file ]
  14 .RB [ \-noaudit ]
  15 .RB [ \-changecur " | " \-nochangecur ]
  16 .RB [ \-form
  17 .IR formfile ]
  18 .RB [ \-format
  19 .IR string ]
  20 .RB [ \-file
  21 .IR name ]
  22 .RB [ \-silent " | " \-nosilent ]
  23 .RB [ \-truncate " | " \-notruncate ]
  24 .RB [ \-width
  25 .IR columns ]
  26 .RB [ \-host
  27 .IR hostname ]
  28 .RB [ \-port
  29 .IR portname/number ]
  30 .RB [ \-user
  31 .IR username ]
  32 .RB [ \-pack
  33 .IR file ]
  34 .RB [ \-nopack ]
  35 .RB [ \-proxy
  36 .IR command ]
  37 .RB [ \-sasl " | " \-nosasl ]
  38 .RB [ \-saslmech
  39 .IR mechanism ]
  40 .RB [ \-snoop ]
  41 .RB [ \-version ]
  42 .RB [ \-help ]
  43 .ad
  44 .SH DESCRIPTION
  45 .B Inc
  46 incorporates mail from the user's incoming mail drop into
  47 an
  48 .B nmh
  49 folder.
  50 If the mail drop is a file, it can be in
  51 .B mbox
  52 or
  53 .B MMDF
  54 format.
  55 If the mail drop is a directory it will considered to be a
  56 .B Maildir
  57 format mail drop.
  58 .PP
  59 You may specify which folder to use with
  60 .IR +folder .
  61 If no folder is specified, then
  62 .B inc
  63 will use either the folder given by a (non\-empty)
  64 .RI \*(lq Inbox \*(rq
  65 entry in the user's profile, or the folder named
  66 .RI \*(lq inbox \*(rq.
  67 If the specified (or default) folder doesn't
  68 exist, the user will be queried prior to its creation.
  69 .PP
  70 When the new messages are incorporated into the folder, they are assigned
  71 numbers starting with the next highest number for the folder.  As the
  72 messages are processed, a
  73 .B scan
  74 listing of the new mail is produced.
  75 .PP
  76 If the user's profile contains a
  77 .RI \*(lq "Msg\-Protect: nnn" \*(rq
  78 entry, it will be used as the protection on the newly created
  79 messages, otherwise the
  80 .B nmh
  81 default of 0600 will be used (on filesystems that support it).  For
  82 all subsequent operations on these messages, this initially assigned
  83 protection will be preserved.
  84 .PP
  85 If the switch
  86 .B \-audit
  87 .I audit\-file
  88 is specified (usually as a default
  89 switch in the profile), then
  90 .B inc
  91 will append a header line and a
  92 line per message to the end of the specified audit\-file with the format:
  93 .PP
  94 .RS 5
  95 .nf
  96 <<inc>> date
  97 <scan line for first message>
  98 <scan line for second message>
  99 <etc.>
 100 .fi
 101 .RE
 102 .PP
 103 This is useful for keeping track of volume and source of incoming mail.
 104 Eventually,
 105 .BR repl ,
 106 .BR forw ,
 107 .BR comp ,
 108 and
 109 .B dist
 110 may also produce audits to this (or another) file, perhaps with
 111 .RI \*(lq Message\-Id \*(rq
 112 information to keep an exact correspondence
 113 history.
 114 .RI \*(lq Audit\-file \*(rq
 115 will be in the user's nmh directory unless a full path is specified.
 116 .PP
 117 .B Inc
 118 will incorporate even improperly formatted messages into the
 119 user's nmh folder, inserting a blank line prior to the offending component
 120 and printing a comment identifying the bad message.
 121 .PP
 122 In all cases, the user's mail drop will be zeroed, unless the
 123 .B \-notruncate
 124 switch is given.
 125 .PP
 126 If the profile entry
 127 .RI \*(lq Unseen\-Sequence \*(rq
 128 is present and non\-empty, then
 129 .B inc
 130 will add each of the newly incorporated messages to
 131 each sequence named by the profile entry.
 132 .B Inc
 133 will not zero each sequence prior to adding messages.
 134 .PP
 135 The interpretation of the
 136 .B \-form
 137 .IR formatfile ,
 138 .B \-format
 139 .IR string ,
 140 and
 141 .B \-width
 142 .I columns
 143 switches is the same as in
 144 .BR scan .
 145 .PP
 146 By using the
 147 .B \-file
 148 .I name
 149 switch, one can direct
 150 .B inc
 151 to incorporate messages from a file other than the user's maildrop.
 152 Note that the name file will NOT be zeroed, unless the
 153 .B \-truncate
 154 switch is given.
 155 .PP
 156 If the environment variable
 157 .B $MAILDROP
 158 is set, then
 159 .B inc
 160 uses it as the location of the user's maildrop instead of the default
 161 (the
 162 .B -file
 163 .I name
 164 switch still overrides this, however).  If this
 165 environment variable is not set, then
 166 .B inc
 167 will consult the profile entry
 168 .RI \*(lq MailDrop \*(rq
 169 for this information.  If the value found is
 170 not absolute, then it is interpreted relative to the user's
 171 .B nmh
 172 directory.  If the value is not found, then
 173 .B inc
 174 will look in the standard system location for the user's maildrop.
 175 .PP
 176 The
 177 .B \-silent
 178 switch directs
 179 .B inc
 180 to be quiet and not ask any questions at all.  This is useful for putting
 181 .B inc
 182 in the background and going on to other things.
 183 .PP
 184 .SS "Using POP"
 185 .B inc
 186 will normally check local mail drops for mail, as covered above.  But
 187 if the option
 188 .RI \*(lq pophost \*(rq
 189 is set in
 190 .RI \*(lq mts.conf \*(rq,
 191 or if the
 192 .B \-host
 193 .I hostname
 194 switch is given, or if the
 195 .B $MAILHOST
 196 environment variable is set, then
 197 .B inc
 198 will query this POP service host for mail to incorporate.  If
 199 .B $MAILHOST
 200 is set and
 201 .B \-host
 202 is specified as well, the commandline switch will override
 203 the environment variable.  The
 204 .B \-port
 205 switch specifies the port name or number used to connect to the POP
 206 server.  If unspecified the default is \*(lqpop3\*(rq.
 207 .PP
 208 The default is for
 209 .B inc
 210 to assume that your account name on
 211 the POP server is the same as your current username.  To specify
 212 a different username, use the
 213 .B \-user
 214 .I username
 215 switch.
 216 .PP
 217 When using POP, you will normally need to type the password for
 218 your account on the POP server, in order to retrieve your messages.
 219 It is possible to automate this process by creating a
 220 .RI \*(lq .netrc \*(rq
 221 file containing your login account information for this POP server.
 222 For each POP server, this file should have a line of the following
 223 form.  Replace the words
 224 .IR mypopserver ,
 225 .IR mylogin ,
 226 and
 227 .I mypassword
 228 with your own account information.
 229 .PP
 230 .RS 5
 231 .B machine
 232 .I mypopserver
 233 .B login
 234 .I mylogin
 235 .B password
 236 .I mypassword
 237 .RE
 238 .PP
 239 This
 240 .RI \*(lq .netrc \*(rq
 241 file should be owned and readable only by you.
 242 .PP
 243 If passed the
 244 .B \-proxy
 245 .I command
 246 switch,
 247 .B inc
 248 will use the specified command to establish the connection to the POP
 249 server. The string
 250 .IR %h
 251 in the command will be substituted by the hostname to connect to.
 252 .PP
 253 If
 254 .B inc
 255 uses POP, then the
 256 .B \-pack
 257 .I file
 258 switch is considered. If given, then
 259 .B inc
 260 simply uses the POP to
 261 .B packf
 262 the user's maildrop from the POP service host to the named file.  This switch
 263 is provided for those users who prefer to use
 264 .B msh
 265 to read their maildrops.
 266 .PP
 267 For debugging purposes, you may give the switch
 268 .BR \-snoop ,
 269 which will allow you to watch the POP transaction take place
 270 between you and the POP server.
 271 .PP
 272 If
 273 .B nmh
 274 has been compiled with SASL support, the
 275 .B \-sasl
 276 switch will enable
 277 the use of SASL authentication.  Depending on the SASL mechanism used, this
 278 may require an additional password prompt from the user (but the
 279 .RI \*(lq .netrc \*(rq
 280 file can be used to store this password).  The
 281 .B \-saslmech
 282 switch can be used to select a particular SASL mechanism.
 283 .PP
 284 If SASL authentication is successful,
 285 .B inc
 286 will attempt to negotiate a security layer for session encryption.
 287 Encrypted traffic is labelled with `(encrypted)' and `(decrypted)'
 288 when viewing the POP transaction with the
 289 .B \-snoop
 290 switch.
 291 .SH FILES
 292 .fc ^ ~
 293 .nf
 294 .ta \w'%etcdir%/ExtraBigFileName  'u
 295 ^$HOME/\&.mh\(ruprofile~^The user profile
 296 ^%etcdir%/mts.conf~^nmh mts configuration file
 297 ^%mailspool%/$USER~^Location of mail drop
 298 .fi
 299 .SH "PROFILE COMPONENTS"
 300 .fc ^ ~
 301 .nf
 302 .ta 2.4i
 303 .ta \w'ExtraBigProfileName  'u
 304 ^Path:~^To determine the user's nmh directory
 305 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 306 ^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq
 307 ^Folder\-Protect:~^To set mode when creating a new folder
 308 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
 309 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 310 .fi
 311 .SH "SEE ALSO"
 312 .IR mhmail (1),
 313 .IR scan (1),
 314 .IR mh\-mail (5),
 315 .IR post (8)
 316 .SH DEFAULTS
 317 .nf
 318 .RB ` +folder "' defaulted by \*(lqInbox\*(rq above"
 319 .RB ` \-noaudit '
 320 .RB ` \-changecur '
 321 .RB ` \-format "' defaulted as described above"
 322 .RB ` \-nosilent '
 323 .RB ` \-nosasl '
 324 .RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise"
 325 .RB ` \-width "' defaulted to the width of the terminal"
 326 .RB ` \-nopack '
 327 .fi
 328 .SH CONTEXT
 329 The folder into which messages are being incorporated will become the
 330 current folder.  The first message incorporated will become the current
 331 message, unless the
 332 .B \-nochangecur
 333 option is specified.  This leaves the context ready for a
 334 .B show
 335 of the first new message.