summaryrefslogtreecommitdiff
path: root/Administrator_Guide/pot/sect-Recipient_Policy.pot
blob: fcfbc0915277ede4e07954bc0c325f6c530304b6 (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
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
# 
# AUTHOR <EMAIL@ADDRESS>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: 0\n"
"POT-Creation-Date: 2012-11-20T12:43:38\n"
"PO-Revision-Date: 2012-11-20T12:43:38\n"
"Last-Translator: Automatically generated\n"
"Language-Team: None\n"
"MIME-Version: 1.0\n"
"Content-Type: application/x-publican; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#. Tag: title
#, no-c-format
msgid "Recipient Policy"
msgstr ""

#. Tag: para
#, no-c-format
msgid "Kolab Groupware includes an automated application of user metadata, such as the user's given- and surname, to recipient email addresses. This is called <emphasis>the recipient policy</emphasis>. See <xref linkend=\"exam-Administrator_Guide-Recipient_Policy-Example_Default_Application_of_the_Recipient_Policy\" /> for the recipient policy at work."
msgstr ""

#. Tag: para
#, no-c-format
msgid "The recipient policy aids deployments in achieving a level of consistency throughout their recipient database by applying a naming convention, avoiding the need for Kolab Groupware administrators to need to understand and consistently apply naming convention rules. Consistency is important when considering global address book listings and searches in different contexts, and when anticipating what a valid recipient address for a given user may be &ndash; noted that most email users do not have access to your global address book and it is likely that most communications will take place with those users."
msgstr ""

#. Tag: para
#, no-c-format
msgid "Furthmore, the recipient policy allows these automatically recipient email addresses to be globally unique."
msgstr ""

#. Tag: title
#, no-c-format
msgid "Example Default Application of the Recipient Policy"
msgstr ""

#. Tag: para
#, no-c-format
msgid "If an <emphasis>example.org</emphasis> user is created with given name <emphasis>John</emphasis> and surname <emphasis>Doe</emphasis>, the default recipient policy will set the primary email address to <emphasis>john.doe@example.org</emphasis> and the secondary email addresses to <emphasis>j.doe@example.org</emphasis> and <emphasis>doe@example.org</emphasis>."
msgstr ""

#. Tag: para
#, no-c-format
msgid "By default, the primary recipient email address is used as a globally unique identifier involving authentication (allowing login by email address), the user's mailbox name, mail delivery configuration, access control and the storage of user profiles. It is therefore very important that no two entries share a single primary recipient email address."
msgstr ""

#. Tag: para
#, no-c-format
msgid "The recipient policy also avoids the need for Kolab Groupware administrators to understand and consistently apply the various transliteration rules for different locales. See <xref linkend=\"exam-Administrator_Guide-Recipient_Policy-Transliteration_for_Different_Locales\" /> for an example."
msgstr ""

#. Tag: title
#, no-c-format
msgid "Transliteration for Different Locales"
msgstr ""

#. Tag: para
#, no-c-format
msgid "Names can contain non-ASCII characters, as is the case with, for example, <emphasis>Marie Möller</emphasis> (German), while recipient email addresses may not contain such characters (i.e. <emphasis>marie.möller@example.org</emphasis> is an invalid email address)."
msgstr ""

#. Tag: para
#, no-c-format
msgid "Without locale specific transliteration, the email address would become <emphasis>marie.moller@example.org</emphasis>. This is considered inadequate, as many users will experience this inappropriate, inconsiderate and/or awkward &ndash; it is the user's native tongue after all and transliteration is used in every-day life. Kolab Groupware should therefor also be able to apply the same transliteration rules specific to the user's native tongue."
msgstr ""

#. Tag: para
#, no-c-format
msgid "With the (presumably correct) transliteration rules for German applied, the email address would become <emphasis>marie.moeller@example.org</emphasis>."
msgstr ""

#. Tag: para
#, no-c-format
msgid "The recipient policy takes the value(s) of a number of attributes from an entry, and executes the recipient policy for primary and secondary recipient email addresses with help of the attribute names (referred to in the policy) and their values."
msgstr ""

#. Tag: para
#, no-c-format
msgid "It will set the primary email address attribute to a singular value, though the LDAP schema allows multiple values for the default primary mail attribute <literal>mail</literal>. The secondary email address attribute (<literal>alias</literal> by default) is set to the value(s) returned by the recipient policy as well."
msgstr ""

#. Tag: title
#, no-c-format
msgid "Components that Apply the Recipient Policy"
msgstr ""

#. Tag: para
#, no-c-format
msgid "The Kolab daemon (the <literal>kolabd</literal> service) is the primary Kolab Groupware component to apply the recipient policy. The Kolab Web Administration Panel and its API also apply the recipient policy, as otherwise the user interface would be incomplete. However, installation and use of the Kolab WAP and API are optional, which is why the Kolab daemon is the primary component to apply the policy."
msgstr ""

#. Tag: para
#, no-c-format
msgid "Both components use the configuration settings <literal>primary_mail</literal> and <literal>secondary_mail</literal> as their policy configuration. These configuration items consist of a Python notation for string formatting, along with a limited number of string operations."
msgstr ""

#. Tag: para
#, no-c-format
msgid "The <literal>primary_mail</literal> setting contains a singular basestring to be used in simplistic string formatting, while the <literal>secondary_mail</literal> setting contains a numerically ordered list of singular basestrings to be used in string formatting, with the opportunity to execute some additional string operations such as substrings and capitalization. See <xref linkend=\"exam-Administrator_Guide-Recipient_Policy-Example_Primary_Email_Address_Recipient_Policy\" /> for an example."
msgstr ""

#. Tag: title
#, no-c-format
msgid "Example Primary Email Address Recipient Policy"
msgstr ""

#. Tag: para
#, no-c-format
msgid "The primary recipient email address for an <emphasis>example.org</emphasis> user with given name <emphasis>Marie</emphasis>, surname <emphasis>Möller</emphasis> and preffered language <emphasis>de_DE</emphasis>, is composed as follows:"
msgstr ""

#. Tag: para
#, no-c-format
msgid "The recipient policy is obtained from the <literal>primary_mail</literal> setting. By default, this configuration setting is set to:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "[example.org]\n"
"primary_mail = %(givenname)s.%(surname)s@%(domain)s"
msgstr ""

#. Tag: para
#, no-c-format
msgid "As the configuration indicates, the attributes for the user that will be used are the given name and the surname."
msgstr ""

#. Tag: para
#, no-c-format
msgid "For the Kolab Web Administration Panel API, the attributes supplied to the recipient policy routine are actually configured, rather than obtained from the policy configuration itself. See <xref linkend=\"proc-Administrator_Guide-Configuring_the_Recipient_Policy-Setting_Primary_Recipient_Email_Address\" /> for more information."
msgstr ""

#. Tag: para
#, no-c-format
msgid "The Kolab daemon passes a complete list of all attributes along to the recipient policy routine."
msgstr ""

#. Tag: para
#, no-c-format
msgid "Either a specified preferred language is used, or the default locale, to transliterate the given name and surname. In this example, the transliteration rules for German are used. The result is a dictionary that looks as follows:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "{\n"
"        \"givenname\": \"Maria\",\n"
"        \"surname\": \"Moeller\",\n"
"        \"preferredlanguage\": \"de_DE\"\n"
"    }"
msgstr ""

#. Tag: para
#, no-c-format
msgid "Using Python's string formatting, the resulting primary recipient email address would become:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "primary_mail = \"%(givenname)s.%(surname)s@%(domain)s\" % {\n"
"        \"givenname\": \"Maria\",\n"
"        \"surname\": \"Moeller\",\n"
"        \"preferredlanguage\": \"de_DE\"\n"
"    }\n"
"print primary_mail"
msgstr ""

#. Tag: para
#, no-c-format
msgid "or:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "maria.moeller@example.org"
msgstr ""

#. Tag: title
#, no-c-format
msgid "Example Secondary Email Address Recipient Policy"
msgstr ""

#. Tag: para
#, no-c-format
msgid "The secondary recipient email address for an <emphasis>example.org</emphasis> user with given name <emphasis>Marie</emphasis>, surname <emphasis>Möller</emphasis> and preffered language <emphasis>de_DE</emphasis>, is composed as follows:"
msgstr ""

#. Tag: para
#, no-c-format
msgid "The recipient policy is obtained from the <literal>secondary_mail</literal> setting. By default, this configuration setting is set to:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "[example.org]\n"
"secondary_mail = {\n"
"    0: {\n"
"            \"{0}.{1}@{2}\": \"format('%(givenname)s'[0:1].capitalize(), '%(surname)s', '%(domain)s')\"\n"
"        },\n"
"    1: {\n"
"            \"{0}@{1}\": \"format('%(uid)s', '%(domain)s')\"\n"
"        },\n"
"    2: {\n"
"            \"{0}@{1}\": \"format('%(givenname)s.%(surname)s', '%(domain)s')\"\n"
"        }\n"
"}"
msgstr ""

#. Tag: para
#, no-c-format
msgid "As the configuration indicates, the attributes for the user that will be used are the given name, the surname and the uid."
msgstr ""

#. Tag: para
#, no-c-format
msgid "For the Kolab Web Administration Panel API, the attributes supplied to the recipient policy routine are actually configured, rather than obtained from the policy configuration itself. See <xref linkend=\"proc-Administrator_Guide-Configuring_the_Recipient_Policy-Setting_the_Secondary_Recipient_Email_Address\" /> for more information."
msgstr ""

#. Tag: screen
#, no-c-format
msgid "{\n"
"        \"givenname\": \"Maria\",\n"
"        \"surname\": \"Moeller\",\n"
"        \"preferredlanguage\": \"de_DE\",\n"
"        \"uid\": \"moeller\"\n"
"    }"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "secondary_mail = {\n"
"    0: {\n"
"            \"{0}.{1}@{2}\": \"format('Maria'[0:1].capitalize(), 'Moeller', 'example.org')\"\n"
"        },\n"
"    1: {\n"
"            \"{0}@{1}\": \"format('moeller', 'example.org')\"\n"
"        },\n"
"    2: {\n"
"            \"{0}@{1}\": \"format('maria.moeller', 'example.org')\"\n"
"        }\n"
"    }\n"
"\n"
"print secondary_mail"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "- m.moeller@example.org\n"
"- moeller@example.org\n"
"- maria.moeller@example.org"
msgstr ""

#. Tag: title
#, no-c-format
msgid "Configuring the Recipient Policy"
msgstr ""

#. Tag: title
#, no-c-format
msgid "Setting Primary Recipient Email Address"
msgstr ""

#. Tag: para
#, no-c-format
msgid "The primary recipient email address can be changed to reflect your naming convention through this procedure:"
msgstr ""

#. Tag: para
#, no-c-format
msgid "Edit /etc/kolab/kolab.conf and replace the value of the primary_mail setting in the applicable domain section. For example, set the policy to <literal>%(givenname)s@%(domain)s</literal> to get email addresses like <emphasis>john@example.org</emphasis> and <emphasis>jane@example.org</emphasis>."
msgstr ""

#. Tag: para
#, no-c-format
msgid "Edit the user types for any user that matches the filter used by the kolab daemon to determine which users are kolab users. For example, \"Kolab Users\" and \"Mail-enabled POSIX users\" both include \"objectclass=kolabinetorgperson\" (the default kolab_user_filter) and therefore the Kolab daemon would apply the recipient policy to these objects. For each of these user_types, make sure that the auto_form_field configuration for the mail and alias attributes include all attributes needed to compose the addresses."
msgstr ""

#. Tag: title
#, no-c-format
msgid "Example"
msgstr ""

#. Tag: para
#, no-c-format
msgid "para"
msgstr ""

#. Tag: title
#, no-c-format
msgid "Setting the Secondary Recipient Email Address"
msgstr ""

#. Tag: title
#, no-c-format
msgid "Controlling the Primary and Secondary Recipient Email Address Attributes"
msgstr ""

#. Tag: para
#, no-c-format
msgid "The attribute names that contain the primary and secondary recipient email addresses are controlled by the <literal>mail_attrs</literal> setting in the <literal>[<replaceable>$domain</replaceable>]</literal> section of <filename>/etc/kolab/kolab.conf</filename>. Should no such section or setting exist, the fallback in the <literal>[<replaceable>$auth_mechanism</replaceable>]</literal> section is used, where <literal>$auth_mechanism</literal> is the authentication mechanism configured using the <literal>auth_mechanism</literal> setting in the <literal>[kolab]</literal> section &ndash; note that only 'ldap' is currently supported as an authentication mechanism."
msgstr ""

#. Tag: para
#, no-c-format
msgid "This setting is a comma- and/or comma-space separated list of attribute names. By default, <literal>mail_attrs</literal> is set to <literal>mail, alias</literal>."
msgstr ""

#. Tag: para
#, no-c-format
msgid "The first item in the list will be used as the attribute to use for primary recipient email addresses. The second item in the list will be used as the attribute to use for secondary recipient email addresses."
msgstr ""

#. Tag: title
#, no-c-format
msgid "Disabling the Recipient Policy"
msgstr ""

#. Tag: para
#, no-c-format
msgid "The following procedure describes how to disable the recipient policy."
msgstr ""

#. Tag: para
#, no-c-format
msgid "Edit <filename>/etc/kolab/kolab.conf</filename> and navigate to the section applicable for your domain (named <literal>[<replaceable>$domain</replaceable>]</literal>)."
msgstr ""

#. Tag: para
#, no-c-format
msgid "Remove the settings <literal>primary_mail</literal> and <literal>secondary_mail</literal>."
msgstr ""

#. Tag: para
#, no-c-format
msgid "Restart the Kolab daemon:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "# <userinput>service kolabd restart</userinput>"
msgstr ""

#. Tag: para
#, no-c-format
msgid "Copy <filename>/usr/share/doc/kolab-webadmin-*/sample-insert-user_types.php</filename> to <filename>/usr/share/kolab-webadmin/</filename>:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "# <userinput>cp /usr/share/doc/kolab-webadmin-*/sample-insert-user_types.php \\</userinput>\n"
"&gt; <userinput>/usr/share/kolab-webadmin/</userinput>"
msgstr ""

#. Tag: para
#, no-c-format
msgid "Open <filename>/usr/share/kolab-webadmin/sample-insert-user_types.php</filename> in an editor."
msgstr ""

#. Tag: para
#, no-c-format
msgid "Remove the values of <literal>$attributes['auto_form_fields']['mail']</literal> and <literal>$attributes['auto_form_fields']['alias']</literal>. The corresponding lines should look as follows:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "                    \"alias\" =&gt; Array(\n"
"                            \"type\" =&gt; \"list\",\n"
"                            \"data\" =&gt; Array(\n"
"                                    \"givenname\",\n"
"                                    \"preferredlanguage\",\n"
"                                    \"sn\",\n"
"                                ),\n"
"                        ),\n"
""
msgstr ""

#. Tag: para
#, no-c-format
msgid "and:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "                    \"mail\" =&gt; Array(\n"
"                            \"data\" =&gt; Array(\n"
"                                    \"givenname\",\n"
"                                    \"preferredlanguage\",\n"
"                                    \"sn\",\n"
"                                ),\n"
"                        ),\n"
""
msgstr ""

#. Tag: para
#, no-c-format
msgid "Edit the value of <literal>$attributes['form_fields']['alias']</literal> and add <literal>$attributes['form_fields']['alias']['type'] =&gt; \"list\"</literal>:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "                    \"alias\" =&gt; Array(\n"
"                            \"optional\" =&gt; true,\n"
"                            \"type\" =&gt; \"list\"\n"
"                        ),\n"
""
msgstr ""

#. Tag: para
#, no-c-format
msgid "Add a new value <literal>$attributes['form_fields']['mail']</literal> with the following contents:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "                    \"mail\" =&gt; Array(\n"
"                            \"optional\" =&gt; true\n"
"                        ),\n"
""
msgstr ""

#. Tag: para
#, no-c-format
msgid "Remember to remove the aforementioned <literal>$attributes['auto_form_fields']</literal> changes to all user types that have mail attributes."
msgstr ""

#. Tag: para
#, no-c-format
msgid "Exit the editor, saving your changes, and check the PHP syntax:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "# <userinput>cd /usr/share/kolab-webadmin/</userinput>\n"
"# <userinput>php -l sample-insert-user_types.php</userinput>"
msgstr ""

#. Tag: para
#, no-c-format
msgid "Apply the changes to the database:"
msgstr ""

#. Tag: screen
#, no-c-format
msgid "# <userinput>php sample-insert-user_types.php</userinput>"
msgstr ""

#. Tag: para
#, no-c-format
msgid "You may have to log out and log back in of the Kolab Web Administration Panel for the changes to take effect."
msgstr ""