1INC(1) [nmh-1.2-20070115cvs] INC(1)
2
6 inc - incorporate new mail
7
9 inc [+folder] [-audit audit-file] [-noaudit] [-changecur | -nochange‐
10 cur] [-form formfile] [-format string] [-file name] [-silent |
11 -nosilent] [-truncate | -notruncate] [-width columns] [-host host‐
12 name] [-user username] [-pack file] [-nopack] [-proxy command]
13 [-apop | -noapop] [-kpop] [-sasl] [-saslmech mechanism] [-snoop]
14 [-version] [-help]
15
17 Inc incorporates mail from the user's incoming mail drop into an nmh
18 folder.
19 You may specify which folder to use with +folder. If no folder is
21 specified, then inc will use either the folder given by a (non-empty)
22 “Inbox” entry in the user's profile, or the folder named “inbox”. If
23 the specified (or default) folder doesn't exist, the user will be
24 queried prior to its creation.
25 When the new messages are incorporated into the folder, they are
27 assigned numbers starting with the next highest number for the folder.
28 As the messages are processed, a scan listing of the new mail is pro‐
29 duced.
30 If the user's profile contains a “Msg-Protect: nnn” entry, it will be
32 used as the protection on the newly created messages, otherwise the nmh
33 default of 0644 will be used. For all subsequent operations on these
34 messages, this initially assigned protection will be preserved.
35 If the switch -audit audit-file is specified (usually as a default
37 switch in the profile), then inc will append a header line and a line
38 per message to the end of the specified audit-file with the format:
39 inc date
41 <scan line for first message>
42 <scan line for second message>
43 <etc.>
44 This is useful for keeping track of volume and source of incoming mail.
46 Eventually, repl, forw, comp, and dist may also produce audits to this
47 (or another) file, perhaps with “Message-Id” information to keep an
48 exact correspondence history. “Audit-file” will be in the user's nmh
49 directory unless a full path is specified.
50 Inc will incorporate even improperly formatted messages into the user's
52 nmh folder, inserting a blank line prior to the offending component and
53 printing a comment identifying the bad message.
54 In all cases, the user's mail drop will be zeroed, unless the -notrun‐
56 cate switch is given.
57 If the profile entry “Unseen-Sequence” is present and non-empty, then
59 inc will add each of the newly incorporated messages to each sequence
60 named by the profile entry. Inc will not zero each sequence prior to
61 adding messages.
62 The interpretation of the -form formatfile, -format string, and -width
64 columns switches is the same as in scan.
65 By using the -file name switch, one can direct inc to incorporate mes‐
67 sages from a file other than the user's maildrop. Note that the name
68 file will NOT be zeroed, unless the -truncate switch is given.
69 If the environment variable $MAILDROP is set, then inc uses it as the
71 location of the user's maildrop instead of the default (the -file name
72 switch still overrides this, however). If this environment variable is
73 not set, then inc will consult the profile entry “MailDrop” for this
74 information. If the value found is not absolute, then it is inter‐
75 preted relative to the user's nmh directory. If the value is not
76 found, then inc will look in the standard system location for the
77 user's maildrop.
78 The -silent switch directs inc to be quiet and not ask any questions at
80 all. This is useful for putting inc in the background and going on to
81 other things.
82 Using POP
84 inc will normally check local mail drops for mail, as covered above.
85 But if the option “pophost” is set in “mts.conf”, or if the -host host‐
86 name switch is given, or if the $MAILHOST environment variable is set,
87 then inc will query this POP service host for mail to incorporate. If
88 $MAILHOST is set and -host is specified as well, the commandline switch
89 will override the environment variable.
90 The default is for inc to assume that your account name on the POP
92 server is the same as your current username. To specify a different
93 username, use the -user username switch.
94 When using POP, you will normally need to type the password for your
96 account on the POP server, in order to retrieve your messages. It is
97 possible to automate this process by creating a “.netrc” file contain‐
98 ing your login account information for this POP server. For each POP
99 server, this file should have a line of the following form. Replace
100 the words mypopserver, mylogin, and mypassword with your own account
101 information.
102 machine mypopserver login mylogin password mypassword
104 This “.netrc” file should be owned and readable only by you.
106 If passed the -proxy command switch, inc will use the specified command
108 to establish the connection to the POP server. The string %h in the
109 command will be substituted by the hostname to connect to.
110 If inc uses POP, then the -pack file switch is considered. If given,
112 then inc simply uses the POP to packf the user's maildrop from the POP
113 service host to the named file. This switch is provided for those
114 users who prefer to use msh to read their maildrops.
115 For debugging purposes, you may give the switch -snoop, which will
117 allow you to watch the POP transaction take place between you and the
118 POP server.
119 If nmh has been compiled with APOP support, the -apop switch will cause
121 inc to use APOP rather than standard POP3 authentication. Under APOP,
122 a unique string (generally of the format <pid.timestamp@hostname> ) is
123 announced by the POP server. Rather than `USER user', `PASS password',
124 inc sends `APOP user digest', where digest is the MD5 hash of the
125 unique string followed by a `secret' shared by client and server,
126 essentially equivalent to the user's password (though an APOP-enabled
127 POP3 server could have separate APOP and plain POP3 passwords for a
128 single user). -noapop disables APOP in cases where it'd otherwise be
129 used.
130 If nmh has been compiled with KPOP support, the -kpop switch will allow
132 inc to use Kerberized POP rather than standard POP3 on a given invoca‐
133 tion. If POPSERVICE was also #defined to "kpop", inc will be hardwired
134 to always use KPOP.
135 If nmh has been compiled with SASL support, the -sasl switch will
137 enable the use of SASL authentication. Depending on the SASL mechanism
138 used, this may require an additional password prompt from the user (but
139 the “.netrc” file can be used to store this password). The -saslmech
140 switch can be used to select a particular SASL mechanism.
141 If SASL authentication is successful, inc will attempt to negotiate a
143 security layer for session encryption. Encrypted traffic is labelled
144 with `(encrypted)' and `(decrypted)' when viewing the POP transaction
145 with the -snoop switch.
146
149 $HOME/.mh_profile The user profile
150 /etc/nmh/mts.conf nmh mts configuration file
151 /var/mail/$USER Location of mail drop
152
155 Path: To determine the user's nmh directory
156 Alternate-Mailboxes: To determine the user's mailboxes
157 Inbox: To determine the inbox, default “inbox”
158 Folder-Protect: To set mode when creating a new folder
159 Msg-Protect: To set mode when creating a new message and audit-file
160 Unseen-Sequence: To name sequences denoting unseen messages
161
164 mhmail(1), scan(1), mh-mail(5), post(8)
165
168 `+folder' defaulted by “Inbox” above
169 `-noaudit'
170 `-changecur'
171 `-format' defaulted as described above
172 `-nosilent'
173 `-truncate' if `-file name' not given, `-notruncate' otherwise
174 `-width' defaulted to the width of the terminal
175 `-nopack'
176
179 The folder into which messages are being incorporated will become the
180 current folder. The first message incorporated will become the current
181 message, unless the -nochangecur option is specified. This leaves the
182 context ready for a show of the first new message.
183
186 The argument to the -format switch must be interpreted as a single
187 token by the shell that invokes inc. Therefore, one must usually place
188 the argument to this switch inside double-quotes.
189MH.6.8 1 Jul 2003 INC(1)