.\" 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::Spool::Listmaster 3Sympa"
.TH Sympa::Spool::Listmaster 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::Spool::Listmaster \- Spool on memory for listmaster notification
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Sympa::Spool::Listmaster;
\&    my $alarm = Sympa::Spool::Listmaster\->instance;
\&
\&    $alarm\->store($message, $rcpt, $operation);
\&
\&    $alarm\->flush();
\&    $alarm\->flush(purge => 1);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Sympa::Spool::Listmaster implements on-memory spool for
listmaster notification.
.SS "Methods"
.IX Subsection "Methods"
.IP "instance ( )" 4
.IX Item "instance ( )"
\&\fIConstructor\fR.
Creates a singleton instance of Sympa::Spool::Listmaster object.
.Sp
\&\fINote\fR:
Unlike the other spool classes, the instance of this class is singleton.
.Sp
Returns:
.Sp
A new Sympa::Spool::Listmaster instance, or undef for failure.
.ie n .IP "store ( $message, $rcpt, operation => $operation )" 4
.el .IP "store ( \f(CW$message\fR, \f(CW$rcpt\fR, operation => \f(CW$operation\fR )" 4
.IX Item "store ( $message, $rcpt, operation => $operation )"
\&\fIInstance method\fR.
Stores a message of a operation to spool.
.Sp
Parameters:
.RS 4
.ie n .IP "$message" 4
.el .IP "\f(CW$message\fR" 4
.IX Item "$message"
Sympa::Message object to be stored.
.ie n .IP "$rcpt" 4
.el .IP "\f(CW$rcpt\fR" 4
.IX Item "$rcpt"
Arrayref or scalar.  Recipient of notification.
.ie n .IP "operation => $operation" 4
.el .IP "operation => \f(CW$operation\fR" 4
.IX Item "operation => $operation"
A string specifies tag of the message.
.RE
.RS 4
.Sp
Returns:
.Sp
True value if succeed, otherwise \f(CW\*(C`undef\*(C'\fR.
.RE
.ie n .IP "flush ( [ purge => $purge ] )" 4
.el .IP "flush ( [ purge => \f(CW$purge\fR ] )" 4
.IX Item "flush ( [ purge => $purge ] )"
\&\fIInstance method\fR.
Sends compiled messages in spool.
.Sp
If true value is given as optional argument, all messages in spool will be
sent.
.SS "Attribute"
.IX Subsection "Attribute"
The instance of Sympa::Spool::Listmaster has following attribute.
.IP "{use_bulk}" 4
.IX Item "{use_bulk}"
If set to be true, messages to be sent will be stored into spool
instead of being stored to sendmail.
.Sp
Default is false.
.SH "CAVEAT"
.IX Header "CAVEAT"
Sympa::Spool::Listmaster is not a real subsclass of Sympa::Spool.
.SH "HISTORY"
.IX Header "HISTORY"
Feature to compile notification to listmaster in group appeared on Sympa 6.2.
.PP
Sympa::Alarm appeared on Sympa 6.2.
It was renamed to Sympa::Spool::Listmaster on Sympa 6.2.45b.3.