.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "Net::Server::Mail::SMTP 3pm"
.TH Net::Server::Mail::SMTP 3pm "2019-08-17" "perl v5.28.1" "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"
Net::Server::Mail::SMTP \- A module to implement the SMTP protocol
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Net::Server::Mail::SMTP;
\&
\&    my @local_domains = qw(example.com example.org);
\&    my $server = IO::Socket::INET\->new( Listen => 1, LocalPort => 25 );
\&
\&    my $conn;
\&    while($conn = $server\->accept)
\&    {
\&        my $smtp = Net::Server::Mail::SMTP\->new( socket => $conn );
\&        $smtp\->set_callback(RCPT => \e&validate_recipient);
\&        $smtp\->set_callback(DATA => \e&queue_message);
\&        $smtp\->process();
\&        $conn\->close();
\&    }
\&
\&    sub validate_recipient
\&    {
\&        my($session, $recipient) = @_;
\&
\&        my $domain;
\&        if($recipient =~ /\e@(.*)>\es*$/)
\&        {
\&            $domain = $1;
\&        }
\&
\&        if(not defined $domain)
\&        {
\&            return(0, 513, \*(AqSyntax error.\*(Aq);
\&        }
\&        elsif(not(grep $domain eq $_, @local_domains))
\&        {
\&            return(0, 554, "$recipient: Recipient address rejected: Relay access denied");
\&        }
\&
\&        return(1);
\&    }
\&
\&    sub queue_message
\&    {
\&        my($session, $data) = @_;
\&
\&        my $sender = $session\->get_sender();
\&        my @recipients = $session\->get_recipients();
\&
\&        return(0, 554, \*(AqError: no valid recipients\*(Aq)
\&            unless(@recipients);
\&
\&        my $msgid = add_queue($sender, \e@recipients, $data)
\&          or return(0);
\&
\&        return(1, 250, "message queued $msgid");
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class implement the \s-1SMTP\s0 (\s-1RFC 821\s0) protocol. Notice that it don't
implement the extension mechanism introduce in \s-1RFC 2821.\s0 You have to
use Net::Server::Mail::ESMTP if you want this capability.
.PP
This class inherit from Net::Server::Mail. Please see
Net::Server::Mail for documentation of common methods.
.SH "METHODS"
.IX Header "METHODS"
\&\s-1SMTP\s0 specific methods.
.SS "get_sender"
.IX Subsection "get_sender"
Returns the sender of the current session. Return undefined if the
reverse path step is not complete.
.SS "get_recipients"
.IX Subsection "get_recipients"
Returns the list of recipients supplied by client. Returns undef if
forward_path step is not engaged. Returns an empty list if not
recipients succeed.
.SH "EVENTS"
.IX Header "EVENTS"
Descriptions of callback who's can be used with set_callback
method. All handle takes the Net::Server::Mail::SMTP object as first
argument and specific callback's arguments.
.SS "\s-1HELO\s0"
.IX Subsection "HELO"
Takes the hostname given as argument. Engage the reverse path step on
success.
.PP
.Vb 3
\&    sub helo_handle
\&    {
\&        my($session, $hostname) = @_;
\&
\&        if($hostname eq \*(Aqlocalhost\*(Aq)
\&        {
\&            return(0, 553, q(I don\*(Aqt like this hostname, try again.));
\&        }
\&
\&        # don\*(Aqt forgot to return a success reply if you are happy with
\&        # command\*(Aqs value
\&        return 1;
\&    }
.Ve
.SS "\s-1NOOP\s0"
.IX Subsection "NOOP"
This handler takes no argument
.SS "\s-1EXPN\s0"
.IX Subsection "EXPN"
Command not yet implemented.
.PP
Handler takes address as argument.
.SS "\s-1EXPN\s0"
.IX Subsection "EXPN"
Command not implemented, deprecated by \s-1RFC 2821\s0
.PP
Handler takes no argument.
.SS "\s-1VRFY\s0"
.IX Subsection "VRFY"
Command not yet implemented.
.PP
Handler takes address as argument.
.SS "\s-1HELP\s0"
.IX Subsection "HELP"
Command not yet implemented.
.PP
Handler takes a command name as argument.
.SS "\s-1MAIL\s0"
.IX Subsection "MAIL"
Handler takes address as argument. On success, engage the forward path
step and keep the given address for later use (get it with
\&\fBget_sender()\fR method).
.SS "\s-1RCPT\s0"
.IX Subsection "RCPT"
Handler takes address as argument. On success, engage the mail data path step and
push the given address into the recipient list for later use (get it
with \fBget_recipients()\fR method).
.SS "\s-1SEND\s0"
.IX Subsection "SEND"
Command not implemented.
.PP
Handler takes no argument.
.SS "\s-1SOML\s0"
.IX Subsection "SOML"
Command not implemented.
.PP
Handler takes no argument.
.SS "\s-1SAML\s0"
.IX Subsection "SAML"
Command not implemented.
.PP
Handler takes no argument.
.SS "\s-1DATA\s0"
.IX Subsection "DATA"
This handler is called after the final . sent by client. It takes data
as argument in a scalar reference. You should queue the message and
reply with the queue \s-1ID.\s0
.SS "DATA-INIT"
.IX Subsection "DATA-INIT"
This handler is called before enter in the \*(L"waiting for data\*(R" step. The
default success reply is a 354 code telling the client to send the
mail content.
.SS "DATA-PART"
.IX Subsection "DATA-PART"
This handler is called at each parts of mail content sent. It takes as
argument a scalar reference to the part of data received. It is
deprecated to change the contents of this scalar.
.SS "\s-1RSET\s0"
.IX Subsection "RSET"
Handler takes no argument.
.PP
On success, all step are initialized and sender/recipients list are
flushed.
.SS "\s-1QUIT\s0"
.IX Subsection "QUIT"
Handler takes no argument.
.PP
Connection is closed after this command. This behavior may change in
future, you will probably be able to control the closing of
connection.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Please, see Net::Server::Mail, Net::Server::Mail::ESMTP
and Net::Server::Mail::LMTP.
.SH "AUTHOR"
.IX Header "AUTHOR"
Olivier Poitrey <rs@rhapsodyk.net>
.SH "AVAILABILITY"
.IX Header "AVAILABILITY"
Available on \s-1CPAN.\s0
.PP
anonymous Git repository:
.PP
git clone git://github.com/rs/net\-server\-mail.git
.PP
Git repository on the web:
.PP
<https://github.com/rs/net\-server\-mail>
.SH "BUGS"
.IX Header "BUGS"
Please use \s-1CPAN\s0 system to report a bug (http://rt.cpan.org/).
.SH "LICENCE"
.IX Header "LICENCE"
This library is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
.PP
This library is distributed in the hope that it will be useful, but
\&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the \s-1GNU\s0
Lesser General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA 02111\-1307
USA\s0
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2002 \- Olivier Poitrey, 2007 \- Xavier Guimard