.\"
.\" THIS FILE HAS BEEN AUTOMATICALLY GENERATED.  DO NOT EDIT.
.\"
.TH INC 1mh "2019-01-06" MH.6.8 [mmh-0.4]
.SH NAME
inc \- incorporate new mail
.SH SYNOPSIS
.HP 5
.na
.B inc
.RI [ +folder ]
.RB [ \-audit
.IR audit\-file ]
.RB [ \-noaudit ]
.RB [ \-changecur " | " \-nochangecur ]
.RB [ \-form
.IR formfile ]
.RB [ \-file
.IR name ]
.RB [ \-silent " | " \-nosilent ]
.RB [ \-truncate " | " \-notruncate ]
.RB [ \-width
.IR columns ]
.RB [ \-Version ]
.RB [ \-help ]
.ad
.SH DESCRIPTION
.B Inc
incorporates mail from the user's incoming mail drop into
an
.B mh
folder.
.PP
You may specify which folder to use with
.IR +folder .
If no folder is specified, then
.B inc
will use either the folder given by a (non\-empty)
.RI ` Inbox '
entry in the user's profile, or the folder named
.RI ` inbox '.
If the specified (or default) folder doesn't
exist, the user will (in
.B \-nosilent
mode) be queried prior to its creation.
.PP
When the new messages are incorporated into the folder, they are assigned
numbers starting with the next highest number for the folder.  As the
messages are processed, a
.B scan
listing of the new mail is produced.
.PP
If the user's profile contains a
.RI ` "Msg\-Protect: nnn" '
entry, it
will be used as the protection on the newly created messages, otherwise
the
.B mmh
default of 0644 will be used.  For all subsequent operations
on these messages, this initially assigned protection will be preserved.
.PP
If the switch
.B \-audit
.I audit\-file
is specified (usually as a default
switch in the profile), then
.B inc
will append a header line and a
line per message to the end of the specified audit\-file with the format:
.PP
.RS 5
.nf
<<inc>> date
<scan line for first message>
<scan line for second message>
<etc.>
.fi
.RE
.PP
This is useful for keeping track of volume and source of incoming mail.
Eventually,
.BR repl ,
.BR forw ,
.BR comp ,
and
.B dist
may also produce audits to this (or another) file, perhaps with
.RI ` Message\-Id '
information to keep an exact correspondence
history.
.RI ` Audit\-file '
will be in the current directory unless a full path is specified.
.PP
.B Inc
will incorporate even improperly formatted messages into the
user's mh folder, inserting a blank line prior to the offending component
and printing a comment identifying the bad message.
.PP
In all cases, the user's mail drop will be zeroed, unless the
.B \-notruncate
switch is given.
.PP
If the profile entry
.RI ` Unseen\-Sequence '
is present and non\-empty, then
.B inc
will add each of the newly incorporated messages to
each sequence named by the profile entry.
.B Inc
will not zero each sequence prior to adding messages.
.PP
The interpretation of the
.B \-form
.IR formatfile ,
and
.B \-width
.I columns
switches is the same as in
.BR scan .
.PP
By using the
.B \-file
.I name
switch, one can direct
.B inc
to incorporate messages from a file other than the user's maildrop.
In particular, if
.I name
is
.RI ` - '
then
.B inc
will read messages from standard input.
Note that the named file will NOT be zeroed, unless the
.B \-truncate
switch is given.
.PP
If the environment variable
.B $MAILDROP
is set, then
.B inc
uses it as the location of the user's maildrop instead of the default
(the
.B -file
.I name
switch still overrides this, however).  If this
environment variable is not set, then
.B inc
will consult the profile entry
.RI ` MailDrop '
for this information.  If the value found is
not absolute, then it is interpreted relative to the user's
.B mh
directory.  If the value is not found, then
.B inc
will look in the standard system location for the user's maildrop.
.PP
The
.B \-silent
switch directs
.B inc
to be quiet and not ask any questions at all.  This is useful for putting
.B inc
in the background and going on to other things.

.SH FILES
.fc ^ ~
.nf
.ta \w'/etc/mmh/ExtraBigFileName  'u
^$HOME/.mmh/profile~^The user profile
^/var/mail/$USER~^Location of mail drop
.fi

.SH "PROFILE COMPONENTS"
.fc ^ ~
.nf
.ta 2.4i
.ta \w'ExtraBigProfileName  'u
^Path:~^To determine the user's mail storage
^Alternate\-Mailboxes:~^To determine the user's mailboxes
^Inbox:~^To determine the inbox, default `inbox'
^Folder\-Protect:~^To set mode when creating a new folder
^Msg\-Protect:~^To set mode when creating a new message and audit\-file
^Unseen\-Sequence:~^To name sequences denoting unseen messages
.fi

.SH "SEE ALSO"
scan(1), mh\-mail(5)

.SH DEFAULTS
.nf
.RB ` +folder "' defaulted by `Inbox' above"
.RB ` \-noaudit '
.RB ` \-changecur '
.RB ` \-form "' defaulted as described above"
.RB ` \-nosilent '
.RB ` \-truncate "' if `" \-file " name' not given, `" \-notruncate "' otherwise"
.RB ` \-width "' defaulted to the width of the terminal"
.fi

.SH CONTEXT
The folder into which messages are being incorporated will become the
current folder.  The first message incorporated will become the current
message, unless the
.B \-nochangecur
option is specified.  This leaves the context ready for a
.B show
of the first new message.