summaryrefslogtreecommitdiff
path: root/man/bincimapd.9
blob: 5e42551e92abe4a34841c66f1122badff8e99ffd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
.TH bincimapd 1
.SH "NAME"
bincimapd \- IMAP4rev1 server
.SH "SYNOPSIS"
.B bincimap-up [options] -- <authenticator> bincimapd <maildepot>

.B bincimap-up -- SQMAIL/bin/qmail-authuser bincimapd Maildir
.SH "DESCRIPTION"
.B bincimapd 
implements the IMAP interface to the user's 
.I <maildepot>
by name which could be
.I Maildir++
or 
.I IMAPdir 
structured.
Upon invocation
.B bincimapd
switches to the home directory available by the user environment 
and performs the commanded IMAP operations on the given
.IR <maildepot> .
.SH "CONFIGURATION"
.B bincimapd
shares the same environment variables with
.BR bincimap-up ,
thus there is no specific configuration required and therefore
.I [...]
is usually avoided, except for
its first unqualified argument containing the name of the 
mailbox depository in which
.B bincimapd 
should search for folders. If unset, some authenticators like
.B qmail-authuser
and 
.B vmailmgr
will fail. However, 
.B bincimapd 
runs in the environment of the user and honors the
a specific setting of environment variables to cope 
local preferences.
.SH "COMPLIANCE"
.B bincimapd
conforms partially to IMAP4rev1 (RFCs 3501, 2177 [Idle], 2341 [Namespace], 
2971 [Id]).
Alphabetic list of supported IMAP commands:
.IP \[bu] 2
Append
.IP \[bu] 2 
Authenticate
.IP \[bu] 2 
Capability
.IP \[bu] 2 
Check
.IP \[bu] 2 
Close
.IP \[bu] 2 
Copy
.IP \[bu] 2 
Create
.IP \[bu] 2 
Delete
.IP \[bu] 2 
Examine
.IP \[bu] 2 
Expunge
.IP \[bu] 2 
Fetch
.IP \[bu] 2 
Id
.IP \[bu] 2 
Idle
.IP \[bu] 2 
List
.IP \[bu] 2 
Login
.IP \[bu] 2 
Logout
.IP \[bu] 2 
Lsub
.IP \[bu] 2 
Namespace
.IP \[bu] 2 
Noop
.IP \[bu] 2 
Rename
.IP \[bu] 2 
Search
.IP \[bu] 2 
Select
.IP \[bu] 2 
Starttls
.IP \[bu] 2 
Status
.IP \[bu] 2 
Store
.IP \[bu] 2 
Subscribe
.IP \[bu] 2 
Unsubscribe
.SH "FILES"
Within every
.I <maildepot>
subdirectory
.B bincimpad
generates a set of files 
.TP
.I $HOME/<maildepot>/.../bincimap-uidvalidity
This file contains a version number, the
.BR UIDNEXT ,
and
.B UIDVALIDITY
values for the given mailbox.
.TP
.I $HOME/<maildepot>/.../bincimap-cache
This file contains a version number, and it stores the
.B UID
values for each message, along with (optionally) some cached
information.

.RE
Exception:
.TP  
.I $HOME/<maildepot>/.subscribed
All subscribed <mailboxes> are included here. 
.SH "LOGGING" 
After the user login
.B bincimapd 
displays the 
.IR PID , 
.IR userid , 
and
.I IP address.
On logout or disconnect
it provides the 
.IR PID ,
the number of messages fetched
.IR Bodies:\ n , 
and the number of IMAP commands executed
.IR Statements:\ m . 
.SH "COPYRIGHT"
Copyright (C) 2002-2005 Andreas Aardal Hanssen, 2023 Erwin Hoffmann

This is free software; see the LICENSE for copying conditions. 
There is NO warranty.
.SH "SEE ALSO"
bincimap(1), bincimap-up(1),
multilog(8), supervise(8), tcpserver(1), sslserver(1),
qmail-authuser(7)