1ZARAFA-DAGENT(1) Zarafa user reference ZARAFA-DAGENT(1)
2
6 zarafa-dagent - Deliver mails to Zarafa.
7
9 zarafa-dagent [OPTION...] RECIPIENT
10
12 With zarafa-dagent, mail messages can be imported from Internet Mail
13 format to Zarafa. The message is read from standard in and delivered to
14 the Zarafa server in the mailbox of RECIPIENT. You can alter source and
15 destination of this mail with various options.
16 The RECIPIENT value is resolved by zarafa-dagent prior to delivery, and
18 therefore accepts any unique identifier for the recipient. In practice
19 it is most useful to pass the emailaddress of the user as the RECIPIENT
20 parameter since it is always unique (Note that login names are
21 sometimes not unique since group names may overlap).
22 The delivery agent will accept and deliver the message piped through it
24 or specified by -f and exit immediately.
25 The delivery agent can also run as LMTP daemon.
27
29 Various options are possible. None of these options are required.
30 --config, -c file
32 Use a configuration file. See the CONFIG() section for more
33 information.
34 Default: /etc/zarafa/dagent.cfg
36 --deamonize, -d
38 Daemonize after starting. This implies --listen and is only used
39 when LMTP is active.
40 --junk, -j
42 Deliver in the Junk mail folder of the specified user.
43 --file, -f file
45 Read e-mail input from file. When not given, input is read from
46 standard in.
47 --host, -h path
49 Connect to the Zarafa server through path, e.g.
50 file:///path/to/socket. Default: file:///var/run/zarafa.
51 --listen, -l
53 Listen for incoming LMTP connections
54 -q
56 Use qmail style exit codes. Please see the EXITCODES() section for
57 more information.
58 -s
60 Silent mode. No output will be printed by the DAgent, except when
61 wrong parameters are used to call zarafa-dagent.
62 -v
64 Verbose mode. More output can be printed when processing the e-mail
65 for rules.
66 When given a second time, more debugging output will be printed.
68 -e
70 Strip the domain from the given username. For example, when the
71 DAgent is called with ´-e´ and the username is ´name@domain.com´,
72 the delivery will be started for user ´name´ instead of
73 ´name@domain.com´.
74 -R
76 The passed recipient name will always be resolved first. This means
77 that the recipient can be a username, e-mail address or any other
78 resolvable, unique identifier for the user. However, if the resolve
79 fails (eg. when running as a non-trusted user), the passed name
80 will be assumed to be a loginname of a user. Passing the -R option
81 will disable this and will cause zarafa-dagent to exit with an
82 error when the resolve fails.
83 In practice, the resolve will only fail if zarafa-dagent is not
85 running in a trusted account and is therefore only really here for
86 backward-compatibility of earlier zarafa-dagent versions.
87 -n
89 Use ´now´ as the delivery time. Normally, the dagent will use the
90 date from the first Received header, which is most likely to be the
91 header from your own mailserver.
92 --do-not-notify, -N
94 Do not send a new mail notification to othere connected clients.
95 This option can be usefull when you have connected Outlook 2000
96 clients, which will also process rules when the mail is delivered.
97 This is a bug workaround, and this option may disappear in the
98 future.
99 --folder, -F path\to\folder
101 Deliver the incoming email to a specified subfolder of the store.
102 Eg. --folder ´Inbox\important´. Note that the ´Inbox´ folder is
103 language specific. If the folder does not exist, delivery is
104 reverted to the normal Inbox of the user, or use the --create flag.
105 --public, -P path\to\folder
107 Deliver the incoming email to a specified subfolder of the public
108 store. Eg. --public ´sales\incoming´. If the folder does not exist,
109 delivery is reverted to the normal Inbox of the user, or use the
110 --create flag.
111 Note that before 6.20 you´d need to add ´Public Folders´ to the
113 folder name. This is not needed anymore.
114 -p <path separator>
116 Use a different path separator. The default is ´\´. If your
117 delivery path contains a \ character, you can use this to alter the
118 separator. Eg. -p _ --folder ´Inbox_resellers\dealers´. The mail
119 will now be delivered in a folder called ´resellers\dealers´ as a
120 subfolder of the Inbox.
121 --create, -C
123 Create the folder that was requested to deliver in. If there are no
124 sufficient rights to create the folder, delivery is reverted to the
125 normal Inbox of the user.
126 --read, -r
128 Deliver the mail as read. Normally, the message will be marked as
129 unread. This option can be usefull when importing old mail.
130 --add-imap-data
132 Add IMAP optimizations during delivery. The original received email
133 will also be stored in the Zarafa server. This will increase disk
134 usage, but the zarafa-gateway will be much faster on these
135 optimized emails. Enable if you use the zarafa-gateway as the
136 primary method to read e-mail and you can spare the additional disk
137 space usage.
138 -a autoresponder
140 Path to autoresponder, e.g. /usr/local/bin/zarafa-autorespond.
141 This script will be called when the user enabled a vacation message
142 in the Webaccess settings. When a header X-Zarafa-Vacation or
143 Precedence was found in the received e-mail, this program will not
144 be called to avoid loops. The Precedence header is often used in
145 mailing lists. Other loop protections can be archieved in this
146 separate program. This program or script will be called with the
147 following arguments, in order:
148 from
150 The e-mail address of the Zarafa user sending the vacation
151 message
152 to
154 The e-mail address of the user to send the response to
155 subject
157 The auto response subject set by the Zarafa user
158 zarafa-username
160 The username of the Zarafa user which set the auto response
161 messagefile
163 A file where the auto respond message will be temporary written
164 to during the autorespond
165 Default: /usr/bin/zarafa-autorespond.
167
169 To deliver an e-mail to a Zarafa user´s mailbox:
170 cat mail | zarafa-dagent username
172 This pipes the input to the dagent via the standard input interface.
174
176 Normally, no configuration file is used or required. The following
177 options can be set in the configuation file:
178 server_socket
180 Unix socket to find the connection to the Zarafa server.
181 Default: file:///var/run/zarafa
183 sslkey_file
185 Use this file as key to logon to the server. This is only used when
186 server_socket is set to an HTTPS transport. See the zarafa-
187 server(1) manual page on how to setup SSL keys.
188 Default: value not set.
190 sslkey_pass
192 The password of the SSL key file that is set in sslkey_file.
193 Default: value not set.
195
197 The following exitcodes can be returned:
198 0
200 Delivery was successful
201 64
203 Wrong or not enough parameters were passed to the DAgent. Delivery
204 cannot be started.
205 70, 100
207 Delivery was failed, and cannot be delivered. The SMTP server
208 should not try again. When the -q option is used, this value is
209 changed to 100, otherwise 70 is returned.
210 75, 111
212 Delivery was temporarily failed. This happens when the Zarafa
213 server is unavailable. The SMTP server may try again in a short
214 while. When the -q option is used, this value is changed to 111,
215 otherwise 75 is returned.
216
218 Written by Zarafa.
219
221 zarafa-server(1) zarafa-dagent.cfg(5)
222Zarafa 7.0 August 2011 ZARAFA-DAGENT(1)