.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Sympa::Family 3Sympa" .TH Sympa::Family 3Sympa "2022-11-25" "6.2.70" "sympa 6.2.70" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Sympa::Family \- List families .SH "DESCRIPTION" .IX Header "DESCRIPTION" Sympa allows lists creation and management by sets. These are the families, sets of lists sharing common properties. This module gathers all the family-specific operations. .SS "Functions" .IX Subsection "Functions" .ie n .IP "get_families ( $robot )" 4 .el .IP "get_families ( \f(CW$robot\fR )" 4 .IX Item "get_families ( $robot )" \&\fIFunction\fR. Returns the list of existing families in the Sympa installation. .Sp Arguments .RS 4 .ie n .IP "$robot" 4 .el .IP "\f(CW$robot\fR" 4 .IX Item "$robot" The robot the family list of which we want to get. .RE .RS 4 .Sp Returns .Sp An arrayref containing all the robot's family names. .RE .ie n .IP "get_available_families ( $robot )" 4 .el .IP "get_available_families ( \f(CW$robot\fR )" 4 .IX Item "get_available_families ( $robot )" \&\fIFunction\fR. \&\fBObsoleted\fR. Use \f(CW\*(C`get_families()\*(C'\fR. .SS "Methods" .IX Subsection "Methods" .ie n .IP "new (\s-1STRING\s0 $name, \s-1STRING\s0 $robot)" 4 .el .IP "new (\s-1STRING\s0 \f(CW$name\fR, \s-1STRING\s0 \f(CW$robot\fR)" 4 .IX Item "new (STRING $name, STRING $robot)" \&\fIConstructor\fR. Creates a new Sympa::Family object of name \f(CW$name\fR, belonging to the robot \f(CW$robot\fR. .Sp Arguments .RS 4 .ie n .IP "$name" 4 .el .IP "\f(CW$name\fR" 4 .IX Item "$name" A character string containing the family name, .ie n .IP "$robot" 4 .el .IP "\f(CW$robot\fR" 4 .IX Item "$robot" A character string containing the name of the robot which the family is/will be installed in. .RE .RS 4 .Sp Returns .Sp The Sympa::Family object. .RE .ie n .IP "check_param_constraint (\s-1LIST\s0 $list)" 4 .el .IP "check_param_constraint (\s-1LIST\s0 \f(CW$list\fR)" 4 .IX Item "check_param_constraint (LIST $list)" \&\fIInstance method\fR. Checks the parameter constraints taken from param_constraint.conf file for the Sympa::List object \f(CW$list\fR. .Sp Arguments .RS 4 .ie n .IP "$list" 4 .el .IP "\f(CW$list\fR" 4 .IX Item "$list" A List object corresponding to the list to check. .RE .RS 4 .Sp Returns .IP "\(bu" 4 \&\fI1\fR if everything goes well, .IP "\(bu" 4 \&\fIundef\fR if something goes wrong, .IP "\(bu" 4 \&\fI\e@error\fR, a ref on an array containing parameters conflicting with constraints. .RE .RS 4 .RE .IP "get_constraints ()" 4 .IX Item "get_constraints ()" \&\fIInstance method\fR. Returns a hash containing the values found in the param_constraint.conf file. .Sp Arguments .Sp None. .Sp Returns .Sp \&\f(CW\*(C`$self\->{\*(Aqparam_constraint_conf\*(Aq}\*(C'\fR, a hash containing the values found in the param_constraint.conf file. .ie n .IP "check_values (\s-1SCALAR\s0 $param_value, \s-1SCALAR\s0 $constraint_value)" 4 .el .IP "check_values (\s-1SCALAR\s0 \f(CW$param_value\fR, \s-1SCALAR\s0 \f(CW$constraint_value\fR)" 4 .IX Item "check_values (SCALAR $param_value, SCALAR $constraint_value)" \&\fIInstance method\fR. Returns 0 if all the value(s) found in \f(CW$param_value\fR appear also in \&\f(CW$constraint_value\fR. Otherwise the function returns an array containing the unmatching values. .Sp Arguments .RS 4 .ie n .IP "$param_value" 4 .el .IP "\f(CW$param_value\fR" 4 .IX Item "$param_value" A scalar or a ref to a list (which is also a scalar after all) .ie n .IP "$constraint_value" 4 .el .IP "\f(CW$constraint_value\fR" 4 .IX Item "$constraint_value" A scalar or a ref to a list .RE .RS 4 .Sp Returns .Sp \&\fI\e@error\fR, a ref to an array containing the values in \f(CW$param_value\fR which don't match those in \f(CW$constraint_value\fR. .RE .ie n .IP "get_param_constraint (\s-1STRING\s0 $param)" 4 .el .IP "get_param_constraint (\s-1STRING\s0 \f(CW$param\fR)" 4 .IX Item "get_param_constraint (STRING $param)" \&\fIInstance method\fR. Gets the constraints on parameter \f(CW$param\fR from the 'param_constraint.conf' file. .Sp Arguments .RS 4 .ie n .IP "$param" 4 .el .IP "\f(CW$param\fR" 4 .IX Item "$param" A character string corresponding to the name of the parameter for which we want to gather constraints. .RE .RS 4 .Sp Returns .IP "\(bu" 4 \&\fI0\fR if there are no constraints on the parameter, .IP "\(bu" 4 \&\fIa scalar\fR containing the allowed value if the parameter has a fixed value, .IP "\(bu" 4 \&\fIa ref to a hash\fR containing the allowed values if the parameter is controlled, .IP "\(bu" 4 \&\fIundef\fR if something went wrong. .RE .RS 4 .RE .IP "get_uncompellable_param ()" 4 .IX Item "get_uncompellable_param ()" \&\fIInstance method\fR. Returns a reference to hash whose keys are the uncompellable parameters. .Sp Arguments .Sp None. .Sp Returns .Sp \&\f(CW\*(C`\e%list_of_param\*(C'\fR, a ref to a hash the keys of which are the uncompellable parameters names. .ie n .IP "insert_delete_exclusion ( $email, $action )" 4 .el .IP "insert_delete_exclusion ( \f(CW$email\fR, \f(CW$action\fR )" 4 .IX Item "insert_delete_exclusion ( $email, $action )" \&\fIInstance method\fR. Handle exclusion table for family. \&\s-1TBD.\s0 .IP "get_id ( )" 4 .IX Item "get_id ( )" \&\fIInstance method\fR. Gets unique identifier of instance. .SS "Attributes" .IX Subsection "Attributes" .IP "{name}" 4 .IX Item "{name}" The name of family. .IP "{domain}" 4 .IX Item "{domain}" The mail domain (a.k.a. \*(L"robot\*(R") the family belongs to. .Sp \&\fBNote\fR: On Sympa 6.2.52 or earlier, \f(CW\*(C`{robot}\*(C'\fR was used. .IP "{dir}" 4 .IX Item "{dir}" Base dire4ctory of the family. .IP "{state}" 4 .IX Item "{state}" Obsoleted. \&\s-1TBD.\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" Sympa::List, Sympa::Request::Handler::close_list, Sympa::Request::Handler::create_automatic_list, Sympa::Request::Handler::update_automatic_list. .PP \&\fBsympa_automatic\fR\|(8). .PP List families , \fISympa Administration Manual\fR. .SH "HISTORY" .IX Header "HISTORY" Family module was initially written by: .IP "\(bu" 4 Serge Aumont .IP "\(bu" 4 Olivier Salaun .PP Renamed Sympa::Family appeared on Sympa 6.2a.39. Afterward, it has been gradually rewritten, therefore Sympa::Request::Handler::close_list, Sympa::Request::Handler::create_automatic_list and Sympa::Request::Handler::update_automatic_list were separated up till Sympa 6.2.49b.