Schema.pm 234 KB
Newer Older
1
2
3
4
5
# -*- indent-tabs-mode: nil; -*-
# vim:ft=perl:et:sw=4

# Sympa - SYsteme de Multi-Postage Automatique
#
6
7
# Copyright 2020, 2021 The Sympa Community. See the
# AUTHORS.md file at the top-level directory of this distribution and at
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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
# <https://github.com/sympa-community/sympa.git>.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

package Sympa::Config::Schema;

use strict;
use warnings;

use Sympa::Constants;
use Sympa::Regexps;

# Parameter defaults
my %default = (
    occurrence => '0-1',
    length     => 25
);

# DEPRECATED. No longer used.
#our @param_order;

# List parameter alias names
# DEPRECATED.  Use 'obsolete' elements.
#our %alias;

our %pgroup = (
    presentation => {
        order           => 1,
        gettext_id      => 'Service description',
        gettext_comment => '',
    },
    database => {
        order           => 2,
        gettext_id      => 'Database related',
        gettext_comment => '',
    },
    logging => {
        order           => 3,
        gettext_id      => 'System log',
        gettext_comment => '',
    },
    mta => {
        order => 4,
        #gettext_id      => 'Alias management',
        gettext_id      => 'Mail server',
        gettext_comment => '',
    },
    description => {
        order           => 10,
        gettext_id      => 'List definition',
        gettext_comment => '',
    },
    incoming => {
        order           => 19,
        gettext_id      => 'Receiving',
        gettext_comment => '',
    },
    sending => {
        order => 20,
        #gettext_id      => 'Sending related',
        gettext_id      => 'Sending/receiving setup',
        gettext_comment => '',
    },
    outgoing => {
        order           => 21,
        gettext_id      => 'Distribution',
        gettext_comment => '',
    },
    command => {
        order           => 30,
        gettext_id      => 'Privileges',
        gettext_comment => '',
    },
    archives => {
        order           => 40,
        gettext_id      => 'Archives',
        gettext_comment => '',
    },
    bounces => {
        order => 50,
        #gettext_id      => 'Bounce management and tracking',
        gettext_id      => 'Bounces',
        gettext_comment => '',
    },

    loop_prevention => {
        order           => 51,
        gettext_id      => 'Loop prevention',
        gettext_comment => '',
    },
    automatic_lists => {
        order           => 52,
        gettext_id      => 'Automatic lists',
        gettext_comment => '',
    },
    antispam => {
        order           => 53,
        gettext_id      => 'Tag based spam filtering',
        gettext_comment => '',
    },
    directories => {
        order           => 54,
        gettext_id      => 'Directories',
        gettext_comment => '',
    },
    other => {
        order           => 90,
        gettext_id      => 'Miscellaneous',
        gettext_comment => '',
    },

    www_basic => {
        order           => 110,
        gettext_id      => 'Web interface parameters',
        gettext_comment => '',
    },
    www_appearances => {
        order           => 120,
        gettext_id      => 'Web interface parameters: Appearances',
        gettext_comment => '',
    },
    www_other => {
        order           => 190,
        gettext_id      => 'Web interface parameters: Miscellaneous',
        gettext_comment => '',
    },

    crypto => {
        order      => 59,
        gettext_id => 'S/MIME and TLS',
        gettext_comment =>
            "S/MIME authentication, decryption and re-encryption. It requires these external modules: Crypt-OpenSSL-X509 and Crypt-SMIME.\nTLS client authentication. It requires an external module: IO-Socket-SSL.",
    },
    data_source => {
        order      => 60,
        gettext_id => 'Data sources setup',
        gettext_comment =>
            'Including subscribers, owners and moderators from data sources. Appropriate database driver (DBD) modules are required: DBD-CSV, DBD-mysql, DBD-ODBC, DBD-Oracle, DBD-Pg, DBD-SQLite and/or Net-LDAP. And also, if secure connection (LDAPS) to LDAP server is required: IO-Socket-SSL.',
    },
    dkim => {
        order => 70,
        #gettext_id => 'DKIM and ARC',
        gettext_id => 'DKIM/DMARC/ARC',
        gettext_comment =>
            "DKIM signature verification and re-signing. It requires an external module: Mail-DKIM.\nARC seals on forwarded messages. It requires an external module: Mail-DKIM.",
    },
    dmarc_protection => {    #FIXME: Not used?
        order      => 71,
        gettext_id => 'DMARC protection',
        gettext_comment =>
            'Processes originator addresses to avoid some domains\' excessive DMARC protection. This feature requires an external module: Net-DNS.',
    },

    list_check => {
        order      => 72,
        gettext_id => 'List address verification',
        gettext_comment =>
            'Checks if an alias with the same name as the list to be created already exists on the SMTP server. This feature requires an external module: Net-SMTP.',
    },
    antivirus => {
        order           => 73,
        gettext_id      => 'Antivirus plug-in',
        gettext_comment => '',
    },

    password_validation => {
        order      => 153,
        gettext_id => 'Password validation',
        gettext_comment =>
            'Checks if the password the user submitted has sufficient strength. This feature requires an external module: Data-Password.',
    },
    ldap_auth => {
        order      => 154,
        gettext_id => 'Authentication with LDAP',
        gettext_comment =>
            'Authenticates users based on the directory on LDAP server. This feature requires an external module: Net-LDAP. And also, if secure connection (LDAPS) is required: IO-Socket-SSL.',
    },
    sympasoap => {
        order      => 156,
        gettext_id => 'SOAP HTTP interface',
        gettext_comment =>
            'Provides some functions of Sympa through the SOAP HTTP interface. This feature requires an external module: SOAP-Lite.',
    },

    _obsoleted => {
        order           => 99999,
        gettext_id      => 'Obsoleted parameters',
        gettext_comment => '',
    },
);

my $site_obsolete =
    {context => [qw(site)], group => '_obsoleted', obsolete => 1};

our %pinfo = (

    # Initial configuration

    domain => {
        context => [qw(domain site)],    #FIXME:not used in robot.conf.
        order   => 1.01,
        group   => 'presentation',
        gettext_id => 'Primary mail domain name',
        format     => '[-\w]+(?:[.][-\w]+)+',
        sample     => 'mail.example.org',
        occurrence => '1',
    },
    listmaster => {
        context    => [qw(domain site)],
        order      => 1.02,
        group      => 'presentation',
        sample     => 'your_email_address@domain.tld',
        gettext_id => 'Email addresses of listmasters',
        split_char => ',',                                #FIXME
        gettext_comment =>
            'Email addresses of the listmasters (users authorized to perform global server commands). Some error reports may also be sent to these addresses. Listmasters can be defined for each virtual host, however, the default listmasters will have privileges to manage all virtual hosts.',
        format_s   => '$addrspec',
        occurrence => '1-n',
    },

    ### Global definition page ###

    supported_lang => {
        context => [qw(domain site)],
        order   => 1.10,
        group   => 'presentation',
        default =>
            'ca,cs,de,el,en-US,es,et,eu,fi,fr,gl,hu,it,ja,ko,nb,nl,oc,pl,pt-BR,ru,sv,tr,vi,zh-CN,zh-TW',
        gettext_id => 'Supported languages',
        split_char => ',',
        gettext_comment =>
            'All supported languages for the user interface. Languages proper locale information not installed are ignored.',
        format => '\w+(\-\w+)*',
    },
    title => {
        context    => [qw(domain site)],
        order      => 1.11,
        group      => 'presentation',
        default    => 'Mailing lists service',
        gettext_id => 'Title of service',
        gettext_comment =>
            'The name of your mailing list service. It will appear in the header of web interface and subjects of several service messages.',
        format => '.+',
        file   => 'wwsympa.conf',
    },
    gecos => {
        context    => [qw(domain site)],
        order      => 1.12,
        group      => 'presentation',
        default    => 'SYMPA',
        gettext_id => 'Display name of Sympa',
        gettext_comment =>
            'This parameter is used for display name in the "From:" header field for the messages sent by Sympa itself.',
        format => '.+',
    },
    legacy_character_support_feature => {
        context    => [qw(site)],
        order      => 1.13,
        group      => 'presentation',
        default    => 'off',
        gettext_id => 'Support of legacy character set',
        gettext_comment =>
            "If set to \"on\", enables support of legacy character set according to charset.conf(5) configuration file.\nIn some language environments, legacy encoding (character set) can be preferred for e-mail messages: for example iso-2022-jp in Japanese language.",
        format => ['on', 'off'],    #XXX
    },

    # Database

    update_db_field_types => {
        context    => [qw(site)],
        order      => 2.01,
        group      => 'database',
        gettext_id => 'Update database structure',
        gettext_comment =>
            "auto: Updates database table structures automatically.\nHowever, since version 5.3b.5, Sympa will not shorten field size if it already have been longer than the size defined in database definition.",
        format  => ['auto', 'off'],
        default => 'auto',
    },
    db_type => {
        context    => [qw(site)],
        order      => 2.10,
        group      => 'database',
        default    => 'mysql',
        gettext_id => 'Type of the database',
        gettext_comment =>
            'Possible types are "MySQL", "PostgreSQL", "Oracle" and "SQLite".',
        format     => '\w+',
        occurrence => '1',
    },
    db_host => {
        context => [qw(site)],
        order   => 2.11,
        group   => 'database',
        #default => 'localhost',
        sample     => 'localhost',
        gettext_id => 'Hostname of the database server',
        gettext_comment =>
            'With PostgreSQL, you can also use the path to Unix Socket Directory, e.g. "/var/run/postgresql" for connection with Unix domain socket.',
        format_s => '$host',
    },
    db_port => {
        context    => [qw(site)],
        order      => 2.12,
        group      => 'database',
        gettext_id => 'Port of the database server',
        format     => '[-/\w]+',
    },
    db_name => {
        context    => [qw(site)],
        order      => 2.13,
        group      => 'database',
        default    => 'sympa',
        gettext_id => 'Name of the database',
        gettext_comment =>
            "With SQLite, this must be the full path to database file.\nWith Oracle Database, this must be SID, net service name or easy connection identifier (to use net service name, db_host should be set to \"none\" and HOST, PORT and SERVICE_NAME should be defined in tnsnames.ora file).",
        format => '.+',
    },
    db_user => {
        context => [qw(site)],
        order   => 2.14,
        group   => 'database',
        #default => 'user_name',
        sample     => 'sympa',
        gettext_id => 'User for the database connection',
        format     => '.+',
    },
    db_passwd => {
        context => [qw(site)],
        order   => 2.15,
        group   => 'database',
        #default => 'user_password',
        sample     => 'your_passwd',
        gettext_id => 'Password for the database connection',
        field_type => 'password',
        gettext_comment =>
            'What ever you use a password or not, you must protect the SQL server (is it not a public internet service ?)',
        format => '.+',
    },
    db_options => {
        context    => [qw(site)],
        order      => 2.16,
        group      => 'database',
        gettext_id => 'Database options',
        gettext_comment =>
            'If these options are defined, they will be appended to data source name (DSN) fed to database driver. Check the related DBD documentation to learn about the available options.',
        format => '.+',
        sample =>
            'mysql_read_default_file=/home/joe/my.cnf;mysql_socket=tmp/mysql.sock-test',
    },
    db_env => {
        context    => [qw(site)],
        order      => 2.17,
        group      => 'database',
        gettext_id => 'Environment variables setting for database',
        gettext_comment =>
            'With Oracle Database, this is useful for defining ORACLE_HOME and NLS_LANG.',
        format => '.+',
        sample =>
            'NLS_LANG=American_America.AL32UTF8;ORACLE_HOME=/u01/app/oracle/product/11.2.0/server',
    },
    db_timeout => {
        context    => [qw(site)],
        order      => 2.18,
        group      => 'database',
        gettext_id => 'Database processing timeout',
        gettext_comment =>
            'Currently, this parameter may be used for SQLite only.',
        format => '\d+',
    },
    db_additional_subscriber_fields => {
        context    => [qw(site)],
        order      => 2.20,
        group      => 'database',
        sample     => 'billing_delay,subscription_expiration',
        gettext_id => 'Database private extension to subscriber table',
        split_char => ',',                                              #FIXME
        gettext_comment =>
            "Adds more fields to \"subscriber_table\" table. Sympa recognizes fields defined with this parameter. You will then be able to use them from within templates and scenarios:\n* for scenarios: [subscriber->field]\n* for templates: [% subscriber.field %]\nThese fields will also appear in the list members review page and will be editable by the list owner. This parameter is a comma-separated list.\nYou need to extend the database format with these fields",
        format     => '.+',
        occurrence => '0-n',
    },
    db_additional_user_fields => {
        context    => [qw(site)],
        order      => 2.21,
        group      => 'database',
        sample     => 'age,address',
        gettext_id => 'Database private extension to user table',
        split_char => ',',                                              #FIXME
        gettext_comment =>
            "Adds more fields to \"user_table\" table. Sympa recognizes fields defined with this parameter. You will then be able to use them from within templates: [% subscriber.field %]\nThis parameter is a comma-separated list.\nYou need to extend the database format with these fields",
        format     => '.+',
        occurrence => '0-n',
    },

    ### System log

    syslog => {
        context         => [qw(site)],
        order           => 3.01,
        group           => 'logging',
        default         => 'LOCAL1',
        gettext_id      => 'System log facility for Sympa',
        gettext_comment => 'Do not forget to configure syslog server.',
        format          => '\S+',
    },
    log_socket_type => {
        context    => [qw(site)],
        order      => 3.02,
        group      => 'logging',
        default    => 'unix',
        gettext_id => 'Communication mode with syslog server',
        format     => '\w+',
    },
    log_level => {
        context    => [qw(domain site)],    #FIXME "domain" possible?
        order      => 3.03,
        group      => 'logging',
        default    => '0',
        sample     => '2',
        gettext_id => 'Log verbosity',
        gettext_comment =>
            "Sets the verbosity of logs.\n0: Only main operations are logged\n3: Almost everything is logged.",
        format => '\d+',
    },

    ### Maili server (alias management & passing to the next hop)

    sendmail => {
        context    => [qw(site)],
        order      => 4.01,
        group      => 'mta',
        default    => '/usr/sbin/sendmail',
        gettext_id => 'Path to sendmail',
        gettext_comment =>
            "Absolute path to sendmail command line utility (e.g.: a binary named \"sendmail\" is distributed with Postfix).\nSympa expects this binary to be sendmail compatible (exim, Postfix, qmail and so on provide it).",
        format => '.+',
    },
    sendmail_args => {
        context    => [qw(site)],
        order      => 4.02,
        group      => 'mta',
        default    => '-oi -odi -oem',
        gettext_id => 'Command line parameters passed to sendmail',
        gettext_comment =>
            "Note that \"-f\", \"-N\" and \"-V\" options and recipient addresses should not be included, because they will be included by Sympa.",
        format => '.+',
    },

    sendmail_aliases => {
        context   => [qw(domain site)],
        order     => 4.03,
        group     => 'mta',
        default_s => '$SENDMAIL_ALIASES',
        gettext_id =>
            'Path of the file that contains all list related aliases',
        gettext_comment =>
            "It is recommended to create a specific alias file so that Sympa never overwrites the standard alias file, but only a dedicated file.\nSet this parameter to \"none\" if you want to disable alias management in Sympa.",
        format => '.+',
    },
    aliases_program => {
        context    => [qw(domain site)],
        order      => 4.04,
        group      => 'mta',
        format     => 'makemap|newaliases|postalias|postmap|/.+',
        default    => 'newaliases',
        gettext_id => 'Program used to update alias database',
        gettext_comment =>
            'This may be "makemap", "newaliases", "postalias", "postmap" or full path to custom program.',
    },
488
489
    aliases_wrapper => {
        context    => [qw(domain site)],
IKEDA Soji's avatar
IKEDA Soji committed
490
        order      => 4.045,
491
        group      => 'mta',
Sympa authors's avatar
Sympa authors committed
492
493
494
        format     => ['off', 'on'],
        synonym    => {'0' => 'off', '1' => 'on'},
        default    => 'on',
495
        gettext_id => 'Whether to use the alias wrapper',
IKEDA Soji's avatar
IKEDA Soji committed
496
497
        gettext_comment =>
            'If the program to update alias database does not require root privileges, set this parameter to "off" and remove the wrapper file sympa_newaliases-wrapper.',
498
    },
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
    aliases_db_type => {
        context    => [qw(domain site)],
        order      => 4.05,
        group      => 'mta',
        format     => '\w[-\w]*',
        default    => 'hash',
        gettext_id => 'Type of alias database',
        gettext_comment =>
            '"btree", "dbm", "hash" and so on.  Available when aliases_program is "makemap", "postalias" or "postmap"',
    },
    alias_manager => {
        context    => [qw(site)],
        order      => 4.06,
        group      => 'mta',
        gettext_id => 'Path to alias manager',
        gettext_comment =>
            'The absolute path to the script that will add/remove mail aliases',
        format => '.+',

        default_s => '$SBINDIR/alias_manager.pl',
        sample    => '/usr/local/libexec/ldap_alias_manager.pl',
    },

    ### List definition page ###

    subject => {
        context    => [qw(list)],
        order      => 10.01,
        group      => 'description',
        gettext_id => "Subject of the list",
        gettext_comment =>
            'This parameter indicates the subject of the list, which is sent in response to the LISTS mail command. The subject is a free form text limited to one line.',
        format     => '.+',
        occurrence => '1',
        length     => 50
    },

    visibility => {
        context    => [qw(list domain site)],
        order      => 10.02,
        group      => 'description',
        gettext_id => "Visibility of the list",
        gettext_comment =>
            'This parameter indicates whether the list should feature in the output generated in response to a LISTS command or should be shown in the list overview of the web-interface.',
        scenario => 'visibility',
        synonym  => {
            'public'  => 'noconceal',
            'private' => 'conceal'
        },
        default => 'conceal',
    },

    owner => {
        context  => [qw(list)],
        obsolete => 1,
        format   => {
            email => {
                context  => [qw(list)],
                obsolete => 1,
                format_s => '$email',
            },
            gecos => {
                context  => [qw(list)],
                obsolete => 1,
                format   => '.+',
            },
            info => {
                context  => [qw(list)],
                obsolete => 1,
                format   => '.+',
            },
            profile => {
                context  => [qw(list)],
                obsolete => 1,
                format   => ['privileged', 'normal'],
            },
            reception => {
                context  => [qw(list)],
                obsolete => 1,
                format   => ['mail', 'nomail'],
            },
            visibility => {
                context  => [qw(list)],
                obsolete => 1,
                format   => ['conceal', 'noconceal'],
            }
        },
        occurrence => '1-n'
    },

    editor => {
        context  => [qw(list)],
        obsolete => 1,
        format   => {
            email => {
                context  => [qw(list)],
                obsolete => 1,
                format_s => '$email',
            },
            reception => {
                context  => [qw(list)],
                obsolete => 1,
                format   => ['mail', 'nomail'],
            },
            visibility => {
                context  => [qw(list)],
                obsolete => 1,
                format   => ['conceal', 'noconceal'],
            },
            gecos => {
                context  => [qw(list)],
                obsolete => 1,
                format   => '.+',
            },
            info => {
                context  => [qw(list)],
                obsolete => 1,
                format   => '.+',
            }
        },
        occurrence => '0-n'
    },

    topics => {
        context    => [qw(list)],
        order      => 10.07,
        group      => 'description',
        gettext_id => "Topics for the list",
        gettext_comment =>
            "This parameter allows the classification of lists. You may define multiple topics as well as hierarchical ones. WWSympa's list of public lists uses this parameter.",
        format     => [],            # Sympa::Robot::topic_keys() called later
        field_type => 'listtopic',
        split_char => ',',
        occurrence => '0-n',
        filters    => ['lc'],
    },

    host => {
        context    => [qw(list domain site)],
        order      => 10.08,
        group      => 'description',
        gettext_id => "Internet domain",
        gettext_comment =>
            'Domain name of the list, default is the robot domain name set in the related robot.conf file or in file sympa.conf.',
        format_s => '$host',
        filters  => ['canonic_domain'],
        length   => 20,
        obsolete => 1
    },

    lang => {
        context    => [qw(list domain site)],
        order      => 10.09,
        group      => 'description',
        gettext_id => "Language of the list",
        #gettext_id => 'Default language',
        gettext_comment =>
            "This parameter defines the language used for the list. It is used to initialize a user's language preference; Sympa command reports are extracted from the associated message catalog.",
        #gettext_comment =>
        #    'This is the default language used by Sympa. One of supported languages should be chosen.',
        format => [],    ## Sympa::get_supported_languages() called later
        file_format => '\w+(\-\w+)*',
        field_type  => 'lang',
        occurrence  => '1',
        filters     => ['canonic_lang'],
        default     => 'en-US',
    },

    family_name => {
        context    => [qw(list)],
        order      => 10.10,
        group      => 'description',
        gettext_id => 'Family name',
        format_s   => '$family_name',
        occurrence => '0-1',
        internal   => 1
    },

    max_list_members => {
        context    => [qw(list domain site)],
        order      => 10.11,
        group      => 'description',                     # incoming / sending?
        gettext_id => "Maximum number of list members",
        gettext_comment =>
            'limit for the number of subscribers. 0 means no limit.',
        gettext_unit => 'list members',
        format       => '\d+',
        length       => 8,
        default      => '0',
    },

    # Incoming
    # - Approximately corresponds to ProcessIncoming and DoMessage spindles.
    # - Does _not_ contain the parameters with List context.

    sender_headers => {
        context => [qw(site)],
        order   => 19.00_02,
        group   => 'incoming',
        default => 'From',
        sample  => 'Resent-From,From,Return-Path',
        gettext_id =>
            'Header field name(s) used to determine sender of the messages',
        gettext_comment =>
            '"Return-Path" means envelope sender (a.k.a. "UNIX From") which will be alternative to sender of messages without "From" field.  "Resent-From" may also be inserted before "From", because some mailers add it into redirected messages and keep original "From" field intact.  In particular cases, "Return-Path" can not give right sender: several mail gateway products rewrite envelope sender and add original one as non-standard field such as "X-Envelope-From".  If that is the case, you might want to insert it in place of "Return-Path".',
        split_char => ',',
    },

    misaddressed_commands => {
        context    => [qw(site)],
        order      => 19.00_03,
        group      => 'incoming',
        gettext_id => 'Reject misaddressed commands',
        gettext_comment =>
            'When a mail command is sent to a list, by default Sympa rejects this message. This feature can be turned off setting this parameter to "ignore".',
        default => 'reject',
    },
    misaddressed_commands_regexp => {
        context => [qw(site)],
        order   => 19.00_04,
        group   => 'incoming',
        gettext_id =>
            'Regular expression matching with misaddressed commands',
        gettext_comment =>
            'Perl regular expression applied on messages subject and body to detect misaddressed commands.',
        default =>
            '((subscribe\s+(\S+)|unsubscribe\s+(\S+)|signoff\s+(\S+)|set\s+(\S+)\s+(mail|nomail|digest))\s*)',
    },
    sympa_priority => {
        context    => [qw(domain site)],
        order      => 19.00_05,
        group      => 'incoming',
        gettext_id => 'Priority for command messages',
        gettext_comment =>
            'Priority applied to messages sent to Sympa command address.',
        format  => [0 .. 9, 'z'],
        default => '1',
    },
    request_priority => {
        context    => [qw(domain site)],
        order      => 19.00_06,
        group      => 'incoming',
        gettext_id => 'Priority for messages bound for list owners',
        gettext_comment =>
            'Priority for processing of messages bound for "LIST-request" address, i.e. owners of the list',
        format  => [0 .. 9, 'z'],
        default => '0',
    },
    owner_priority => {
        context    => [qw(domain site)],
        order      => 19.00_07,
        group      => 'incoming',
        gettext_id => 'Priority for non-VERP bounces',
        gettext_comment =>
            'Priority for processing of messages bound for "LIST-owner" address, i.e. non-delivery reports (bounces).',
        format  => [0 .. 9, 'z'],
        default => '9',
    },

    priority => {
        context    => [qw(list domain site)],
        order      => 10.12,
        group      => 'description',            # incoming / sending?
        gettext_id => "Priority",
        gettext_comment =>
            'The priority with which Sympa will process messages for this list. This level of priority is applied while the message is going through the spool. The z priority will freeze the message in the spool.',
        #gettext_comment =>
        #    'Priority for processing of messages posted to list addresses.',
        format     => [0 .. 9, 'z'],
        length     => 1,
        occurrence => '1',
        default    => '5',
    },

    incoming_max_count => {
        context    => [qw(site)],
        order      => 19.00_10,
        group      => 'incoming',
        default    => '1',
        gettext_id => 'Max number of sympa.pl workers',
        gettext_comment =>
            'Max number of workers of sympa.pl daemon processing incoming spool.',
        format => '\d+',
    },

    sleep => {
        context         => [qw(site)],
        order           => 19.00_11,
        group           => 'incoming',
        default         => '5',
        gettext_id      => 'Interval between scanning incoming message spool',
        gettext_comment => 'Must not be 0.',
        format          => '\d+',
        gettext_unit    => 'seconds',
    },

    ### Sending page ###
    # - Approximately corresponds to AuthorizeMessage, Transform*, ToArchive,
    #   ToDigest and ToList spindles.
    # - Contains the parameters with List context.

    send => {
        context    => [qw(list domain site)],
        order      => 20.01,
        group      => 'sending',
        gettext_id => "Who can send messages",
        gettext_comment =>
            'This parameter specifies who can send messages to the list.',
        scenario => 'send',
        default  => 'private',
    },

    delivery_time => {
        context    => [qw(list)],
        order      => 20.02,
        group      => 'sending',
        gettext_id => "Delivery time (hh:mm)",
        gettext_comment =>
            'If this parameter is present, non-digest messages will be delivered to subscribers at this time: When this time has been past, delivery is postponed to the same time in next day.',
        format     => '[0-2]?\d\:[0-6]\d',
        occurrence => '0-1',
        length     => 5
    },

    digest => {
        context    => [qw(list)],
        order      => 20.03,
        group      => 'sending',
        gettext_id => "Digest frequency",
        gettext_comment =>
            'Definition of digest mode. If this parameter is present, subscribers can select the option of receiving messages in multipart/digest MIME format, or as a plain text digest. Messages are then grouped together, and compiled messages are sent to subscribers according to the frequency selected with this parameter.',
        file_format => '\d+(\s*,\s*\d+)*\s+\d+:\d+',
        format      => {
            days => {
                context     => [qw(list)],
                order       => 1,
                gettext_id  => "days",
                format      => [0 .. 6],
                file_format => '1|2|3|4|5|6|7',
                field_type  => 'dayofweek',
                occurrence  => '1-n'
            },
            hour => {
                context    => [qw(list)],
                order      => 2,
                gettext_id => "hour",
                format     => '\d+',
                occurrence => '1',
                length     => 2
            },
            minute => {
                context    => [qw(list)],
                order      => 3,
                gettext_id => "minute",
                format     => '\d+',
                occurrence => '1',
                length     => 2
            }
        },
    },

    digest_max_size => {
        context      => [qw(list)],
        order        => 20.04,
        group        => 'sending',
        gettext_id   => "Digest maximum number of messages",
        gettext_unit => 'messages',
        format       => '\d+',
        default      => 25,
        length       => 2
    },

    available_user_options => {
        context    => [qw(list)],
        order      => 20.05,
        group      => 'sending',
        gettext_id => "Available subscription options",
        format     => {
            reception => {
                context    => [qw(list)],
                order      => 1,
                gettext_id => "reception mode",
                gettext_comment =>
                    'Only these modes will be allowed for the subscribers of this list. If a subscriber has a reception mode not in the list, Sympa uses the mode specified in the default_user_options paragraph.',
                format => [
                    'mail',    'notice', 'digest', 'digestplain',
                    'summary', 'nomail', 'txt',    'urlize',
                    'not_me'
                ],
                synonym    => {'html' => 'mail'},
                field_type => 'reception',
                occurrence => '1-n',
                split_char => ',',
                default =>
                    'mail,notice,digest,digestplain,summary,nomail,txt,urlize,not_me'
            }
        }
    },

    default_user_options => {
        context         => [qw(list)],
        order           => 20.06,
        group           => 'sending',
        gettext_id      => "Subscription profile",
        gettext_comment => 'Default profile for the subscribers of the list.',
        format          => {
            reception => {
                context         => [qw(list)],
                order           => 1,
                gettext_id      => "reception mode",
                gettext_comment => 'Mail reception mode.',
                format          => [
                    'mail',    'notice', 'digest', 'digestplain',
                    'summary', 'nomail', 'txt',    'urlize',
                    'not_me'
                ],
                synonym    => {'html' => 'mail'},
                field_type => 'reception',
                occurrence => '1',
                default    => 'mail'
            },
            visibility => {
                context         => [qw(list)],
                order           => 2,
                gettext_id      => "visibility",
                gettext_comment => 'Visibility of the subscriber.',
                format          => ['conceal', 'noconceal'],
                field_type      => 'visibility',
                occurrence      => '1',
                default         => 'noconceal'
            }
        },
    },

    msg_topic => {
        context    => [qw(list)],
        order      => 20.07,
        group      => 'sending',
        gettext_id => "Topics for message categorization",
        gettext_comment =>
            "This paragraph defines a topic used to tag a message of a list, named by msg_topic.name (\"other\" is a reserved word), its title is msg_topic.title. The msg_topic.keywords entry is optional and allows automatic tagging. This should be a list of keywords, separated by ','.",
        format => {
            name => {
                context     => [qw(list)],
                order       => 1,
                gettext_id  => "Message topic name",
                format      => '[\-\w]+',
                occurrence  => '1',
                length      => 15,
                validations => ['reserved_msg_topic_name'],
            },
            keywords => {
                context    => [qw(list)],
                order      => 2,
                gettext_id => "Message topic keywords",
                format     => '[^,\n]+(,[^,\n]+)*',
                occurrence => '0-1'
            },
            title => {
                context    => [qw(list)],
                order      => 3,
                gettext_id => "Message topic title",
                format     => '.+',
                occurrence => '1',
                length     => 35
            }
        },
        occurrence => '0-n'
    },

    msg_topic_keywords_apply_on => {
        context => [qw(list)],
        order   => 20.08,
        group   => 'sending',
        gettext_id =>
            "Defines to which part of messages topic keywords are applied",
        gettext_comment =>
            'This parameter indicates which part of the message is used to perform automatic tagging.',
        format     => ['subject', 'body', 'subject_and_body'],
        occurrence => '0-1',
        default    => 'subject'
    },

    msg_topic_tagging => {
        context    => [qw(list)],
        order      => 20.09,
        group      => 'sending',
        gettext_id => "Message tagging",
        gettext_comment =>
            'This parameter indicates if the tagging is optional or required for a list.',
        format     => ['required_sender', 'required_moderator', 'optional'],
        occurrence => '1',
        default    => 'optional'
    },

    reply_to => {
        context    => [qw(list)],
        group      => 'sending',
        gettext_id => "Reply address",
        format     => '\S+',
        default    => 'sender',
        obsolete   => 1