1RCVSTORE(1) General Commands Manual RCVSTORE(1)
2
3
4
6 rcvstore - asynchronously incorporate mail into an nmh folder
7
9 /usr/libexec/nmh/rcvstore [-help] [-version] [+folder] [-create |
10 -nocreate] [-unseen | -nounseen] [-zero | -nozero] [-sequence name
11 ...] [-public | -nopublic]
12
14 rcvstore incorporates a message from the standard input into an nmh
15 folder. This command is typically used in conjunction with mail fil‐
16 tering programs such as slocal and procmail, to filter your mail into
17 different folders.
18
19 You may specify which folder to use with +folder. If no folder is
20 specified, rcvstore will use the folder given by a non-empty “Inbox:”
21 entry in the user's profile, else it will use the folder named “inbox”.
22
23 If the switch -create is given (it is the default) and if the specified
24 (or default) folder does not exist, then it will be created. You may
25 disable this with the -nocreate option. In this case rcvstore will
26 exit if the specified folder does not exist.
27
28 When the new message is incorporated into the folder, it is assigned
29 the next highest number for that folder.
30
31 rcvstore will incorporate anything except zero length messages into the
32 user's nmh folder. It will not change the message in any way.
33
34 If the user's profile contains a “Msg-Protect: nnn” entry, it will be
35 used as the mode to use, in octal, on the newly created message, other‐
36 wise the nmh default mode of 0600, see chmod(1), will be used (on
37 filesystems that support it). For all subsequent operations on this
38 message, this initially assigned mode will be preserved.
39
40 If the switch -unseen is given (it is on by default), and if the pro‐
41 file entry “Unseen-Sequence” is present and non-empty, then rcvstore
42 will add the newly incorporated message to each sequence named by this
43 profile entry. You may use the switch -nounseen to disable this.
44 These sequences will not be zeroed by rcvstore prior to adding the new
45 message.
46
47 Furthermore, the incoming messages may be added to additional sequences
48 as they arrive by the use of the -sequence switch. As with the com‐
49 mands pick and mark, you may also use the switches -zero and -nozero to
50 specify whether to zero old sequences or not. Similarly, use of the
51 -public and -nopublic switches may be used to force these sequences to
52 be public or private sequences.
53
54 Locking and sequences
55 If you use the “Unseen-Sequence” profile entry, or if you use the -se‐
56 quence argument, rcvstore might try to update its sequence state while
57 another nmh process is also trying to do so. This can cause one of
58 those updates to be lost. To avoid this (just between asynchronous in‐
59 vocations of rcvstore), always use it with an external locking mecha‐
60 nism. A procmailrc(5) local lockfile would work, or if not using proc‐
61 mail, then consider using dotlockfile(1) or flock(1).
62
64 $HOME/.mh_profile The user profile
65
67 Path: To determine the user's nmh directory
68 Folder-Protect: To set mode when creating a new folder
69 Inbox: To find the default inbox
70 Msg-Protect: To set mode when creating a new message
71 Unseen-Sequence: To name sequences denoting unseen messages
72
74 mh-sequence(5), procmailex(5), procmailrc(5), rcvdist(1), rcvpack(1),
75 rcvtty(1)
76
78 `+folder' defaults to “Inbox” profile entry
79 `-create'
80 `-unseen'
81 `-nozero'
82
84 No context changes will be attempted, with the exception of sequence
85 manipulation.
86
87
88
89nmh-1.8 2013-02-19 RCVSTORE(1)