.\" 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::ESMTP::STARTTLS 3pm"
.TH Net::Server::Mail::ESMTP::STARTTLS 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::ESMTP::STARTTLS \- A module to support the STARTTLS command in Net::Server::Mail::ESMTP
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&   use strict;
\&   use Net::Server::Mail::ESMTP;
\&
\&   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 $esmtp = Net::Server::Mail::ESMTP\->new(
\&            socket => $conn,
\&            SSL_config => {
\&                SSL_cert_file => \*(Aqyour_cert.pem\*(Aq,
\&                SSL_key_file => \*(Aqyour_key.key\*(Aq,
\&                # Any other options taken by IO::Socket::SSL
\&            }
\&       );
\&       
\&       # activate some extensions
\&       $esmtp\->register(\*(AqNet::Server::Mail::ESMTP::STARTTLS\*(Aq);
\&       
\&       # adding optional STARTTLS handler
\&       $esmtp\->set_callback(STARTTLS => \e&tls_started);
\&       $esmtp\->process();
\&       $conn\->close();
\&   }
\&   
\&   sub tls_started {
\&       my ($session) = @_;
\&
\&       # Now, allow authentication
\&       $session\->register(\*(AqNet::Server::Mail::ESMTP::AUTH\*(Aq);
\&   }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module conducts a \s-1TLS\s0 handshake with the client upon receiving
the \s-1STARTTLS\s0 command. It uses IO::Socket::SSL, requiring 1.831+, to
perform the handshake and secure traffic.
.PP
An additional option, SSL_config, is passed to
Net::Server::Mail::ESMTP's constructor. It contains options for
IO::Socket::SSL's constructor. Please refer to IO::Socket::SSL's
perldoc for details.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Please, see Net::Server::Mail
.SH "AUTHOR"
.IX Header "AUTHOR"
This module has been written by Xavier Guimard <x.guimard@free.fr> using libs
written by:
.IP "Mytram <rmytram@gmail.com>" 4
.IX Item "Mytram <rmytram@gmail.com>"
.PD 0
.ie n .IP "Dan Moore ""<dan at moore.cx>""" 4
.el .IP "Dan Moore \f(CW<dan at moore.cx>\fR" 4
.IX Item "Dan Moore <dan at moore.cx>"
.PD
.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 "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
.IP "Copyright (C) 2009 \- Dan Moore <dan at moore.cx>" 4
.IX Item "Copyright (C) 2009 - Dan Moore <dan at moore.cx>"
.PD 0
.IP "Copyright (C) 2013 \- Mytram <rmytram@gmail.com>" 4
.IX Item "Copyright (C) 2013 - Mytram <rmytram@gmail.com>"
.IP "Copyright (C) 2013 \- Xavier Guimard <x.guimard@free.fr>" 4
.IX Item "Copyright (C) 2013 - Xavier Guimard <x.guimard@free.fr>"
.PD
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.