]> git.lizzy.rs Git - plan9front.git/blob - sys/man/1/mail
cfe04296968dd0b8b77a09397428a2d4ac18909c
[plan9front.git] / sys / man / 1 / mail
1 .TH MAIL 1
2 .SH NAME
3 mail, go.fishing \- mail and mailboxes
4 .SH SYNOPSIS
5 .B mail
6 [
7 .I arg ...
8 ]
9 .PP
10 .B go.fishing
11 .SH DESCRIPTION
12 .PP
13 Mail is a shell script that invokes
14 .IR nedmail (1),
15 the mail reader,
16 when no recipients appear on the command line and
17 .IR marshal (1),
18 the mail preparer,
19 otherwise.
20 All command line options are passed through.
21 See the man pages for those two commands for
22 more details.
23 .PP
24 Incoming mail for a user
25 .I username
26 is put in the file
27 .BI /mail/box/ username /mbox
28 unless either the file
29 .BI /mail/box/ username /forward
30 or
31 .BI /mail/box/ username /pipeto
32 exists.
33 The mailbox must have append-only and exclusive-access mode
34 (see
35 .IR chmod (1)).
36 A user must create his or her own mailbox using the
37 .B -c
38 option of
39 .IR nedmail (1).
40 Mailboxes are created writable (append-only) but not readable by others.
41 .PP
42 If the file
43 .BI /mail/box/ username /forward
44 exists and is readable by everyone, incoming mail
45 will be forwarded to the addresses contained in the first line of the file.
46 The file may contain multiple addresses.
47 Forwarding loops are caught and resolved by local delivery.
48 .PP
49 If the file
50 .BI /mail/box/ username /pipeto
51 exists and is readable and executable by everyone,
52 it will be run for each incoming message for the user.
53 The message will be piped to it rather
54 than appended to his/her mail box.
55 The file is run as user
56 .BR none .
57 Its two arguments are the 
58 with arguments of the destination address
59 (e.g.,
60 .BR local!gremlin )
61 and the user's mail box path
62 (e.g.,
63 .BR /mail/box/gremlin/mbox )
64 .SS Auto-answer
65 .PP
66 To use 
67 .I mail
68 as an answering machine while you are away,
69 run
70 .IR go.fishing ,
71 which will create
72 .B /mail/box/$user/gone.fishing
73 as a flag for
74 .B pipeto
75 processing,
76 and truncate
77 .BR /mail/box/$user/gone.addrs .
78 Any existing
79 .B pipeto
80 file that uses
81 .B /mail/lib/pipeto.lib
82 will invoke the
83 .I gone.fishing
84 machinery when it calls
85 .B spool
86 or
87 .BR spool-tagged-spam .
88 .PP
89 If
90 .B /mail/box/$user/gone.msg
91 exists, it
92 will be sent (just once) to everyone who
93 sends you mail that lists your address in a
94 .L To
95 or
96 .L Cc
97 header;
98 if not,
99 .B /mail/lib/gone.msg
100 will be sent.
101 Upon your return, remove
102 .B /mail/box/$user/gone.fishing
103 to stop automatic responses.
104 .SH FILES
105 .TF /mail/box/$user/gone.fishing
106 .TP
107 .B /sys/log/mail
108 mail log file
109 .TP
110 .B /mail/box/*
111 mail directories
112 .TP
113 .B /mail/box/*/mbox
114 mailbox files
115 .TP
116 .B /mail/box/*/forward
117 forwarding address(es)
118 .TP
119 .B /mail/box/*/pipeto
120 mail filter
121 .TP
122 .B /mail/box/*/L.reading
123 mutual exclusion lock for multiple mbox readers
124 .TP
125 .B /mail/box/*/L.mbox
126 mutual exclusion lock for altering mbox
127 .TP
128 .B /lib/face/48x48x?
129 directories of icons for
130 .I seemail
131 .TP
132 .B /mail/lib/pipeto.lib
133 helper functions for pipeto files
134 .TP
135 .B /mail/lib/gone.msg
136 default vacation message
137 .TP
138 .B /mail/lib/gone.fishing
139 auto-responder as
140 .I pipeto
141 script
142 .TP
143 .B /mail/box/$user/gone.fishing
144 flag to active gone processing
145 .TP
146 .B /mail/box/$user/gone.addrs
147 list of senders answered by
148 .I gone.fishing
149 .SH SOURCE
150 .B /rc/bin/mail
151 .br
152 .B /rc/bin/go.fishing
153 .SH "SEE ALSO"
154 .IR aliasmail (8),
155 .IR faces (1),
156 .IR filter (1),
157 .IR marshal (1),
158 .IR mlmgr (1),
159 .IR nedmail (1),
160 .IR qer (8),
161 .IR rewrite (6),
162 .IR send (8),
163 .IR smtp (8),
164 .IR upasfs (4)