.\" 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::List 3Sympa"
.TH Sympa::List 3Sympa "2021-02-07" "6.2.60" "sympa 6.2.60"
.\" 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::List \- Mailing list
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Sympa::List represents the mailing list on Sympa.
.SS "Methods"
.IX Subsection "Methods"
.ie n .IP "new( $name, [ $domain [ {options...} ] ] )" 4
.el .IP "new( \f(CW$name\fR, [ \f(CW$domain\fR [ {options...} ] ] )" 4
.IX Item "new( $name, [ $domain [ {options...} ] ] )"
\&\fIConstructor\fR.
Creates a new object which will be used for a list and
eventually loads the list if a name is given. Returns
a List object.
.Sp
Parameters
.Sp
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "add_list_admin ( \s-1ROLE, USERS, ...\s0 )" 4
.IX Item "add_list_admin ( ROLE, USERS, ... )"
Adds a new admin user to the list. May overwrite existing
entries.
.ie n .IP "add_list_header ( $message, $field_type )" 4
.el .IP "add_list_header ( \f(CW$message\fR, \f(CW$field_type\fR )" 4
.IX Item "add_list_header ( $message, $field_type )"
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "add_list_member ( \s-1USER, HASHPTR\s0 )" 4
.IX Item "add_list_member ( USER, HASHPTR )"
Adds a new user to the list. May overwrite existing
entries.
.IP "available_reception_mode ( )" 4
.IX Item "available_reception_mode ( )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.Sp
Note: Since Sympa 6.1.18, this returns an array under array context.
.IP "delete_list_admin ( \s-1ROLE, ARRAY\s0 )" 4
.IX Item "delete_list_admin ( ROLE, ARRAY )"
Delete the indicated admin user with the predefined role from the list.
\&\s-1ROLE\s0 may be \f(CW\*(Aqowner\*(Aq\fR or \f(CW\*(Aqeditor\*(Aq\fR.
.IP "delete_list_member ( \s-1ARRAY\s0 )" 4
.IX Item "delete_list_member ( ARRAY )"
Delete the indicated users from the list.
.ie n .IP "delete_list_member_picture ( $email )" 4
.el .IP "delete_list_member_picture ( \f(CW$email\fR )" 4
.IX Item "delete_list_member_picture ( $email )"
Deletes a member's picture file.
.IP "destroy_multiton ( ) \fIInstance method\fR. Destroy multiton instance. \s-1FIXME\s0" 4
.IX Item "destroy_multiton ( ) Instance method. Destroy multiton instance. FIXME"
.PD 0
.IP "dump_users ( \s-1ROLE\s0 )" 4
.IX Item "dump_users ( ROLE )"
.PD
Dump user information in user store into file \f(CW\*(C`\f(CI$role\f(CW.dump\*(C'\fR under
list directory. \s-1ROLE\s0 may be \f(CW\*(Aqmember\*(Aq\fR, \f(CW\*(Aqowner\*(Aq\fR or \f(CW\*(Aqeditor\*(Aq\fR.
.ie n .IP "find_picture_filenames ( $email )" 4
.el .IP "find_picture_filenames ( \f(CW$email\fR )" 4
.IX Item "find_picture_filenames ( $email )"
Returns the type of a pictures according to the user.
.IP "find_picture_paths ( )" 4
.IX Item "find_picture_paths ( )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.ie n .IP "find_picture_url ( $email )" 4
.el .IP "find_picture_url ( \f(CW$email\fR )" 4
.IX Item "find_picture_url ( $email )"
Find pictures \s-1URL\s0
.ie n .IP "get_admins ( $role, [ filter => \e@filters ] )" 4
.el .IP "get_admins ( \f(CW$role\fR, [ filter => \e@filters ] )" 4
.IX Item "get_admins ( $role, [ filter => @filters ] )"
\&\fIInstance method\fR.
Gets users of the list with one of following roles.
.RS 4
.ie n .IP """actual_editor""" 4
.el .IP "\f(CWactual_editor\fR" 4
.IX Item "actual_editor"
Editors belonging to the list.
If there are no such users, owners of the list.
.ie n .IP """editor""" 4
.el .IP "\f(CWeditor\fR" 4
.IX Item "editor"
Editors belonging to the list.
.ie n .IP """owner""" 4
.el .IP "\f(CWowner\fR" 4
.IX Item "owner"
Owners of the list.
.ie n .IP """privileged_owner""" 4
.el .IP "\f(CWprivileged_owner\fR" 4
.IX Item "privileged_owner"
Owners whose \f(CW\*(C`profile\*(C'\fR attribute is \f(CW\*(C`privileged\*(C'\fR.
.ie n .IP """receptive_editor""" 4
.el .IP "\f(CWreceptive_editor\fR" 4
.IX Item "receptive_editor"
Editors belonging to the list and whose reception mode is \f(CW\*(C`mail\*(C'\fR.
If there are no such users, owners whose reception mode is \f(CW\*(C`mail\*(C'\fR.
.ie n .IP """receptive_owner""" 4
.el .IP "\f(CWreceptive_owner\fR" 4
.IX Item "receptive_owner"
Owners whose reception mode is \f(CW\*(C`mail\*(C'\fR.
.RE
.RS 4
.Sp
Optional filter may be:
.ie n .IP "[email => $email]" 4
.el .IP "[email => \f(CW$email\fR]" 4
.IX Item "[email => $email]"
Limit result to the user with their e\-mail \f(CW$email\fR.
.RE
.RS 4
.Sp
Returns:
.Sp
In array context, returns (possiblly empty or single-item) array of users.
In scalar context, returns reference to it.
In case of database error, returns empty array or undefined value.
.RE
.ie n .IP "get_admins_email ( $role )" 4
.el .IP "get_admins_email ( \f(CW$role\fR )" 4
.IX Item "get_admins_email ( $role )"
\&\fIInstance method\fR.
Gets an array of emails of list admins with role
\&\f(CW\*(C`receptive_editor\*(C'\fR, \f(CW\*(C`actual_editor\*(C'\fR, \f(CW\*(C`receptive_owner\*(C'\fR or \f(CW\*(C`owner\*(C'\fR.
.IP "get_archive_dir ( )" 4
.IX Item "get_archive_dir ( )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "get_available_msg_topic ( )" 4
.IX Item "get_available_msg_topic ( )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "get_bounce_address ( \s-1WHO,\s0 [ \s-1OPTS, ...\s0 ] )" 4
.IX Item "get_bounce_address ( WHO, [ OPTS, ... ] )"
Return the \s-1VERP\s0 address of the list for the user \s-1WHO.\s0
.Sp
\&\s-1FIXME: VERP\s0 addresses have the name of originating robot, not mail host.
.IP "get_bounce_dir ( )" 4
.IX Item "get_bounce_dir ( )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "get_cert ( )" 4
.IX Item "get_cert ( )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "get_config_changes ( )" 4
.IX Item "get_config_changes ( )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "get_cookie ()" 4
.IX Item "get_cookie ()"
Returns the cookie for a list, if available.
.IP "get_current_admins ( ... )" 4
.IX Item "get_current_admins ( ... )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "get_default_user_options ()" 4
.IX Item "get_default_user_options ()"
Returns a default option of the list for subscription.
.IP "get_first_list_member ()" 4
.IX Item "get_first_list_member ()"
Returns a hash to the first user on the list.
.IP "get_id ( )" 4
.IX Item "get_id ( )"
Return the list \s-1ID,\s0 different from the list address (uses the robot name)
.ie n .IP "get_including_lists ( $role )" 4
.el .IP "get_including_lists ( \f(CW$role\fR )" 4
.IX Item "get_including_lists ( $role )"
\&\fIInstance method\fR.
List of lists including specified list and hosted by a whole site.
.Sp
Parameter:
.RS 4
.ie n .IP "$role" 4
.el .IP "\f(CW$role\fR" 4
.IX Item "$role"
Role of included users.
\&\f(CW\*(Aqmember\*(Aq\fR, \f(CW\*(Aqowner\*(Aq\fR or \f(CW\*(Aqeditor\*(Aq\fR.
.RE
.RS 4
.Sp
Returns:
.Sp
Arrayref of <Sympa::List> instances.
Return \f(CW\*(C`undef\*(C'\fR on failure.
.RE
.IP "get_list_member ( \s-1USER\s0 )" 4
.IX Item "get_list_member ( USER )"
Returns a subscriber of the list.
.IP "get_max_size ()" 4
.IX Item "get_max_size ()"
Returns the maximum allowed size for a message.
.ie n .IP "get_members ( $role, [ offset => $offset ], [ order => $order ], [ limit => $limit ])" 4
.el .IP "get_members ( \f(CW$role\fR, [ offset => \f(CW$offset\fR ], [ order => \f(CW$order\fR ], [ limit => \f(CW$limit\fR ])" 4
.IX Item "get_members ( $role, [ offset => $offset ], [ order => $order ], [ limit => $limit ])"
\&\fIInstance method\fR.
Gets users of the list with one of following roles.
.RS 4
.ie n .IP """member""" 4
.el .IP "\f(CWmember\fR" 4
.IX Item "member"
Members of the list, either subscribed or included.
.ie n .IP """unconcealed_member""" 4
.el .IP "\f(CWunconcealed_member\fR" 4
.IX Item "unconcealed_member"
Members whose \f(CW\*(C`visibility\*(C'\fR property is not \f(CW\*(C`conceal\*(C'\fR.
.RE
.RS 4
.Sp
Optional parameters:
.ie n .IP "limit => $limit" 4
.el .IP "limit => \f(CW$limit\fR" 4
.IX Item "limit => $limit"
.PD 0
.ie n .IP "offset => $offset" 4
.el .IP "offset => \f(CW$offset\fR" 4
.IX Item "offset => $offset"
.ie n .IP "order => $order" 4
.el .IP "order => \f(CW$order\fR" 4
.IX Item "order => $order"
.PD
\&\s-1TBD.\s0
.RE
.RS 4
.Sp
Returns:
.Sp
In array context, returns (possiblly empty or single-item) array of users.
In scalar context, returns reference to it.
In case of database error, returns empty array or undefined value.
.RE
.IP "get_msg_count ( )" 4
.IX Item "get_msg_count ( )"
\&\fIInstance method\fR.
Returns the number of messages sent to the list.
\&\s-1FIXME\s0
.IP "get_next_bouncing_list_member ( )" 4
.IX Item "get_next_bouncing_list_member ( )"
\&\fIInstance method\fR.
Loop for all subsequent bouncing users.
\&\s-1FIXME\s0
.IP "get_next_delivery_date ( )" 4
.IX Item "get_next_delivery_date ( )"
\&\fIInstance method\fR.
Returns the date epoch for next delivery planned for a list.
.Sp
Note: As of 6.2a.41, returns \f(CW\*(C`undef\*(C'\fR if parameter is not set or invalid.
Previously it returned current time.
.IP "get_next_list_member ()" 4
.IX Item "get_next_list_member ()"
Returns a hash to the next users, until we reach the end of
the list.
.ie n .IP "get_param_value ( $param, [ $as_arrayref ] )" 4
.el .IP "get_param_value ( \f(CW$param\fR, [ \f(CW$as_arrayref\fR ] )" 4
.IX Item "get_param_value ( $param, [ $as_arrayref ] )"
\&\fIinstance method\fR.
Returns the list parameter value.
the parameter is simple (\fIname\fR) or composed (\fIname\fR\f(CW\*(C`.\*(C'\fR\fIminor\fR)
the value is a scalar or a ref on an array of scalar
(for parameter digest : only for days).
.IP "get_picture_path ( )" 4
.IX Item "get_picture_path ( )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0
.IP "get_recipients_per_mode ( )" 4
.IX Item "get_recipients_per_mode ( )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "get_reply_to ()" 4
.IX Item "get_reply_to ()"
Returns an array with the Reply-To values.
.ie n .IP "get_resembling_members ( $role, $searchkey )" 4
.el .IP "get_resembling_members ( \f(CW$role\fR, \f(CW$searchkey\fR )" 4
.IX Item "get_resembling_members ( $role, $searchkey )"
\&\fIinstance method\fR.
\&\s-1TBD.\s0
.IP "get_stats ( )" 4
.IX Item "get_stats ( )"
Returns array of the statistics.
.IP "get_total ( [ 'nocache' ] )" 4
.IX Item "get_total ( [ 'nocache' ] )"
Returns the number of subscribers to the list.
.IP "get_total_bouncing ( )" 4
.IX Item "get_total_bouncing ( )"
\&\fIInstance method\fR.
Gets total number of bouncing subscribers.
.IP "has_data_sources ( )" 4
.IX Item "has_data_sources ( )"
\&\fIInstance method\fR.
Checks if a list has data sources.
.ie n .IP "has_included_users ( $role )" 4
.el .IP "has_included_users ( \f(CW$role\fR )" 4
.IX Item "has_included_users ( $role )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.ie n .IP "insert_delete_exclusion ( $email, ""insert""|""delete"" )" 4
.el .IP "insert_delete_exclusion ( \f(CW$email\fR, \f(CW``insert''\fR|\f(CW``delete''\fR )" 4
.IX Item "insert_delete_exclusion ( $email, ""insert""|""delete"" )"
\&\fIInstance method\fR.
Update the exclusion table.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.ie n .IP "is_admin ( $role, $user )" 4
.el .IP "is_admin ( \f(CW$role\fR, \f(CW$user\fR )" 4
.IX Item "is_admin ( $role, $user )"
\&\fIInstance method\fR.
Returns true if \f(CW$user\fR has \f(CW$role\fR
(\f(CW\*(C`privileged_owner\*(C'\fR, \f(CW\*(C`owner\*(C'\fR, \f(CW\*(C`actual_editor\*(C'\fR or \f(CW\*(C`editor\*(C'\fR) on the list.
.IP "is_archived ()" 4
.IX Item "is_archived ()"
Returns true is the list is configured to keep archives of
its messages.
.IP "is_archiving_enabled ( )" 4
.IX Item "is_archiving_enabled ( )"
Returns true is the list is configured to keep archives of
its messages, i.e. process_archive parameter is set to \*(L"on\*(R".
.ie n .IP "is_available_msg_topic ( $topic )" 4
.el .IP "is_available_msg_topic ( \f(CW$topic\fR )" 4
.IX Item "is_available_msg_topic ( $topic )"
\&\fIInstance method\fR.
Checks for a topic if it is available in the list
(look for each list parameter \f(CW\*(C`msg_topic.name\*(C'\fR).
.ie n .IP "is_available_reception_mode ( $mode )" 4
.el .IP "is_available_reception_mode ( \f(CW$mode\fR )" 4
.IX Item "is_available_reception_mode ( $mode )"
\&\fIInstance method\fR.
Is a reception mode in the parameter reception of the available_user_options
section?
.IP "is_digest ( )" 4
.IX Item "is_digest ( )"
\&\fIInstance method\fR.
Does the list support digest mode?
.IP "is_included ( )" 4
.IX Item "is_included ( )"
Returns true value if the list is included in another list(s).
.IP "is_list_member ( \s-1USER\s0 )" 4
.IX Item "is_list_member ( USER )"
Returns true if the indicated user is member of the list.
.ie n .IP "is_member_excluded ( $email )" 4
.el .IP "is_member_excluded ( \f(CW$email\fR )" 4
.IX Item "is_member_excluded ( $email )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "is_moderated ()" 4
.IX Item "is_moderated ()"
Returns true if the list is moderated.
\&\s-1FIXME\s0 this may not be useful.
.IP "is_msg_topic_tagging_required ( )" 4
.IX Item "is_msg_topic_tagging_required ( )"
\&\fIInstance method\fR.
Checks for the list parameter msg_topic_tagging
if it is set to 'required'.
.IP "is_there_msg_topic ( )" 4
.IX Item "is_there_msg_topic ( )"
\&\fIInstance method\fR.
Tests if some msg_topic are defined.
.IP "is_web_archived ( )" 4
.IX Item "is_web_archived ( )"
\&\fIInstance method\fR.
Is the list web archived?
.Sp
\&\s-1FIXME:\s0 Broken. Use scenario or \fBis_archiving_enabled()\fR.
.IP "load ( )" 4
.IX Item "load ( )"
Loads the indicated list into the object.
.ie n .IP "load_data_sources_list ( $robot )" 4
.el .IP "load_data_sources_list ( \f(CW$robot\fR )" 4
.IX Item "load_data_sources_list ( $robot )"
\&\fIInstance method\fR.
Loads all data sources.
\&\s-1FIXME:\s0 Used only in wwsympa.fcgi.
.ie n .IP "may_edit ( $param, $who, [ options, ... ] )" 4
.el .IP "may_edit ( \f(CW$param\fR, \f(CW$who\fR, [ options, ... ] )" 4
.IX Item "may_edit ( $param, $who, [ options, ... ] )"
\&\fIInstance method\fR.
May the indicated user edit the indicated list parameter or not?
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.ie n .IP "parse_list_member_bounce ( $user )" 4
.el .IP "parse_list_member_bounce ( \f(CW$user\fR )" 4
.IX Item "parse_list_member_bounce ( $user )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.ie n .IP "restore_suspended_subscription ( $email )" 4
.el .IP "restore_suspended_subscription ( \f(CW$email\fR )" 4
.IX Item "restore_suspended_subscription ( $email )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "restore_users ( \s-1ROLE\s0 )" 4
.IX Item "restore_users ( ROLE )"
Import user information into user store from file \f(CW\*(C`\f(CI$role\f(CW.dump\*(C'\fR under
list directory. \s-1ROLE\s0 may be \f(CW\*(Aqmember\*(Aq\fR, \f(CW\*(Aqowner\*(Aq\fR or \f(CW\*(Aqeditor\*(Aq\fR.
.IP "save_config ( \s-1LIST\s0 )" 4
.IX Item "save_config ( LIST )"
Saves the indicated list object to the disk files.
.ie n .IP "search_list_among_robots ( $listname )" 4
.el .IP "search_list_among_robots ( \f(CW$listname\fR )" 4
.IX Item "search_list_among_robots ( $listname )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.ie n .IP "select_list_members_for_topic ( $topic, \e@emails )" 4
.el .IP "select_list_members_for_topic ( \f(CW$topic\fR, \e@emails )" 4
.IX Item "select_list_members_for_topic ( $topic, @emails )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.ie n .IP "send_notify_to_owner ( $operation, $params )" 4
.el .IP "send_notify_to_owner ( \f(CW$operation\fR, \f(CW$params\fR )" 4
.IX Item "send_notify_to_owner ( $operation, $params )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.ie n .IP "send_probe_to_user ( $type, $who )" 4
.el .IP "send_probe_to_user ( \f(CW$type\fR, \f(CW$who\fR )" 4
.IX Item "send_probe_to_user ( $type, $who )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.ie n .IP "set_status_error_config ( $msg, parameters, ... )" 4
.el .IP "set_status_error_config ( \f(CW$msg\fR, parameters, ... )" 4
.IX Item "set_status_error_config ( $msg, parameters, ... )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.ie n .IP "suspend_subscription ( $email, $list, $data, $robot )" 4
.el .IP "suspend_subscription ( \f(CW$email\fR, \f(CW$list\fR, \f(CW$data\fR, \f(CW$robot\fR )" 4
.IX Item "suspend_subscription ( $email, $list, $data, $robot )"
\&\fIFunction\fR.
\&\s-1FIXME\s0 This should be a instance method.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.ie n .IP "sync_include ( $role, options... )" 4
.el .IP "sync_include ( \f(CW$role\fR, options... )" 4
.IX Item "sync_include ( $role, options... )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 would be obsoleted.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "update_config_changes ( )" 4
.IX Item "update_config_changes ( )"
\&\fIInstance method\fR.
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.IP "update_list_admin ( \s-1USER, ROLE, HASHPTR\s0 )" 4
.IX Item "update_list_admin ( USER, ROLE, HASHPTR )"
Sets the new values given in the hash for the admin user.
.ie n .IP "update_list_member ( $email, key => value, ... )" 4
.el .IP "update_list_member ( \f(CW$email\fR, key => value, ... )" 4
.IX Item "update_list_member ( $email, key => value, ... )"
\&\fIInstance method\fR.
Sets the new values given in the pairs for the user.
.IP "update_stats ( count, [ sent, bytes, sent_by_bytes ] )" 4
.IX Item "update_stats ( count, [ sent, bytes, sent_by_bytes ] )"
Updates the stats, argument is number of bytes, returns list fo the updated
values.  Returns zeroes if failed.
.SS "Functions"
.IX Subsection "Functions"
.ie n .IP "get_lists ( [ $that, [ options, ... ] ] )" 4
.el .IP "get_lists ( [ \f(CW$that\fR, [ options, ... ] ] )" 4
.IX Item "get_lists ( [ $that, [ options, ... ] ] )"
\&\fIFunction\fR.
List of lists hosted by a family, a robot or whole site.
.RS 4
.ie n .IP "$that" 4
.el .IP "\f(CW$that\fR" 4
.IX Item "$that"
Robot, Sympa::Family object or site (default).
.IP "options, ..." 4
.IX Item "options, ..."
Hash including options passed to Sympa::List\->\fBnew()\fR (see \fBload()\fR) and any of
following pairs:
.RS 4
.ie n .IP """\*(Aqfilter\*(Aq => [ KEYS => VALS, ... ]""" 4
.el .IP "\f(CW\*(Aqfilter\*(Aq => [ KEYS => VALS, ... ]\fR" 4
.IX Item "filter => [ KEYS => VALS, ... ]"
Filter with list profiles.  When any of items specified by \s-1KEYS\s0
(separated by \f(CW"|"\fR) have any of values specified by \s-1VALS,\s0
condition by that pair is satisfied.
\&\s-1KEYS\s0 prefixed by \f(CW"!"\fR mean negated condition.
Only lists satisfying all conditions of query are returned.
Currently available keys and values are:
.RS 4
.IP "'creation' => \s-1TIME\s0" 4
.IX Item "'creation' => TIME"
.PD 0
.IP "'creation<' => \s-1TIME\s0" 4
.IX Item "'creation<' => TIME"
.IP "'creation>' => \s-1TIME\s0" 4
.IX Item "'creation>' => TIME"
.PD
Creation date is equal to, earlier than or later than the date (\s-1UNIX\s0 time).
.IP "'member' => \s-1EMAIL\s0" 4
.IX Item "'member' => EMAIL"
.PD 0
.IP "'owner' => \s-1EMAIL\s0" 4
.IX Item "'owner' => EMAIL"
.IP "'editor' => \s-1EMAIL\s0" 4
.IX Item "'editor' => EMAIL"
.PD
Specified user is a subscriber, owner or editor of the list.
.IP "'name' => \s-1STRING\s0" 4
.IX Item "'name' => STRING"
.PD 0
.IP "'name%' => \s-1STRING\s0" 4
.IX Item "'name%' => STRING"
.IP "'%name%' => \s-1STRING\s0" 4
.IX Item "'%name%' => STRING"
.PD
Exact, prefixed or substring match against list name,
case-insensitive.
.ie n .IP "'status' => ""STATUS|...""" 4
.el .IP "'status' => ``STATUS|...''" 4
.IX Item "'status' => STATUS|..."
Status of list.  One of 'open', 'closed', 'pending',
\&'error_config' and 'family_closed'.
.IP "'subject' => \s-1STRING\s0" 4
.IX Item "'subject' => STRING"
.PD 0
.IP "'subject%' => \s-1STRING\s0" 4
.IX Item "'subject%' => STRING"
.IP "'%subject%' => \s-1STRING\s0" 4
.IX Item "'%subject%' => STRING"
.PD
Exact, prefixed or substring match against list subject,
case-insensitive (case folding is Unicode-aware).
.ie n .IP "'topics' => ""TOPIC|...""" 4
.el .IP "'topics' => ``TOPIC|...''" 4
.IX Item "'topics' => TOPIC|..."
Exact match against any of list topics.
\&'others' or 'topicsless' means no topics.
.IP "'update' => \s-1TIME\s0" 4
.IX Item "'update' => TIME"
.PD 0
.IP "'update<' => \s-1TIME\s0" 4
.IX Item "'update<' => TIME"
.IP "'update>' => \s-1TIME\s0" 4
.IX Item "'update>' => TIME"
.PD
Date of last update is equal to, earlier than or later than the date (\s-1UNIX\s0 time).
.RE
.RS 4
.RE
.ie n .IP """\*(Aqlimit\*(Aq => NUMBER """ 4
.el .IP "\f(CW\*(Aqlimit\*(Aq => NUMBER \fR" 4
.IX Item "limit => NUMBER "
Limit the number of results.
\&\f(CW0\fR means no limit (default).
Note that this option may be applied prior to \f(CW\*(Aqorder\*(Aq\fR option.
.ie n .IP """\*(Aqorder\*(Aq => [ KEY, ... ]""" 4
.el .IP "\f(CW\*(Aqorder\*(Aq => [ KEY, ... ]\fR" 4
.IX Item "order => [ KEY, ... ]"
Subordinate sort key(s).  The results are sorted primarily by robot names
then by other key(s).  Keys prefixed by \f(CW"\-"\fR mean descendent ordering.
Available keys are:
.RS 4
.ie n .IP "\*(Aqcreation\*(Aq" 4
.el .IP "\f(CW\*(Aqcreation\*(Aq\fR" 4
.IX Item "creation"
Creation date.
.ie n .IP "\*(Aqname\*(Aq" 4
.el .IP "\f(CW\*(Aqname\*(Aq\fR" 4
.IX Item "name"
List name, case-insensitive.  It is the default.
.ie n .IP "\*(Aqtotal\*(Aq" 4
.el .IP "\f(CW\*(Aqtotal\*(Aq\fR" 4
.IX Item "total"
Estimated number of subscribers.
.ie n .IP "\*(Aqupdate\*(Aq" 4
.el .IP "\f(CW\*(Aqupdate\*(Aq\fR" 4
.IX Item "update"
Date of last update.
.RE
.RS 4
.RE
.RE
.RS 4
.RE
.RE
.RS 4
.Sp
Returns a ref to an array of List objects.
.RE
.IP "get_robots ( )" 4
.IX Item "get_robots ( )"
\&\fIFunction\fR.
List of robots hosted by Sympa.
.IP "get_which ( \s-1EMAIL, ROBOT, ROLE\s0 )" 4
.IX Item "get_which ( EMAIL, ROBOT, ROLE )"
\&\fIFunction\fR.
Get a list of lists where \s-1EMAIL\s0 assumes this \s-1ROLE\s0 (owner, editor or member) of
function to any list in \s-1ROBOT.\s0
.SS "Obsoleted methods"
.IX Subsection "Obsoleted methods"
.IP "add_admin_user ( \s-1USER, ROLE, HASHPTR\s0 )" 4
.IX Item "add_admin_user ( USER, ROLE, HASHPTR )"
\&\s-1DEPRECATED.\s0
Use \fBadd_list_admin()\fR.
.IP "am_i ( \s-1ROLE, USER\s0 )" 4
.IX Item "am_i ( ROLE, USER )"
\&\s-1DEPRECATED.\s0 Use \fBis_admin()\fR.
.IP "archive_exist ( \s-1FILE\s0 )" 4
.IX Item "archive_exist ( FILE )"
\&\s-1DEPRECATED.\s0
Returns true if the indicated file exists.
.IP "archive_ls ()" 4
.IX Item "archive_ls ()"
\&\s-1DEPRECATED.\s0
Returns the list of available files, if any.
.IP "archive_msg ( \s-1MSG\s0 )" 4
.IX Item "archive_msg ( MSG )"
\&\s-1DEPRECATED.\s0
Archives the Mail::Internet message given as argument.
.IP "archive_send ( \s-1WHO, FILE\s0 )" 4
.IX Item "archive_send ( WHO, FILE )"
\&\s-1DEPRECATED.\s0
Send the indicated archive file to the user, if it exists.
.IP "get_db_field_type ( ... )" 4
.IX Item "get_db_field_type ( ... )"
\&\fIInstance method\fR.
Obsoleted.
.IP "get_first_list_admin ( \s-1ROLE\s0 )" 4
.IX Item "get_first_list_admin ( ROLE )"
\&\s-1OBSOLETED.\s0
Use \fBget_admins()\fR.
.IP "get_global_user ( \s-1USER\s0 )" 4
.IX Item "get_global_user ( USER )"
\&\s-1DEPRECATED.\s0
Returns a hash with the information regarding the indicated
user.
.IP "get_latest_distribution_date ( )" 4
.IX Item "get_latest_distribution_date ( )"
\&\fIInstance method\fR.
Gets last date of distribution message .
.IP "get_list_address ( [ \s-1TYPE\s0 ] )" 4
.IX Item "get_list_address ( [ TYPE ] )"
\&\s-1OBSOLETED.\s0
Use \*(L"get_address\*(R" in Sympa.
.Sp
Return the list email address of type \s-1TYPE:\s0 posting address (default),
\&\*(L"owner\*(R", \*(L"editor\*(R" or (non-VERP) \*(L"return_path\*(R".
.IP "get_list_admin ( \s-1ROLE, USER\s0)" 4
.IX Item "get_list_admin ( ROLE, USER)"
Return an admin user of the list with predefined role
.Sp
\&\s-1OBSOLETED.\s0
Use \fBget_admins()\fR.
.IP "get_list_id ( )" 4
.IX Item "get_list_id ( )"
\&\s-1OBSOLETED.\s0
Use \fBget_id()\fR.
.IP "get_next_list_admin ()" 4
.IX Item "get_next_list_admin ()"
\&\s-1OBSOLETED.\s0
Use \fBget_admins()\fR.
.IP "get_state ( \s-1FLAG\s0 )" 4
.IX Item "get_state ( FLAG )"
Deprecated.
Returns the value for a flag : sig or sub.
.IP "may_do ( \s-1ACTION, USER\s0 )" 4
.IX Item "may_do ( ACTION, USER )"
\&\fBNote\fR:
This method was obsoleted.
.Sp
Chcks is \s-1USER\s0 may do the \s-1ACTION\s0 for the list. \s-1ACTION\s0 can be
one of following : send, review, index, getm add, del,
reconfirm, purge.
.ie n .IP "move_message ( $file, $queue )" 4
.el .IP "move_message ( \f(CW$file\fR, \f(CW$queue\fR )" 4
.IX Item "move_message ( $file, $queue )"
\&\s-1DEPRECATED.\s0
No longer used.
.IP "print_info ( \s-1FDNAME\s0 )" 4
.IX Item "print_info ( FDNAME )"
\&\s-1DEPRECATED.\s0
Print the list information to the given file descriptor, or the
currently selected descriptor.
.IP "savestats ()" 4
.IX Item "savestats ()"
\&\fBDeprecated\fR on 6.2.23b.
.Sp
Saves updates the statistics file on disk.
.ie n .IP "send_confirm_to_editor ( $message, $method )" 4
.el .IP "send_confirm_to_editor ( \f(CW$message\fR, \f(CW$method\fR )" 4
.IX Item "send_confirm_to_editor ( $message, $method )"
This method was \s-1DEPRECATED.\s0
.Sp
Send a Sympa::Message object to the editor (for approval).
.Sp
Sends a message to the list editor to ask them for moderation
(in moderation context : editor or editorkey). The message
to moderate is set in moderation spool with name containing
a key (reference send to editor for moderation).
In context of msg_topic defined the editor must tag it
for the moderation (on Web interface).
.Sp
Parameters:
.RS 4
.ie n .IP "$message" 4
.el .IP "\f(CW$message\fR" 4
.IX Item "$message"
Sympa::Message instance \- the message to moderate.
.ie n .IP "$method" 4
.el .IP "\f(CW$method\fR" 4
.IX Item "$method"
\&'md5' \- for \*(L"editorkey\*(R", 'smtp' \- for \*(L"editor\*(R".
.RE
.RS 4
.Sp
Returns:
.Sp
The moderation key for naming message waiting for moderation in moderation spool, or \f(CW\*(C`undef\*(C'\fR.
.RE
.ie n .IP "send_confirm_to_sender ( $message )" 4
.el .IP "send_confirm_to_sender ( \f(CW$message\fR )" 4
.IX Item "send_confirm_to_sender ( $message )"
This method was \s-1DEPRECATED.\s0
.Sp
Sends an authentication request for a sent message to distribute.
The message for distribution is copied in the auth
spool in order to wait for confirmation by its sender.
This message is named with a key.
In context of msg_topic defined, the sender must tag it
for the confirmation
.Sp
Parameter:
.RS 4
.ie n .IP "$message" 4
.el .IP "\f(CW$message\fR" 4
.IX Item "$message"
Sympa::Message instance.
.RE
.RS 4
.Sp
Returns:
.Sp
The key for naming message waiting for confirmation (or tagging) in auth spool, or \f(CW\*(C`undef\*(C'\fR.
.RE
.SS "Attributes"
.IX Subsection "Attributes"
\&\s-1FIXME\s0 \f(CW@todo\fR doc
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sympa.
.SH "HISTORY"
.IX Header "HISTORY"
List module was renamed to Sympa::List module on Sympa 6.2.