.\" 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::Aliases 3Sympa"
.TH Sympa::Aliases 3Sympa "2020-12-30" "6.2.58" "sympa 6.2.58"
.\" 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::Aliases \- Base class for alias management
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  package Sympa::Aliases::FOO;
\&  
\&  use base qw(Sympa::Aliases);
\&  
\&  sub check { ... }
\&  sub add { ... }
\&  sub del { ... }
\&  
\&  1;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is the base class for subclasses to manage list aliases of Sympa.
.SS "Methods"
.IX Subsection "Methods"
.ie n .IP "new ( $type, [ key => value, ... ] )" 4
.el .IP "new ( \f(CW$type\fR, [ key => value, ... ] )" 4
.IX Item "new ( $type, [ key => value, ... ] )"
\&\fIConstructor\fR.
Creates new instance of Sympa::Aliases.
.Sp
Returns one of appropriate subclasses according to \f(CW$type:\fR
.RS 4
.ie n .IP "\*(Aqnone\*(Aq" 4
.el .IP "\f(CW\*(Aqnone\*(Aq\fR" 4
.IX Item "none"
No aliases management.
.IP "Full path to executable" 4
.IX Item "Full path to executable"
Use external program to manage aliases.
See Sympa::Aliases::External.
.IP "Name of subclass" 4
.IX Item "Name of subclass"
Use a subclass \f(CW\*(C`Sympa::Aliases::\f(CIname\f(CW\*(C'\fR to manage aliases.
.RE
.RS 4
.Sp
For invalid types returns \f(CW\*(C`undef\*(C'\fR.
.Sp
Optional \f(CW\*(C`\f(CIkey\f(CW => \f(CIvalue\f(CW\*(C'\fR pairs are included in the instance as
hash entries.
.RE
.ie n .IP "check ($listname, $robot_id)" 4
.el .IP "check ($listname, \f(CW$robot_id\fR)" 4
.IX Item "check ($listname, $robot_id)"
\&\fIInstance method\fR, \fIoverridable\fR.
Checks if the addresses of requested list exist already.
.Sp
Parameters:
.RS 4
.ie n .IP "$listname" 4
.el .IP "\f(CW$listname\fR" 4
.IX Item "$listname"
Name of the list.
Mandatory.
.ie n .IP "$robot_id" 4
.el .IP "\f(CW$robot_id\fR" 4
.IX Item "$robot_id"
List's robot.
.RE
.RS 4
.Sp
Returns:
.Sp
True value if one of addresses exists.
\&\f(CW0\fR if none found.
\&\f(CW\*(C`undef\*(C'\fR if something wrong happened.
.Sp
By default, this method always returns \f(CW0\fR.
.RE
.IP "add ($list)" 4
.IX Item "add ($list)"
\&\fIInstance method\fR, \fIoverridable\fR.
Installs aliases for the list \f(CW$list\fR.
.Sp
Parameters:
.RS 4
.ie n .IP "$list" 4
.el .IP "\f(CW$list\fR" 4
.IX Item "$list"
An instance of Sympa::List.
.RE
.RS 4
.Sp
Returns:
.Sp
\&\f(CW1\fR if installation succeeded.
\&\f(CW0\fR if there were no aliases to be installed.
\&\f(CW\*(C`undef\*(C'\fR if not applicable.
.Sp
By default, this method always returns \f(CW0\fR.
.RE
.IP "del ($list)" 4
.IX Item "del ($list)"
\&\fIInstance method\fR, \fIoverridable\fR.
Removes aliases for the list \f(CW$list\fR.
.Sp
Parameters:
.RS 4
.ie n .IP "$list" 4
.el .IP "\f(CW$list\fR" 4
.IX Item "$list"
An instance of Sympa::List.
.RE
.RS 4
.Sp
Returns:
.Sp
\&\f(CW1\fR if removal succeeded.
\&\f(CW0\fR if there were no aliases to be removed.
\&\f(CW\*(C`undef\*(C'\fR if not applicable.
.Sp
By default, this method always returns \f(CW0\fR.
.RE
.SS "Function"
.IX Subsection "Function"
.ie n .IP "check_new_listname ( $listname, $robot )" 4
.el .IP "check_new_listname ( \f(CW$listname\fR, \f(CW$robot\fR )" 4
.IX Item "check_new_listname ( $listname, $robot )"
\&\fIFunction\fR.
Checks if a new listname is allowed.
.Sp
\&\s-1TBD.\s0
.Sp
Parameteres:
.RS 4
.ie n .IP "$listname" 4
.el .IP "\f(CW$listname\fR" 4
.IX Item "$listname"
A list name to be checked.
.ie n .IP "$robot" 4
.el .IP "\f(CW$robot\fR" 4
.IX Item "$robot"
Robot context.
.RE
.RS 4
.Sp
Returns:
.Sp
If check fails, an array including information of errors.
If it succeeds, empty array.
.Sp
\&\fBNote\fR:
This should be used to check name of list to be created.
Names of existing lists may not necessarily pass checks by this function.
.Sp
This function was added on Sympa 6.2.37b.2.
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sympa::Aliases::CheckSMTP,
Sympa::Aliases::External,
Sympa::Aliases::Template.
.SH "HISTORY"
.IX Header "HISTORY"
\&\fIalias_manager.pl\fR as a program to automate alias management appeared on
Sympa 3.1b.13.
.PP
Sympa::Aliases module as an OO-based class appeared on Sympa 6.2.23b,
and it obsoleted \fIalias_manager.pl\fR.