4 .TH INC %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
6 inc \- incorporate new mail
15 .RB [ \-changecur " | " \-nochangecur ]
22 .RB [ \-silent " | " \-nosilent ]
23 .RB [ \-truncate " | " \-notruncate ]
36 .RB [ \-apop " | " \-noapop ]
48 incorporates mail from the user's incoming mail drop into
53 You may specify which folder to use with
55 If no folder is specified, then
57 will use either the folder given by a (non\-empty)
59 entry in the user's profile, or the folder named
60 .RI \*(lq inbox \*(rq.
61 If the specified (or default) folder doesn't
62 exist, the user will be queried prior to its creation.
64 When the new messages are incorporated into the folder, they are assigned
65 numbers starting with the next highest number for the folder. As the
66 messages are processed, a
68 listing of the new mail is produced.
70 If the user's profile contains a
71 .RI \*(lq "Msg\-Protect: nnn" \*(rq
73 will be used as the protection on the newly created messages, otherwise
76 default of 0644 will be used. For all subsequent operations
77 on these messages, this initially assigned protection will be preserved.
82 is specified (usually as a default
83 switch in the profile), then
85 will append a header line and a
86 line per message to the end of the specified audit\-file with the format:
91 <scan line for first message>
92 <scan line for second message>
97 This is useful for keeping track of volume and source of incoming mail.
104 may also produce audits to this (or another) file, perhaps with
105 .RI \*(lq Message\-Id \*(rq
106 information to keep an exact correspondence
108 .RI \*(lq Audit\-file \*(rq
109 will be in the user's nmh directory unless a full path is specified.
112 will incorporate even improperly formatted messages into the
113 user's nmh folder, inserting a blank line prior to the offending component
114 and printing a comment identifying the bad message.
116 In all cases, the user's mail drop will be zeroed, unless the
121 .RI \*(lq Unseen\-Sequence \*(rq
122 is present and non\-empty, then
124 will add each of the newly incorporated messages to
125 each sequence named by the profile entry.
127 will not zero each sequence prior to adding messages.
129 The interpretation of the
137 switches is the same as in
143 switch, one can direct
145 to incorporate messages from a file other than the user's maildrop.
146 Note that the name file will NOT be zeroed, unless the
150 If the environment variable
154 uses it as the location of the user's maildrop instead of the default
158 switch still overrides this, however). If this
159 environment variable is not set, then
161 will consult the profile entry
162 .RI \*(lq MailDrop \*(rq
163 for this information. If the value found is
164 not absolute, then it is interpreted relative to the user's
166 directory. If the value is not found, then
168 will look in the standard system location for the user's maildrop.
174 to be quiet and not ask any questions at all. This is useful for putting
176 in the background and going on to other things.
181 will normally check local mail drops for mail, as covered above. But
183 .RI \*(lq pophost \*(rq
185 .RI \*(lq mts.conf \*(rq,
189 switch is given, or if the
191 environment variable is set, then
193 will query this POP service host for mail to incorporate. If
197 is specified as well, the commandline switch will override
198 the environment variable.
202 to assume that your account name on
203 the POP server is the same as your current username. To specify
204 a different username, use the
209 When using POP, you will normally need to type the password for
210 your account on the POP server, in order to retrieve your messages.
211 It is possible to automate this process by creating a
212 .RI \*(lq .netrc \*(rq
213 file containing your login account information for this POP server.
214 For each POP server, this file should have a line of the following
215 form. Replace the words
220 with your own account information.
232 .RI \*(lq .netrc \*(rq
233 file should be owned and readable only by you.
240 will use the specified command to establish the connection to the POP
243 in the command will be substituted by the hostname to connect to.
250 switch is considered. If given, then
252 simply uses the POP to
254 the user's maildrop from the POP service host to the named file. This switch
255 is provided for those users who prefer to use
257 to read their maildrops.
259 For debugging purposes, you may give the switch
261 which will allow you to watch the POP transaction take place
262 between you and the POP server.
266 has been compiled with APOP support, the
270 to use APOP rather than standard POP3 authentication. Under APOP, a
271 unique string (generally of the format
272 .RI < pid . timestamp @ hostname >
273 ) is announced by the POP server.
282 where digest is the MD5 hash of the unique string followed by a
283 `secret' shared by client and server, essentially equivalent to the user's
284 password (though an APOP-enabled POP3 server could have separate APOP and plain
285 POP3 passwords for a single user).
287 disables APOP in cases where it'd otherwise be used.
291 has been compiled with KPOP support, the
295 to use Kerberized POP rather than standard POP3 on a given invocation.
296 If POPSERVICE was also #defined to "kpop",
298 will be hardwired to always use KPOP.
302 has been compiled with SASL support, the
305 the use of SASL authentication. Depending on the SASL mechanism used, this
306 may require an additional password prompt from the user (but the
307 .RI \*(lq .netrc \*(rq
308 file can be used to store this password). The
310 switch can be used to select a particular SASL mechanism.
312 If SASL authentication is successful,
314 will attempt to negotiate a security layer for session encryption.
315 Encrypted traffic is labelled with `(encrypted)' and `(decrypted)'
316 when viewing the POP transaction with the
324 .ta \w'%etcdir%/ExtraBigFileName 'u
325 ^$HOME/\&.mh\(ruprofile~^The user profile
326 ^%etcdir%/mts.conf~^nmh mts configuration file
327 ^%mailspool%/$USER~^Location of mail drop
330 .SH "PROFILE COMPONENTS"
334 .ta \w'ExtraBigProfileName 'u
335 ^Path:~^To determine the user's nmh directory
336 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
337 ^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq
338 ^Folder\-Protect:~^To set mode when creating a new folder
339 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
340 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
344 mhmail(1), scan(1), mh\-mail(5), post(8)
348 .RB ` +folder "' defaulted by \*(lqInbox\*(rq above"
351 .RB ` \-format "' defaulted as described above"
353 .RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise"
354 .RB ` \-width "' defaulted to the width of the terminal"
361 The folder into which messages are being incorporated will become the
362 current folder. The first message incorporated will become the current
365 option is specified. This leaves the context ready for a
367 of the first new message.
372 switch must be interpreted as a single
373 token by the shell that invokes
375 Therefore, one must usually place the argument to this switch inside