1 .TH INC %manext1% 2016-11-02 "%nmhversion%"
6 inc \- incorporate new mail to an nmh folder
17 .RB [ \-changecur " | " \-nochangecur ]
24 .RB [ \-silent " | " \-nosilent ]
25 .RB [ \-truncate " | " \-notruncate ]
36 .RB [ \-sasl " | " \-nosasl ]
44 .RB [ \-certverify " | " \-nocertverify ]
49 incorporates mail from the user's incoming mail drop into an
52 If the mail drop is a file, it can be in
57 If the mail drop is a directory it is considered to be in
61 You may specify which folder to use with
63 If no folder is specified, then
65 will use either the folder given by a (non-empty)
67 entry in the user's profile, or the folder named
68 .RI \*(lq inbox \*(rq.
69 If the specified (or default) folder doesn't
70 exist, the user will be queried prior to its creation.
72 When the new messages are incorporated into the folder, they are assigned
73 numbers starting with the next highest number for the folder.
74 As the messages are processed, a
76 listing of the new mail is produced.
78 The newly created messages will have a mode of 0600, see chmod(1),
79 on filesystems that support it.
81 .RI \*(lq "Msg\-Protect: nnn" \*(rq
82 profile entry gives the mode to use, in octal.
83 For all subsequent operations on these messages, this initially assigned
84 mode will be preserved.
89 is specified (usually as a default switch in the user's profile), then
91 will append a header line and a line per message to the specified
92 audit-file with the format:
97 <scan line for first message>
98 <scan line for second message>
103 This is useful for keeping track of volume and source of incoming mail.
110 may also output audit information to this (or another) file, perhaps with
111 .RI \*(lq Message\-Id \*(rq
112 information to keep an exact correspondence history.
113 .RI \*(lq Audit-file \*(rq
114 is assumed to be in the user's nmh directory unless a full path is specified.
117 will incorporate even improperly formatted messages into the user's
118 nmh folder, inserting a blank line prior to the offending component
119 and printing a comment identifying the bad message.
121 In all cases, except the use of
124 (see below), the user's mail drop will be zeroed, unless the
129 .RI \*(lq Unseen\-Sequence \*(rq
130 is present and non-empty, then
132 will add each of the newly incorporated messages to each sequence
133 named in the profile entry.
135 will not zero each sequence prior to adding messages.
137 The interpretation of the
145 switches is the same as in
151 switch, one can direct
153 to incorporate messages from a file other than the user's mail drop.
154 Note that the named file will
156 be zeroed, unless the
162 switch does not support the use of standard input.
165 command can be used to incorporate mail from the standard input stream.
167 If the environment variable
171 uses it as the location of the user's mail drop instead of the default
175 switch still overrides this, however).
176 If this environment variable is not set, then
178 will consult the profile entry
179 .RI \*(lq MailDrop \*(rq
180 for this information. If the value found is not absolute, then it is
181 interpreted relative to the user's
183 directory. If the value is not found, then
185 will look in the standard system location for the user's mail drop.
191 to be quiet and not ask any questions at all. This is useful for putting
193 in the background and going on to other things.
196 will normally check local mail drops for mail, as covered above.
198 .RI \*(lq pophost \*(rq
200 .RI \*(lq mts.conf \*(rq,
204 switch is given, or if the
206 environment variable is set, then
208 will query this POP service host for mail to incorporate. If
212 is specified as well, the command-line switch will override
213 the environment variable. The
215 switch specifies the port name or number used to connect to the POP
216 server. If unspecified, the default is \*(lqpop3\*(rq.
218 To specify a username for authentication with the POP server, use the
221 switch. The credentials profile entry in
223 describes the ways to supply a username and password.
230 will use the specified command to establish the connection to the POP
233 in the command will be substituted by the hostname to connect to.
235 For debugging purposes, you may give the switch
237 which will allow you to monitor the POP transaction. If
238 .B \-sasl \-saslmech xoauth2
239 is used, the HTTP transaction is also shown.
243 has been compiled with SASL support, the
245 switch will enable the use of SASL authentication.
246 Depending on the SASL mechanism used, this may require an
247 additional password prompt from the user (but the
249 file can be used to store this password, as described in
250 .IR mh\-profile (5)).
253 switch can be used to select a particular SASL mechanism.
255 If SASL authentication is successful,
257 will attempt to negotiate a security layer for session encryption.
258 Encrypted traffic is labelled with `(encrypted)' and `(decrypted)'
259 when viewing the POP transaction with the
265 for its other features.
269 has been compiled with OAuth support, the
272 .B \-saslmech xoauth2
273 switches will enable OAuth authentication. The
275 switch must be used, and the
277 must be an email address the user has for the service, which must
278 be specified with the
281 switch. Before using this, the user must authorize nmh by running
283 and granting authorization to that account. See
289 has been compiled with TLS support, the
293 switches will require the negotiation of TLS when connecting
294 to the remote POP server. The
298 to negotiate TLS as part of the normal POP protocol using
299 the STLS command. The
303 to negotiate TLS immediately after the connection has taken place,
304 before any POP commands are sent or received. Data encrypted by TLS is
305 labeled `(tls-encrypted)' and `(tls-decrypted)' when viewing the POP
310 switch will disable all attempts to negotiate TLS.
312 When using TLS the default is to verify the remote certificate and SubjectName
313 against the local trusted certificate store. This can be controlled by
318 switches. See your OpenSSL documentation for more information on certificate
327 mts configuration file.
330 Location of the system mail drop.
332 .SH "PROFILE COMPONENTS"
336 To determine the user's nmh directory.
338 Alternate\-Mailboxes:
339 To determine the user's mailboxes.
342 To determine the inbox.
345 To set mode when creating a new folder.
348 To set mode when creating a new message and audit-file.
351 To name sequences denoting unseen messages.
365 defaulted by \*(lqInbox\*(rq above.
385 The width of the terminal.
388 The folder into which messages are being incorporated will become the
389 current folder. The first message incorporated will become the current
392 option is specified. This leaves the context ready for a
394 of the first new message.