.\" 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::Spindle::ProcessAuth 3Sympa"
.TH Sympa::Spindle::ProcessAuth 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::Spindle::ProcessAuth \- Workflow of request confirmation
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Sympa::Spindle::ProcessAuth;
\&
\&  my $spindle = Sympa::Spindle::ProcessAuth\->new(
\&      confirmed_by => $email, context => $robot, keyauth => $key,
\&      scenario_context => {sender => $sender});
\&  $spindle\->spin;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Sympa::Spindle::ProcessAuth defines workflow for confirmation of held
requests.
.PP
When \fBspin()\fR method is invoked, it reads a request in held request spool,
authorizes and dispatch it or remove it if possible.
Either authorization and dispatching failed or not, \fBspin()\fR will terminate
processing.
Failed request will be kept in spool and wait for confirmation again.
.SS "Public methods"
.IX Subsection "Public methods"
See also \*(L"Public methods\*(R" in Sympa::Spindle.
.ie n .IP "new ( confirmed_by => $email | canceled_by => $email, context => $context, keyauth => $key, [ quiet => 1 ], scenario_context => {context...} )" 4
.el .IP "new ( confirmed_by => \f(CW$email\fR | canceled_by => \f(CW$email\fR, context => \f(CW$context\fR, keyauth => \f(CW$key\fR, [ quiet => 1 ], scenario_context => {context...} )" 4
.IX Item "new ( confirmed_by => $email | canceled_by => $email, context => $context, keyauth => $key, [ quiet => 1 ], scenario_context => {context...} )"
.PD 0
.IP "spin ( )" 4
.IX Item "spin ( )"
.PD
\&\fBnew()\fR must take following options:
.RS 4
.ie n .IP "confirmed_by => $email | canceled_by => $email" 4
.el .IP "confirmed_by => \f(CW$email\fR | canceled_by => \f(CW$email\fR" 4
.IX Item "confirmed_by => $email | canceled_by => $email"
E\-mail address of the user who confirmed or canceled the request.
Confirming address is given by \s-1AUTH\s0 command and
used by Sympa::Spindle::AuthorizeRequest to execute scenario.
.Sp
N.B. The key is spelled \f(CW\*(C`cenceled_by\*(C'\fR, not \f(CW\*(C`cancelled_by\*(C'\fR.
.ie n .IP "context => $context" 4
.el .IP "context => \f(CW$context\fR" 4
.IX Item "context => $context"
.PD 0
.ie n .IP "keyauth => $key" 4
.el .IP "keyauth => \f(CW$key\fR" 4
.IX Item "keyauth => $key"
.PD
Context (List or Robot) and authorization key to specify the request in
spool.
.IP "quiet => 1" 4
.IX Item "quiet => 1"
If this option is set, automatic replies reporting result of processing
to the user (see \*(L"confirmed_by\*(R") will not be sent.
.IP "scenario_context => {context...}" 4
.IX Item "scenario_context => {context...}"
Authorization context given to scenario.
.RE
.RS 4
.RE
.SS "Properties"
.IX Subsection "Properties"
See also \*(L"Properties\*(R" in Sympa::Spindle.
.IP "{distaff}" 4
.IX Item "{distaff}"
Instance of Sympa::Spool::Auth class.
.IP "{finish}" 4
.IX Item "{finish}"
\&\f(CW\*(Aqsuccess\*(Aq\fR is set if processing succeeded.
\&\f(CW\*(Aqfailure\*(Aq\fR is set if processing failed.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sympa::Request,
Sympa::Spindle, Sympa::Spindle::AuthorizeRequest,
Sympa::Spool::Auth.
.SH "HISTORY"
.IX Header "HISTORY"
Sympa::Spindle::ProcessAuth appeared on Sympa 6.2.15.
.PP
\&\f(CW\*(C`canceled_by\*(C'\fR option was added on Sympa 6.2.19b.