summaryrefslogtreecommitdiffstats
path: root/doc/man/dovecot-lda.1.in
blob: 7f8033b4de25b61077a5d900fb302722892a41a0 (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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
.\" Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file
.TH DOVECOT\-LDA 1 "2011-01-16" "Dovecot v2.3" "Dovecot"
.SH NAME
dovecot\-lda \- Dovecot\(aqs local mail delivery agent
.\"------------------------------------------------------------------------
.SH SYNOPSIS
.B dovecot\-lda
.RB [ \-ek ]
[\fB\-a\fP \fIaddress\fP]
[\fB\-c\fP \fIconfig_file\fP]
[\fB\-d\fP \fIusername\fP]
[\fB\-f\fP \fIenvelope_sender\fP]
[\fB\-m\fP \fImailbox\fP]
[\fB\-o\fP \fIsetting=value\fP]
[\fB\-p\fP \fIpath\fP]
.\"------------------------------------------------------------------------
.SH DESCRIPTION
The
.B dovecot\-lda
is a local mail delivery agent which takes mail from an MTA and delivers
it to a user\(aqs mailbox, while keeping Dovecot index files up to date.
.PP
Main features of the
.B dovecot\-lda
are:
.TP 4
*
Mailbox indexing during mail delivery, providing faster mailbox access
later
.TP
*
Quota enforcing by the quota plugin
.TP
*
Sieve language support by the Pigeonhole sieve plugin
.\"------------------------------------------------------------------------
.SH OPTIONS
Options accepted by
.BR dovecot\-lda :
.\"-------------------------------------
.TP
.BI \-a\  address
Destination address (e.g. user+ext@domain). Default is the same as
.IR username .
.\"-------------------------------------
.TP
.BI \-c\  config_file
Alternative configuration file path.
.\"-------------------------------------
.TP
.BI \-d\  username
Destination
.IR username .
If given, the user information is looked up from userdb.
Typically used with virtual users, but not necessarily with system users.
.\"-------------------------------------
.TP
.B \-e
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.
.\"-------------------------------------
.TP
.BI \-f\  envelope_sender
Envelope sender address.
.\"-------------------------------------
.TP
.B \-k
Don\(aqt clear all environment at startup.
.\"-------------------------------------
.TP
.BI \-m\  mailbox
Destination mailbox (default is
.BR INBOX ).
If the mailbox doesn\(aqt exist, it will not be created (unless the
.I lda_mailbox_autocreate
setting is set to
.BR yes ).
If a message couldn\(aqt be saved to the
.I mailbox
for any reason, it\(aqs delivered to
.B INBOX
instead.
.\"---------------------------------
.TP
.BI \-o\  setting = value
Overrides the configuration
.I setting
from
.I @pkgsysconfdir@/dovecot.conf
and from the userdb with the given
.IR value .
In order to override multiple settings, the
.B \-o
option may be specified multiple times.
.\"-------------------------------------
.TP
.BI \-p\  path
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\(aqt be used unless really necessary.
.\"------------------------------------------------------------------------
.SH "EXIT STATUS"
.B dovecot\-lda
will exit with one of the following values:
.TP 4
.B 0
Delivery was successful. (EX_OK)
.TP
.B 64
Invalid parameter given. (EX_USAGE)
.TP
.B 77
.B \-e
option was used and mail was rejected.
Typically this happens when user is over quota and
.B quota_full_tempfail = no
is configured. (EX_NOPERM)
.TP
.B 75
A temporary failure. This is returned for almost all failures. See the log
file for details. (EX_TEMPFAIL)
.\"------------------------------------------------------------------------
.SH FILES
.TP
.I @pkgsysconfdir@/dovecot.conf
Dovecot\(aqs main configuration file.
.TP
.I @pkgsysconfdir@/conf.d/10\-mail.conf
Mailbox locations and namespaces.
.TP
.I @pkgsysconfdir@/conf.d/15\-lda.conf
LDA specific settings.
.TP
.I @pkgsysconfdir@/conf.d/90\-plugin.conf
Plugin specific settings.
.TP
.I @pkgsysconfdir@/conf.d/90\-quota.conf
Quota configuration.
.\"------------------------------------------------------------------------
@INCLUDE:reporting-bugs@
.\"------------------------------------------------------------------------
.SH SEE ALSO
.BR doveadm (1),
.BR dovecot (1),
.BR doveconf (1),
.BR dsync (1)
.PP
Related MTA specific documentation:
.\"-------------------------------------
.TP
Postfix:
.BR postconf (5),
.BR transport (5),
.BR pipe (8)
.\"-------------------------------------
.PP
Exim:
.IP "The accept router"
http://exim.org/exim\-html\-current/doc/html/spec_html/ch16.html
.IP "Generic options for transports"
http://exim.org/exim\-html\-current/doc/html/spec_html/ch24.html
.IP "The pipe transport"
http://exim.org/exim\-html\-current/doc/html/spec_html/ch29.html