.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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::Moderation 3Sympa"
.TH Sympa::Spool::Moderation 3Sympa "2023-01-26" "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::Moderation \- Spool for held messages waiting for moderation
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Sympa::Spool::Moderation;
\&
\&  my $spool = Sympa::Spool::Moderation\->new;
\&  my $modkey = $spool\->store($message);
\&
\&  my $spool =
\&      Sympa::Spool::Moderation\->new(context => $list, authkey => $modkey);
\&  my ($message, $handle) = $spool\->next;
\&
\&  $spool\->remove($handle, action => \*(Aqdistribute\*(Aq);
\&  $spool\->remove($handle);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Sympa::Spool::Moderation implements the spool for held messages waiting
for moderation.
.SS "Methods"
.IX Subsection "Methods"
See also \*(L"Public methods\*(R" in Sympa::Spool.
.ie n .IP "new ( [ context => $list ], [ authkey => $modkey ] )" 4
.el .IP "new ( [ context => \f(CW$list\fR ], [ authkey => \f(CW$modkey\fR ] )" 4
.IX Item "new ( [ context => $list ], [ authkey => $modkey ] )"
.PD 0
.IP "next ( [ no_lock => 1 ] )" 4
.IX Item "next ( [ no_lock => 1 ] )"
.PD
If the pairs describing metadatas are specified,
contents returned by \fBnext()\fR are filtered by them.
.IP "quarantine ( )" 4
.IX Item "quarantine ( )"
Does nothing.
.ie n .IP "remove ( $handle, [ action => 'distribute' ] )" 4
.el .IP "remove ( \f(CW$handle\fR, [ action => 'distribute' ] )" 4
.IX Item "remove ( $handle, [ action => 'distribute' ] )"
If action is specified, rename message file to add it as extension, instead of
removing message file.
Otherwise, removes message file.
.IP "size ( )" 4
.IX Item "size ( )"
Returns number of messages in the spool except which have extension.
.ie n .IP "store ( $message, [ original => $original ] )" 4
.el .IP "store ( \f(CW$message\fR, [ original => \f(CW$original\fR ] )" 4
.IX Item "store ( $message, [ original => $original ] )"
If storing succeeded, returns moderation key.
.SS "Methods specific to this module"
.IX Subsection "Methods specific to this module"
.ie n .IP "html_remove ( $metadata )" 4
.el .IP "html_remove ( \f(CW$metadata\fR )" 4
.IX Item "html_remove ( $metadata )"
\&\fIInstance method\fR.
\&\s-1TBD.\s0
.Sp
Parameters:
.RS 4
.ie n .IP "$metadata" 4
.el .IP "\f(CW$metadata\fR" 4
.IX Item "$metadata"
Hashref or message containing metadata.
At least \f(CW\*(C`context\*(C'\fR and \f(CW\*(C`authkey\*(C'\fR are required.
.RE
.RS 4
.Sp
Returns:
.Sp
None.
.RE
.ie n .IP "html_store ( $message, $modkey )" 4
.el .IP "html_store ( \f(CW$message\fR, \f(CW$modkey\fR )" 4
.IX Item "html_store ( $message, $modkey )"
\&\fIInstance method\fR.
Caches \s-1HTML\s0 view of message.
.Sp
Parameters:
.RS 4
.ie n .IP "$message" 4
.el .IP "\f(CW$message\fR" 4
.IX Item "$message"
Message to be stored.
.ie n .IP "$modkey" 4
.el .IP "\f(CW$modkey\fR" 4
.IX Item "$modkey"
Moderation key.
.RE
.RS 4
.Sp
Returns:
.Sp
None.
.RE
.SS "Context and metadata"
.IX Subsection "Context and metadata"
See also \*(L"Marshaling and unmarshaling metadata\*(R" in Sympa::Spool.
.PP
This class particularly gives following metadata:
.IP "{authkey}" 4
.IX Item "{authkey}"
Moderation key generated automatically
when the message is stored into spool.
.IP "{validated}" 4
.IX Item "{validated}"
Keeps a string representing extension, if message has been renamed using
\&\fBremove()\fR with option.
.SH "CONFIGURATION PARAMETERS"
.IX Header "CONFIGURATION PARAMETERS"
Following site configuration parameters in sympa.conf will be referred.
.IP "queuemod" 4
.IX Item "queuemod"
Directory path of moderation spool.
.IP "viewmail_dir" 4
.IX Item "viewmail_dir"
Root directory path of directories where \s-1HTML\s0 view of messages are cached.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBsympa_msg\fR\|(8), \fBwwsympa\fR\|(8),
Sympa::Message, Sympa::Spool.
.SH "HISTORY"
.IX Header "HISTORY"
Sympa::Spool::Moderation appeared on Sympa 6.2.8.