.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" 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 turned on, 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 "Mail::Transport::SMTP 3pm" .TH Mail::Transport::SMTP 3pm "2014-08-24" "perl v5.20.0" "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" Mail::Transport::SMTP \- transmit messages without external program .SH "INHERITANCE" .IX Header "INHERITANCE" .Vb 4 \& Mail::Transport::SMTP \& is a Mail::Transport::Send \& is a Mail::Transport \& is a Mail::Reporter .Ve .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& my $sender = Mail::Transport::SMTP\->new(...); \& $sender\->send($message); \& \& $message\->send(via => \*(Aqsmtp\*(Aq); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module implements transport of \f(CW\*(C`Mail::Message\*(C'\fR objects by negotiating to the destination host directly by using the \s-1SMTP\s0 protocol, without help of \&\f(CW\*(C`sendmail\*(C'\fR, \f(CW\*(C`mail\*(C'\fR, or other programs on the local host. .PP \&\fBwarning:\fR you may need to install Net::SMTPS, to get \s-1TLS\s0 support. .PP Extends \*(L"\s-1DESCRIPTION\*(R"\s0 in Mail::Transport::Send. .SH "METHODS" .IX Header "METHODS" Extends \*(L"\s-1METHODS\*(R"\s0 in Mail::Transport::Send. .SS "Constructors" .IX Subsection "Constructors" Extends \*(L"Constructors\*(R" in Mail::Transport::Send. .IP "Mail::Transport::SMTP\->\fBnew\fR(%options)" 4 .IX Item "Mail::Transport::SMTP->new(%options)" .Vb 10 \& \-Option \-\-Defined in \-\-Default \& esmtp_options {} \& executable Mail::Transport undef \& from undef \& helo \& hostname Mail::Transport \& interval Mail::Transport 30 \& log Mail::Reporter \*(AqWARNINGS\*(Aq \& password undef \& port Mail::Transport 25 \& proxy Mail::Transport \& retry Mail::Transport \& smtp_debug \& timeout 120 \& trace Mail::Reporter \*(AqWARNINGS\*(Aq \& username undef \& via Mail::Transport \*(Aqsmtp\*(Aq .Ve .RS 4 .IP "esmtp_options => \s-1HASH\s0" 2 .IX Item "esmtp_options => HASH" [2.116] \s-1ESMTP\s0 options to pass to Net::SMTP. See the Net::SMTP documentation for full details. Options can also be passed at send time. For example: \f(CW\*(C`{ XVERP => 1 }\*(C'\fR .IP "executable => \s-1FILENAME\s0" 2 .IX Item "executable => FILENAME" .PD 0 .IP "from => \s-1ADDRESS\s0" 2 .IX Item "from => ADDRESS" .PD Allows a default sender address to be specified globally. See \fItrySend()\fR for full details. .IP "helo => \s-1HOST\s0" 2 .IX Item "helo => HOST" The fully qualified name of the sender's host (your system) which is used for the greeting message to the receiver. If not specified, Net::Config or else Net::Domain are questioned to find it. When even these do not supply a valid name, the name of the domain in the \&\f(CW\*(C`From\*(C'\fR line of the message is assumed. .IP "hostname => HOSTNAME|ARRAY" 2 .IX Item "hostname => HOSTNAME|ARRAY" .PD 0 .IP "interval => \s-1SECONDS\s0" 2 .IX Item "interval => SECONDS" .IP "log => \s-1LEVEL\s0" 2 .IX Item "log => LEVEL" .IP "password => \s-1STRING\s0" 2 .IX Item "password => STRING" .PD The password to be used with the new(username) to log in to the remote server. .IP "port => \s-1INTEGER\s0" 2 .IX Item "port => INTEGER" .PD 0 .IP "proxy => \s-1PATH\s0" 2 .IX Item "proxy => PATH" .IP "retry => NUMBER|undef" 2 .IX Item "retry => NUMBER|undef" .IP "smtp_debug => \s-1BOOLEAN\s0" 2 .IX Item "smtp_debug => BOOLEAN" .PD Simulate transmission: the \s-1SMTP\s0 protocol output will be sent to your screen. .IP "timeout => \s-1SECONDS\s0" 2 .IX Item "timeout => SECONDS" The number of seconds to wait for a valid response from the server before failing. .IP "trace => \s-1LEVEL\s0" 2 .IX Item "trace => LEVEL" .PD 0 .IP "username => \s-1STRING\s0" 2 .IX Item "username => STRING" .PD Use \s-1SASL\s0 authentication to contact the remote \s-1SMTP\s0 server (\s-1RFC2554\s0). This username in combination with new(password) is passed as arguments to Net::SMTP method auth. Other forms of authentication are not supported by Net::SMTP. The \f(CW\*(C`username\*(C'\fR can also be specified as an Authen::SASL object. .IP "via => CLASS|NAME" 2 .IX Item "via => CLASS|NAME" .RE .RS 4 .RE .SS "Sending mail" .IX Subsection "Sending mail" Extends \*(L"Sending mail\*(R" in Mail::Transport::Send. .ie n .IP "$obj\->\fBdestinations\fR( $message, [$address|ARRAY] )" 4 .el .IP "\f(CW$obj\fR\->\fBdestinations\fR( \f(CW$message\fR, [$address|ARRAY] )" 4 .IX Item "$obj->destinations( $message, [$address|ARRAY] )" Inherited, see \*(L"Sending mail\*(R" in Mail::Transport::Send .ie n .IP "$obj\->\fBputContent\fR($message, $fh, %options)" 4 .el .IP "\f(CW$obj\fR\->\fBputContent\fR($message, \f(CW$fh\fR, \f(CW%options\fR)" 4 .IX Item "$obj->putContent($message, $fh, %options)" Inherited, see \*(L"Sending mail\*(R" in Mail::Transport::Send .ie n .IP "$obj\->\fBsend\fR($message, %options)" 4 .el .IP "\f(CW$obj\fR\->\fBsend\fR($message, \f(CW%options\fR)" 4 .IX Item "$obj->send($message, %options)" Inherited, see \*(L"Sending mail\*(R" in Mail::Transport::Send .ie n .IP "$obj\->\fBtrySend\fR($message, %options)" 4 .el .IP "\f(CW$obj\fR\->\fBtrySend\fR($message, \f(CW%options\fR)" 4 .IX Item "$obj->trySend($message, %options)" Try to send the \f(CW$message\fR once. This may fail, in which case this method will return \f(CW\*(C`false\*(C'\fR. In list context, the reason for failure can be caught: in list context \f(CW\*(C`trySend\*(C'\fR will return a list of five values: .Sp .Vb 1 \& (success, error code, error text, error location, quit success) .Ve .Sp Success and quit success are booleans. The error code and \-text are protocol specific codes and texts. The location tells where the problem occurred. .Sp .Vb 4 \& \-Option \-\-Default \& esmtp_options {} \& from < > \& to [] .Ve .RS 4 .IP "esmtp_options => \s-1HASH\s0" 2 .IX Item "esmtp_options => HASH" Additional or overridden \s-1EMSTP\s0 options. See new(esmtp_options) .IP "from => \s-1ADDRESS\s0" 2 .IX Item "from => ADDRESS" Your own identification. This may be fake. If not specified, it is taken from \fIMail::Message::sender()\fR, which means the content of the \&\f(CW\*(C`Sender\*(C'\fR field of the message or the first address of the \f(CW\*(C`From\*(C'\fR field. This defaults to \*(L"< >\*(R", which represents \*(L"no address\*(R". .IP "to => ADDRESS|[\s-1ADDRESSES\s0]" 2 .IX Item "to => ADDRESS|[ADDRESSES]" Alternative destinations. If not specified, the \f(CW\*(C`To\*(C'\fR, \f(CW\*(C`Cc\*(C'\fR and \f(CW\*(C`Bcc\*(C'\fR fields of the header are used. An address is a string or a Mail::Address object. .RE .RS 4 .RE .SS "Server connection" .IX Subsection "Server connection" Extends \*(L"Server connection\*(R" in Mail::Transport::Send. .ie n .IP "$obj\->\fBcontactAnyServer\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBcontactAnyServer\fR()" 4 .IX Item "$obj->contactAnyServer()" Creates the connection to the \s-1SMTP\s0 server. When more than one hostname was specified, the first which accepts a connection is taken. An IO::Socket::INET object is returned. .ie n .IP "$obj\->\fBfindBinary\fR( $name, [@directories] )" 4 .el .IP "\f(CW$obj\fR\->\fBfindBinary\fR( \f(CW$name\fR, [@directories] )" 4 .IX Item "$obj->findBinary( $name, [@directories] )" Inherited, see \*(L"Server connection\*(R" in Mail::Transport .ie n .IP "$obj\->\fBremoteHost\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBremoteHost\fR()" 4 .IX Item "$obj->remoteHost()" Inherited, see \*(L"Server connection\*(R" in Mail::Transport .ie n .IP "$obj\->\fBretry\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBretry\fR()" 4 .IX Item "$obj->retry()" Inherited, see \*(L"Server connection\*(R" in Mail::Transport .ie n .IP "$obj\->\fBtryConnectTo\fR($host, %options)" 4 .el .IP "\f(CW$obj\fR\->\fBtryConnectTo\fR($host, \f(CW%options\fR)" 4 .IX Item "$obj->tryConnectTo($host, %options)" Try to establish a connection to deliver \s-1SMTP\s0 to the specified \f(CW$host\fR. The \&\f(CW%options\fR are passed to the \f(CW\*(C`new\*(C'\fR method of Net::SMTP. .SS "Error handling" .IX Subsection "Error handling" Extends \*(L"Error handling\*(R" in Mail::Transport::Send. .ie n .IP "$obj\->\fB\s-1AUTOLOAD\s0\fR()" 4 .el .IP "\f(CW$obj\fR\->\fB\s-1AUTOLOAD\s0\fR()" 4 .IX Item "$obj->AUTOLOAD()" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBaddReport\fR($object)" 4 .el .IP "\f(CW$obj\fR\->\fBaddReport\fR($object)" 4 .IX Item "$obj->addReport($object)" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBdefaultTrace\fR( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" 4 .el .IP "\f(CW$obj\fR\->\fBdefaultTrace\fR( [$level]|[$loglevel, \f(CW$tracelevel\fR]|[$level, \f(CW$callback\fR] )" 4 .IX Item "$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" .PD 0 .ie n .IP "Mail::Transport::SMTP\->\fBdefaultTrace\fR( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" 4 .el .IP "Mail::Transport::SMTP\->\fBdefaultTrace\fR( [$level]|[$loglevel, \f(CW$tracelevel\fR]|[$level, \f(CW$callback\fR] )" 4 .IX Item "Mail::Transport::SMTP->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" .PD Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBerrors\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBerrors\fR()" 4 .IX Item "$obj->errors()" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBlog\fR( [$level, [$strings]] )" 4 .el .IP "\f(CW$obj\fR\->\fBlog\fR( [$level, [$strings]] )" 4 .IX Item "$obj->log( [$level, [$strings]] )" .PD 0 .IP "Mail::Transport::SMTP\->\fBlog\fR( [$level, [$strings]] )" 4 .IX Item "Mail::Transport::SMTP->log( [$level, [$strings]] )" .PD Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBlogPriority\fR($level)" 4 .el .IP "\f(CW$obj\fR\->\fBlogPriority\fR($level)" 4 .IX Item "$obj->logPriority($level)" .PD 0 .IP "Mail::Transport::SMTP\->\fBlogPriority\fR($level)" 4 .IX Item "Mail::Transport::SMTP->logPriority($level)" .PD Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBlogSettings\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBlogSettings\fR()" 4 .IX Item "$obj->logSettings()" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBnotImplemented\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBnotImplemented\fR()" 4 .IX Item "$obj->notImplemented()" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBreport\fR( [$level] )" 4 .el .IP "\f(CW$obj\fR\->\fBreport\fR( [$level] )" 4 .IX Item "$obj->report( [$level] )" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBreportAll\fR( [$level] )" 4 .el .IP "\f(CW$obj\fR\->\fBreportAll\fR( [$level] )" 4 .IX Item "$obj->reportAll( [$level] )" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBtrace\fR( [$level] )" 4 .el .IP "\f(CW$obj\fR\->\fBtrace\fR( [$level] )" 4 .IX Item "$obj->trace( [$level] )" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBwarnings\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBwarnings\fR()" 4 .IX Item "$obj->warnings()" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .SS "Cleanup" .IX Subsection "Cleanup" Extends \*(L"Cleanup\*(R" in Mail::Transport::Send. .ie n .IP "$obj\->\fB\s-1DESTROY\s0\fR()" 4 .el .IP "\f(CW$obj\fR\->\fB\s-1DESTROY\s0\fR()" 4 .IX Item "$obj->DESTROY()" Inherited, see \*(L"Cleanup\*(R" in Mail::Reporter .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" .IP "Warning: Message has no destination" 4 .IX Item "Warning: Message has no destination" It was not possible to figure-out where the message is intended to go to. .IP "Notice: No addresses found to send the message to, no connection made" 4 .IX Item "Notice: No addresses found to send the message to, no connection made" .PD 0 .ie n .IP "Error: Package $package does not implement $method." 4 .el .IP "Error: Package \f(CW$package\fR does not implement \f(CW$method\fR." 4 .IX Item "Error: Package $package does not implement $method." .PD Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package. .IP "Warning: Resent group does not specify a destination" 4 .IX Item "Warning: Resent group does not specify a destination" The message which is sent is the result of a bounce (for instance created with \fIMail::Message::bounce()\fR), and therefore starts with a \&\f(CW\*(C`Received\*(C'\fR header field. With the \f(CW\*(C`bounce\*(C'\fR, the new destination(s) of the message are given, which should be included as \f(CW\*(C`Resent\-To\*(C'\fR, \&\f(CW\*(C`Resent\-Cc\*(C'\fR, and \f(CW\*(C`Resent\-Bcc\*(C'\fR. .Sp The \f(CW\*(C`To\*(C'\fR, \f(CW\*(C`Cc\*(C'\fR, and \f(CW\*(C`Bcc\*(C'\fR header information is only used if no \&\f(CW\*(C`Received\*(C'\fR was found. That seems to be the best explanation of the \s-1RFC.\s0 .Sp As alternative, you may also specify the \f(CW\*(C`to\*(C'\fR option to some of the senders (for instance Mail::Transport::SMTP::send(to) to overrule any information found in the message itself about the destination. .SH "SEE ALSO" .IX Header "SEE ALSO" This module is part of Mail-Box distribution version 2.117, built on August 24, 2014. Website: \fIhttp://perl.overmeer.net/mailbox/\fR .SH "LICENSE" .IX Header "LICENSE" Copyrights 2001\-2014 by [Mark Overmeer]. For other contributors see ChangeLog. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR