Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
INC(1)			    General Commands Manual			INC(1)

       inc - incorporate new mail

       inc [+folder] [-audit audit-file] [-noaudit] [-changecur	| -nochange-
	    cur] [-form	formfile] [-format string] [-file name]	[-silent |
	    -nosilent] [-truncate | -notruncate] [-width columns] [-host host-
	    name] [-port portname/number] [-user username] [-pack file]
	    [-nopack] [-proxy command] [-sasl |	-nosasl] [-saslmech mechanism]
	    [-snoop] [-version]	[-help]

       Inc incorporates	mail from the user's incoming mail drop	 into  an  nmh
       folder.	 If the	mail drop is a file, it	can be in mbox or MMDF format.
       If the mail drop	is a directory it will considered to be	a Maildir for-
       mat mail	drop.

       You  may	 specify  which	 folder	 to use	with +folder.  If no folder is
       specified, then inc will	use either the folder given by	a  (non-empty)
       "Inbox"	entry  in the user's profile, or the folder named "inbox".  If
       the specified (or default) folder  doesn't  exist,  the	user  will  be
       queried prior to	its creation.

       When  the  new  messages	are incorporated into the folder, they are as-
       signed numbers starting with the	next highest number  for  the  folder.
       As  the	messages are processed,	a scan listing of the new mail is pro-

       If the user's profile contains a	"Msg-Protect: nnn" entry, it  will  be
       used as the protection on the newly created messages, otherwise the nmh
       default of 0600 will be used (on	filesystems that support it).  For all
       subsequent  operations  on these	messages, this initially assigned pro-
       tection will be preserved.

       If the switch -audit audit-file is  specified  (usually	as  a  default
       switch  in  the profile), then inc will append a	header line and	a line
       per message to the end of the specified audit-file with the format:

	    <<inc>> date
	    <scan line for first message>
	    <scan line for second message>

       This is useful for keeping track	of volume and source of	incoming mail.
       Eventually,  repl, forw,	comp, and dist may also	produce	audits to this
       (or another) file, perhaps with "Message-Id" information	to keep	an ex-
       act correspondence history.  "Audit-file" will be in the	user's nmh di-
       rectory unless a	full path is specified.

       Inc will	incorporate even improperly formatted messages into the	user's
       nmh folder, inserting a blank line prior	to the offending component and
       printing	a comment identifying the bad message.

       In all cases, the user's	mail drop will be zeroed, unless the  -notrun-
       cate switch is given.

       If  the	profile	entry "Unseen-Sequence"	is present and non-empty, then
       inc will	add each of the	newly incorporated messages to	each  sequence
       named  by  the profile entry.  Inc will not zero	each sequence prior to
       adding messages.

       The interpretation of the -form formatfile, -format string, and	-width
       columns switches	is the same as in scan.

       By  using the -file name	switch,	one can	direct inc to incorporate mes-
       sages from a file other than the	user's maildrop.  Note that  the  name
       file will NOT be	zeroed,	unless the -truncate switch is given.

       The  -file switch does not support use of standard input.  Instead, the
       rcvstore	command	can be used to incorporate mail	from the standard  in-
       put stream.

       If  the	environment variable $MAILDROP is set, then inc	uses it	as the
       location	of the user's maildrop instead of the default (the -file  name
       switch still overrides this, however).  If this environment variable is
       not set,	then inc will consult the profile entry	 "MailDrop"  for  this
       information.   If  the  value  found is not absolute, then it is	inter-
       preted relative to the user's nmh  directory.   If  the	value  is  not
       found,  then  inc  will	look  in  the standard system location for the
       user's maildrop.

       The -silent switch directs inc to be quiet and not ask any questions at
       all.   This is useful for putting inc in	the background and going on to
       other things.

   Using POP
       inc will	normally check local mail drops	for mail,  as  covered	above.
       But if the option "pophost" is set in "mts.conf", or if the -host host-
       name switch is given, or	if the $MAILHOST environment variable is  set,
       then  inc will query this POP service host for mail to incorporate.  If
       $MAILHOST is set	and -host is specified as well,	the commandline	switch
       will override the environment variable.	The -port switch specifies the
       port name or number used	to connect to the POP server.  If  unspecified
       the default is "pop3".

       To  specify  a username for authentication with the POP server, use the
       -user username switch.  The credentials profile entry  in  the  mh-pro-
       file(5) man page	describes the ways to supply a username	and password.

       If passed the -proxy command switch, inc	will use the specified command
       to establish the	connection to the POP server. The  string  %h  in  the
       command will be substituted by the hostname to connect to.

       If  inc	uses  POP, then	the -pack file switch is considered. If	given,
       then inc	simply uses the	POP to packf the user's	maildrop from the  POP
       service	host  to  the  named  file.  This switch is provided for those
       users who prefer	to use msh to read their maildrops.

       For debugging purposes, you may give the	switch -snoop, which will  al-
       low you to watch	the POP	transaction take place between you and the POP

       If nmh has been compiled	with SASL support, the -sasl switch  will  en-
       able  the  use of SASL authentication.  Depending on the	SASL mechanism
       used, this may require an additional password prompt from the user (but
       the  netrc file can be used to store this password, as described	in the
       mh-profile(5) man page).	 The -saslmech switch can be used to select  a
       particular SASL mechanism.

       If  SASL	 authentication	is successful, inc will	attempt	to negotiate a
       security	layer for session encryption.  Encrypted traffic  is  labelled
       with  `(encrypted)'  and	`(decrypted)' when viewing the POP transaction
       with the	-snoop switch.

       $HOME/.mh_profile   The user's profile.
			   mts configuration file.
       /var/mail/$USER	   Location of the system mail drop.

       Path:		   To determine	the user's nmh directory.
			   To determine	the user's mailboxes.
       Inbox:		   To determine	the inbox.
       Folder-Protect:	   To set mode when creating a new folder.
       Msg-Protect:	   To set mode when creating a	new  message  and  au-
       Unseen-Sequence:	   To name sequences denoting unseen messages.

       mhmail(1), scan(1), mh-mail(5), mh-profile(5), post(8), rcvstore(1)

       +folder		   defaulted by	"Inbox"	above.
       -format		   As described	above.
       -truncate	   If -file name not given, -notruncate	otherwise.
       -width		   The width of	the terminal.

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

nmh-1.6				April 14, 2013				INC(1)


Want to link to this manual page? Use this URL:

home | help