]> git.lizzy.rs Git - plan9front.git/blob - sys/man/8/pop3
games/galaxy: simplify zoom loop
[plan9front.git] / sys / man / 8 / pop3
1 .TH POP3 8
2 .SH NAME
3 pop3, imap4d \- Internet mail servers
4 .SH SYNOPSIS
5 .PP
6 .B upas/pop3
7 [
8 .B -d
9 .I debugfile
10 ][
11 .B -a
12 .I mailbox
13 ][
14 .B -r
15 .I peeraddr
16 ][
17 .B -t
18 .I tlscertfile
19 ][
20 .B -p
21 ]
22 .PP
23 .B ip/imap4d
24 .RB [ -acpv ]
25 .RB [ -d
26 .IR smtpdomain ]
27 .RB [ -s
28 .IR servername ]
29 .SH DESCRIPTION
30 These programs support remote access to mail across the Internet.
31 All expect the network connection to be standard input, output, and error.
32 They are normally started from scripts in
33 .B /rc/bin/service
34 (see
35 .IR listen (8)).
36 .PP
37 .I Pop3
38 provides access to a user's mailboxes via the POP3 protocol.
39 The options are:
40 .TP 4
41 .B -d
42 create
43 .I debugfile
44 and write debugging output to it
45 .TP
46 .B -a
47 causes pop3 to assume that it already authenticated
48 and to read
49 .I mailbox
50 immediately
51 .TP
52 .B -r
53 causes
54 .I pop3
55 to create the file
56 .B /mail/ratify/trusted/\fIpeeraddr\fP#32
57 to allow subsequent SMTP sessions from that
58 address.  See
59 .IR ratfs (4)
60 for details.
61 .TP
62 .B -t
63 get the local TLS certificate from the file
64 .IR tlscertfile .
65 .TP
66 .B -p
67 allow passwords in the clear for authenticating the connection
68 .PP
69 .I Imap4d
70 provides access to a user's mailboxes via the IMAP4rev1 protocol.
71 Only files rooted in
72 .BI /mail/box/ username /
73 are accessible.
74 The list of subscribed mailboxes is contained in
75 .BI /mail/box/ username /imap.subscribed ,
76 and initially contains only
77 .BR INBOX ,
78 IMAP's name for the user's mailbox.
79 A shadow file,
80 .IB mailbox .imp ,
81 is created for each mailbox examined.
82 .PP
83 .IR Imap4d 's
84 options are:
85 .TP 4
86 .B a
87 Assume the user is already authenticated.
88 By default, the user must authenticate using
89 CRAM-MD5 or
90 .IR securenet (8)
91 challenge/response authentication.
92 .TP
93 .B c
94 Allow plan 9 challenge response authentication.
95 .TP
96 .B p
97 Allow login authentication.  This option
98 should only be enabled for servers using
99 an encrypted connection, such as SSL,
100 and when enabled, all non-encrypted connections should be disallowed.
101 .I Imap4d
102 does not enforce this policy.
103 .TP
104 .B v
105 Turn on verbose output to the debug file.
106 .TP
107 .B s
108 The server's name.
109 If none is provided,
110 .B cs
111 (see
112 .IR ndb (8))
113 is queried or
114 .B /env/sysname
115 is used.
116 .TP
117 .B d
118 The local mail domain.
119 Defaults to the server
120 .B /env/site
121 in the mail server's domain.
122 .PP
123 For both
124 .I imap4d
125 and
126 .IR pop3 ,
127 the password used to authenticate the connection is the APOP
128 secret held by
129 .IR keyfs (4)
130 running on the authentication server.
131 .SH FILES
132 .TF /mail/box/username/imap.subscrib
133 .TP
134 .B /sys/log/imap4d
135 debugging output
136 .TP
137 .BI /mail/box/ username / mailbox
138 .TP
139 .BI /mail/box/ username / mailbox .imp
140 .TP
141 .BI /mail/box/ username /imap.subscribed
142 .SH SOURCE
143 .B /sys/src/cmd/upas/pop3
144 .br
145 .B /sys/src/cmd/ip/imap4d
146 .SH "SEE ALSO"
147 .IR aliasmail (8),
148 .IR faces (1),
149 .IR filter (1),
150 .IR mail (1),
151 .IR marshal (1),
152 .IR mlmgr (1),
153 .IR nedmail (1),
154 .IR qer (8),
155 .IR rewrite (6),
156 .IR send (8),
157 .IR upasfs (4)
158 .SH BUGS
159 Usually messages flagged for deletion with
160 .B DELE
161 are not actually deleted until the client sends a
162 .B QUIT
163 command to end the conversation.
164 .I Pop3
165 implements a non-standard command
166 .B SYNC
167 that deletes messages flagged for deletion
168 without ending the conversation.