5 .\" include the -mh macro file
8 .TH INC %manext1% MH.6.8 [%nmhversion%]
10 inc \- incorporate new mail
16 \%[\-audit\ audit\-file] \%[\-noaudit]
20 \%[\-form\ formatfile]
24 \%[\-silent] \%[\-nosilent]
41 \fIInc\fR incorporates mail from the user's incoming mail drop into
44 You may specify which folder to use with `+folder'. If no folder
45 is specified, then \fIinc\fR will use either the folder given by a
46 (non\-empty) \*(lqInbox:\*(rq entry in the user's profile, or the folder
47 named \*(lqinbox\*(rq. If the specified (or default) folder doesn't
48 exist, the user will be queried prior to its creation.
50 When the new messages are incorporated into the folder, they are assigned
51 numbers starting with the next highest number for the folder. As the
52 messages are processed, a \fIscan\fR listing of the new mail is produced.
54 If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
55 will be used as the protection on the newly created messages, otherwise
56 the \fInmh\fR default of 0644 will be used. For all subsequent operations
57 on these messages, this initially assigned protection will be preserved.
59 If the switch `\-audit\ audit\-file' is specified (usually as a default
60 switch in the profile), then \fIinc\fR will append a header line and a
61 line per message to the end of the specified audit\-file with the format:
67 <scan line for first message>
69 <scan line for second message>
74 This is useful for keeping track of volume and source of incoming mail.
75 Eventually, \fIrepl\fR, \fIforw\fR, \fIcomp\fR, and \fIdist\fR
76 may also produce audits to this (or another) file, perhaps with
77 \*(lqMessage\-Id:\*(rq information to keep an exact correspondence
78 history. \*(lqAudit\-file\*(rq will be in the user's nmh directory unless
79 a full path is specified.
81 \fIInc\fR will incorporate even improperly formatted messages into the
82 user's nmh folder, inserting a blank line prior to the offending component
83 and printing a comment identifying the bad message.
85 In all cases, the user's mail drop will be zeroed, unless the
86 `\-notruncate' switch is given.
88 If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
89 then \fIinc\fR will add each of the newly incorporated messages to
90 each sequence named by the profile entry. \fIInc\fR will not zero each
91 sequence prior to adding messages.
93 The interpretation of the `\-form\ formatfile', `\-format\ string', and
94 `\-width\ columns' switches is the same as in \fIscan\fR\0(1).
96 By using the `\-file\ name' switch, one can direct \fIinc\fR to
97 incorporate messages from a file other than the user's maildrop.
98 Note that the name file will NOT be zeroed, unless the `\-truncate'
101 If the environment variable \fB$MAILDROP\fR is set, then \fIinc\fR
102 uses it as the location of the user's maildrop instead of the default
103 (the `-file\ name' switch still overrides this, however). If this
104 environment variable is not set, then \fIinc\fR will consult the profile
105 entry \*(lqMailDrop\*(rq for this information. If the value found is
106 not absolute, then it is interpreted relative to the user's \fInmh\fR
107 directory. If the value is not found, then \fIinc\fR will look in the
108 standard system location for the user's maildrop.
110 The `\-silent' switch directs \fIinc\fR to be quiet and not ask any
111 questions at all. This is useful for putting \fIinc\fR in the background
112 and going on to other things.
116 \fIinc\fR will normally check local mail drops for mail, as given
117 above. But if the option \*(lqpophost:\*(rq is set in the mts
118 configuration file \*(lqmts.conf\*(rq, or if the `\-host\ hostname'
119 switch is given, then \fIinc\fR will query this POP service host
120 for mail to incorporate.
122 The default is for \fIinc\fR to assume that your account name on
123 the POP server is the same as your current username. To specify
124 a different username, use the `\-user\ username' switch.
126 When using POP, you will normally need to type the password for
127 your account on the POP server, in order to retrieve your messages.
128 It is possible to automate this process by creating a \*(lq.netrc\*(rq
129 file containing your login account information for this POP server.
130 For each POP server, this file should have a line of the following
131 form. Replace the words mypopserver, mylogin, and mypassword with
132 your own account information.
134 machine mypopserver login mylogin password mypassword
136 This \*(lq.netrc\*(rq file should be owned and readable only by
139 If \fIinc\fR uses POP, then the `\-pack\ file' switch is considered.
140 If given, then \fIinc\fR simply uses the POP to \fIpackf\fR\0(1) the
141 user's maildrop from the POP service host to the named file. This switch
142 is provided for those users who prefer to use \fImsh\fR to read their
145 For debugging purposes, you may give the switch `\-snoop', which will
146 allow you to watch the POP transaction take place between you and the
150 ^$HOME/\&.mh\(ruprofile~^The user profile
151 ^%etcdir%/mts.conf~^nmh mts configuration file
152 ^%mailspool%/$USER~^Location of mail drop
154 ^Path:~^To determine the user's nmh directory
156 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
158 ^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq
160 ^Folder\-Protect:~^To set mode when creating a new folder
162 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
164 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
166 mhmail(1), scan(1), mh\-mail(5), post(8)
168 `+folder' defaulted by \*(lqInbox\*(rq above
174 `\-format' defaulted as described above
178 `\-truncate' if `\-file\ name' not given, `\-notruncate' otherwise
180 `\-width' defaulted to the width of the terminal
186 The folder into which messages are being incorporated will become the
187 current folder. The first message incorporated will become the current
188 message, unless the `\-nochangecur' option is specified. This leaves
189 the context ready for a \fIshow\fR of the first new message.
191 The argument to the `\-format' switch must be interpreted as a single
192 token by the shell that invokes \fIinc\fR. Therefore, one must usually
193 place the argument to this switch inside double\-quotes.