File: dovecot-lda.1

package info (click to toggle)
dovecot 1%3A2.4.1%2Bdfsg1-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 46,224 kB
  • sloc: ansic: 596,204; makefile: 7,825; sh: 6,005; cpp: 1,866; perl: 487; yacc: 412; lex: 320; python: 253; xml: 232
file content (264 lines) | stat: -rw-r--r-- 5,467 bytes parent folder | download
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
.TH "DOVECOT-LDA" "1" "March 2025" "78ffb79" "Dovecot"
.SH "NAME"
\fBdovecot-lda\fR - Dovecot's local mail delivery agent
.SH "SYNOPSIS"
.P
\fBdovecot-lda\fR \[lB]\fB-ek\fR\[rB] \[lB]\fB-a\fR \fIaddress\fR\[rB] \[lB]\fB-c\fR \fIconfig_file\fR\[rB] \[lB]\fB-d\fR \fIusername\fR\[rB] \[lB]\fB-f\fR \fIenvelope_sender\fR\[rB] \[lB]\fB-m\fR \fImailbox\fR\[rB] \[lB]\fB-o\fR \fIsetting=value\fR\[rB] \[lB]\fB-p\fR \fIpath\fR\[rB] \[lB]\fB-r\fR \fIaddress\fR\[rB]
.SH "DESCRIPTION"
.P
The \fBdovecot-lda\fR is a local mail delivery agent which takes mail from an MTA and delivers it to a user's mailbox, while keeping Dovecot index files up to date.
.P
Main features of the \fBdovecot-lda\fR are:
.RS 0
.IP \(bu 4
Mailbox indexing during mail delivery, providing faster mailbox access later
.IP \(bu 4
Quota enforcing by the quota plugin
.IP \(bu 4
Sieve language support by the Pigeonhole sieve plugin
.RE 0

.SH "OPTIONS"
.P
Options accepted by \fBdovecot-lda\fR:
.P
\fB-a\fR \fIaddress\fR
.RS 0
.RS 4
.P
Destination address (e.g. user+ext@domain). If not specified, default is based on the \fBlda_original_recipient_header\fR setting setting.
.RE 0

.RE 0

.P
\fB-c\fR \fIconfig_file\fR
.RS 0
.RS 4
.P
Alternative configuration file path.
.RE 0

.RE 0

.P
\fB-d\fR \fIusername\fR
.RS 0
.RS 4
.P
Destination \fIusername\fR. If given, the user information is looked up from userdb. Typically used with virtual users, but not necessarily with system users.
.RE 0

.RE 0

.P
\fB-e\fR
.RS 0
.RS 4
.P
If mail gets rejected, write the rejection reason to stderr and exit with status 77 (EX_NOPERM). The default is to send a rejection mail ourself.
.RE 0

.RE 0

.P
\fB-f\fR \fIenvelope_sender\fR
.RS 0
.RS 4
.P
Envelope sender address. If not specified and message data begins with a valid mbox-style \fB"From "\fR line, the address is taken from it.
.RE 0

.RE 0

.P
\fB-k\fR
.RS 0
.RS 4
.P
Don't clear all environment at startup.
.RE 0

.RE 0

.P
\fB-m\fR \fImailbox\fR
.RS 0
.RS 4
.P
). If the mailbox doesn't exist, it will not be created (unless \fBlda_mailbox_autocreate\fR setting). If a message couldn't be saved to the 
.RS 4
.IP \(bu 4
If Sieve plugin is used, this mailbox is used as the \fBkeep\fR action's mailbox. It's also used if there is no Sieve script or if the script fails for some reason.
.IP \(bu 4
Deliveries to namespace prefix will result in saving the mail to INBOX instead. For example if you have \fBMail/\fR namespace, this allows you to specify \fBdovecot-lda -m Mail/$mailbox\fR where mail is stored to \fBMail/$mailbox\fR or to INBOX if \fB$mailbox\fR is empty.
.IP \(bu 4
 directory, your namespace configuration is \fBnamespace_prefix\fR setting and \fBnamespace_separator\fR setting, the correct way to deliver mail there is to use 
.RE 0

.RE 0

.RE 0

.P
\fB-o\fR \fIsetting\fR\fB=\fR\fIvalue\fR
.RS 0
.RS 4
.P
Overrides the configuration \fIsetting\fR from \fI/etc/dovecot/dovecot.conf\fR and from the userdb with the given \fIvalue\fR. In order to override multiple settings, the \fB-o\fR option may be specified multiple times.
.RE 0

.RE 0

.P
\fB-p\fR \fIpath\fR
.RS 0
.RS 4
.P
Path to the mail to be delivered instead of reading from stdin. If using maildir the file is hard linked to the destination if possible. This allows a single mail to be delivered to multiple users using hard links, but currently it also prevents deliver from updating cache file so it shouldn't be used unless really necessary.
.RE 0

.RE 0

.P
\fB-r\fR \fIaddress\fR
.RS 0
.RS 4
.P
Final envelope recipient address. Defaults to \fB-a\fR address, but may differ if, e.g., aliases are used or when dropping the \fB+detail\fR part.
.RE 0

.RE 0

.SH "EXIT STATUS"
.P
\fBdovecot-lda\fR will exit with one of the following values:
.P
\fB0\fR
.RS 0
.RS 4
.P
Delivery was successful. (EX_OK)
.RE 0

.RE 0

.P
\fB64\fR
.RS 0
.RS 4
.P
Invalid parameter given. (EX_USAGE)
.RE 0

.RE 0

.P
\fB67\fR
.RS 0
.RS 4
.P
Recipient user not known. (EX_NOUSER)
.RE 0

.RE 0

.P
\fB77\fR
.RS 0
.RS 4
.P
\fB-e\fR option was used and mail was rejected. Typically this happens when user is over quota and \fBquota_full_tempfail = no\fR is configured. (EX_NOPERM)
.RE 0

.RE 0

.P
\fB75\fR
.RS 0
.RS 4
.P
A temporary failure. This is returned for almost all failures. See the log file for details. (EX_TEMPFAIL)
.RE 0

.RE 0

.SH "FILES"
.P
\fI/etc/dovecot/dovecot.conf\fR
.RS 0
.RS 4
.P
Dovecot's main configuration file.
.RE 0

.RE 0

.P
\fI/etc/dovecot/conf.d/10-mail.conf\fR
.RS 0
.RS 4
.P
Mailbox locations and namespaces.
.RE 0

.RE 0

.P
\fI/etc/dovecot/conf.d/15-lda.conf\fR
.RS 0
.RS 4
.P
LDA specific settings.
.RE 0

.RE 0

.P
\fI/etc/dovecot/conf.d/90-plugin.conf\fR
.RS 0
.RS 4
.P
Plugin specific settings.
.RE 0

.RE 0

.P
\fI/etc/dovecot/conf.d/90-quota.conf\fR
.RS 0
.RS 4
.P
Quota configuration.
.RE 0

.RE 0

.SH "REPORTING BUGS"
.P
Report bugs, including \fIdoveconf -n\fR output, to the Dovecot Mailing List \fI\(ladovecot@dovecot.org\(ra\fR. Information about reporting bugs is available at: https://dovecot.org/bugreport.html
.SH "SEE ALSO"
.P
doveadm(1)
.P
Related MTA specific documentation:
.RS 0
.IP \(bu 4
Postfix:
.RS 4
.IP \(bu 4
\fBpostconf\fR(5), \fBtransport\fR(5), \fBpipe\fR(8)
.RE 0

.IP \(bu 4
Exim:
.RS 4
.IP \(bu 4
https://exim.org/exim-html-current/doc/html/spec_html/ch16.html
.IP \(bu 4
https://exim.org/exim-html-current/doc/html/spec_html/ch24.html
.IP \(bu 4
https://exim.org/exim-html-current/doc/html/spec_html/ch29.html
.RE 0

.RE 0