.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "Email::Sender::Transport::Test 3pm"
.TH Email::Sender::Transport::Test 3pm 2024-01-20 "perl v5.38.2" "User Contributed Perl Documentation"
.\" 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
Email::Sender::Transport::Test \- deliver mail in memory for testing
.SH VERSION
.IX Header "VERSION"
version 2.601
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This transport is meant for testing email deliveries in memory.  It will store
a record of any delivery made so that they can be inspected afterward.
.SH "PERL VERSION"
.IX Header "PERL VERSION"
This library should run on perls released even a long time ago.  It should
work on any version of perl released in the last five years.
.PP
Although it may work on older versions of perl, no guarantee is made that the
minimum required version will not be increased.  The version may be increased
for any reason, and there is no promise that patches will be accepted to
lower the minimum required perl.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
.SS deliveries
.IX Subsection "deliveries"
By default, the Test transport will not allow partial success and will always
succeed.  It can be made to fail predictably, however, if it is extended and
its \f(CW\*(C`recipient_failure\*(C'\fR or \f(CW\*(C`delivery_failure\*(C'\fR methods are overridden.  These
methods are called as follows:
.PP
.Vb 1
\&  $self\->delivery_failure($email, $envelope);
\&
\&  $self\->recipient_failure($to);
.Ve
.PP
If they return true, the sending will fail.  If the transport was created with
a true \f(CW\*(C`allow_partial_success\*(C'\fR attribute, recipient failures can cause partial
success to be returned.
.PP
For more flexible failure modes, you can override more aggressively or can use
Email::Sender::Transport::Failable.
.PP
This attribute stores an arrayref of all the deliveries made via the transport.
The \f(CW\*(C`clear_deliveries\*(C'\fR method returns a list of them.
.PP
Each delivery is a hashref, in the following format:
.PP
.Vb 6
\&  {
\&    email     => $email,
\&    envelope  => $envelope,
\&    successes => \e@ok_rcpts,
\&    failures  => \e@failures,
\&  }
.Ve
.PP
Both successful and failed deliveries are stored.
.PP
A number of methods related to this attribute are provided:
.IP \(bu 4
delivery_count
.IP \(bu 4
clear_deliveries
.IP \(bu 4
shift_deliveries
.SH AUTHOR
.IX Header "AUTHOR"
Ricardo Signes <cpan@semiotic.systems>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2024 by Ricardo Signes.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.