.\" -*- 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 "Mail::MIMEDefang::Mail 3"
.TH Mail::MIMEDefang::Mail 3 2024-03-20 3.4.1 "Mail::MIMEDefang::Mail 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
Mail::MIMEDefang::Mail \- Mail and SMTP related methods for email filters
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mail::MIMEDefang::Mail are a set of methods that can be called
from \fImimedefang-filter\fR to send email messages or to run SMTP checks.
.SH METHODS
.IX Header "METHODS"
.IP resend_message_one_recipient 4
.IX Item "resend_message_one_recipient"
Method that re-sends the message as if it came from original sender to
a single recipient.
.IP resend_message_specifying_mode 4
.IX Item "resend_message_specifying_mode"
Method that re-sends the message as if it came from original sender to
a list of recipients.
.IP resend_message 4
.IX Item "resend_message"
Method that re-sends the message as if it came from original sender to
a list of recipients.
.IP pretty_print_mail 4
.IX Item "pretty_print_mail"
Method that makes a pretty-printed version of the e\-mail body no longer
than size characters.
.IP get_smtp_return_code 4
.IX Item "get_smtp_return_code"
Method that reads return codes from SMTP server, returns a four-element
list:(retval, code, dsn, text), where code is a 3\-digit SMTP code.
Retval is 'CONTINUE', 'TEMPFAIL' or 'REJECT'.
.IP get_smtp_extensions 4
.IX Item "get_smtp_extensions"
Method that checks SMTP server's supported extensions.
It expects EHLO to have been sent already (artifact of get_smtp_return_code).
The sub returns a four-element list:(retval, code, dsn, exts)
.RS 4
.IP \(bu 4
retval is 'CONTINUE', 'TEMPFAIL', or 'REJECT'.
.IP \(bu 4
code is a 3\-digit SMTP code.
.IP \(bu 4
dsn is an extended SMTP status code
.IP \(bu 4
exts is a hash of EXTNAME\->EXTOPTS
.RE
.RS 4
.RE
.IP md_check_against_smtp_server 4
.IX Item "md_check_against_smtp_server"
Method that verifies a recipient against another SMTP server by issuing a
HELO / MAIL FROM: / RCPT TO: / QUIT sequence.
The method returns:
.RS 4
.IP \(bu 4
('CONTINUE', "OK") if recipient is OK
.IP \(bu 4
('TEMPFAIL', "err") if temporary failure
.IP \(bu 4
('REJECT', "err") if recipient is not OK.
.RE
.RS 4
.RE