/usr/share/perl5/Mail/Transport/SMTP.pod is in libmail-box-perl 2.110-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 | =encoding utf8
=head1 NAME
Mail::Transport::SMTP - transmit messages without external program
=head1 INHERITANCE
Mail::Transport::SMTP
is a Mail::Transport::Send
is a Mail::Transport
is a Mail::Reporter
=head1 SYNOPSIS
my $sender = Mail::Transport::SMTP->new(...);
$sender->send($message);
$message->send(via => 'smtp');
=head1 DESCRIPTION
This module implements transport of C<Mail::Message> objects by negotiating
to the destination host directly by using the SMTP protocol, without help of
C<sendmail>, C<mail>, or other programs on the local host.
See L<documentation in the base class|Mail::Transport::Send/"DESCRIPTION">.
=head1 METHODS
See L<documentation in the base class|Mail::Transport::Send/"METHODS">.
=head2 Constructors
See L<documentation in the base class|Mail::Transport::Send/"Constructors">.
=over 4
=item Mail::Transport::SMTP-E<gt>B<new>(OPTIONS)
-Option --Defined in --Default
executable Mail::Transport undef
helo <from Net::Config>
hostname Mail::Transport <from Net::Config>
interval Mail::Transport 30
log Mail::Reporter 'WARNINGS'
password undef
port Mail::Transport 25
proxy Mail::Transport <from Net::Config>
retry Mail::Transport <false>
smtp_debug <false>
timeout 120
trace Mail::Reporter 'WARNINGS'
username undef
via Mail::Transport 'smtp'
=over 2
=item executable => FILENAME
=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
C<From> line of the message is assumed.
=item hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
=item interval => SECONDS
=item log => LEVEL
=item password => STRING
The password to be used with the new(username) to log in to the remote
server.
=item port => INTEGER
=item proxy => PATH
=item retry => NUMBER|undef
=item smtp_debug => BOOLEAN
Simulate transmission: the SMTP protocol output will be sent to your
screen.
=item timeout => SECONDS
The number of seconds to wait for a valid response from the server before
failing.
=item trace => LEVEL
=item username => STRING
Use SASL authentication to contact the remote SMTP server (RFC2554).
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 C<username> can also be specified as an
Authen::SASL object.
=item via => CLASS|NAME
=back
=back
=head2 Sending mail
See L<documentation in the base class|Mail::Transport::Send/"Sending mail">.
=over 4
=item $obj-E<gt>B<destinations>(MESSAGE, [ADDRESS|ARRAY-OF-ADDRESSES])
See L<Mail::Transport::Send/"Sending mail">
=item $obj-E<gt>B<putContent>(MESSAGE, FILEHANDLE, OPTIONS)
See L<Mail::Transport::Send/"Sending mail">
=item $obj-E<gt>B<send>(MESSAGE, OPTIONS)
See L<Mail::Transport::Send/"Sending mail">
=item $obj-E<gt>B<trySend>(MESSAGE, OPTIONS)
Try to send the MESSAGE once. This may fail, in which case this
method will return C<false>. In list context, the reason for failure
can be caught: in list context C<trySend> will return a list of
five values:
(success, error code, error text, error location, quit success)
Success and quit success are booleans. The error code and -text are
protocol specific codes and texts. The location tells where the
problem occurred.
-Option--Default
from < >
to []
=over 2
=item from => ADDRESS
Your own identification. This may be fake. If not specified, it is
taken from L<Mail::Message::sender()|Mail::Message/"The header">, which means the content of the
C<Sender> field of the message or the first address of the C<From>
field. This defaults to "E<lt> E<gt>", which represents "no address".
=item to => ADDRESS|[ADDRESSES]
Alternative destinations. If not specified, the C<To>, C<Cc> and C<Bcc>
fields of the header are used. An address is a string or a Mail::Address
object.
=back
=back
=head2 Server connection
See L<documentation in the base class|Mail::Transport::Send/"Server connection">.
=over 4
=item $obj-E<gt>B<contactAnyServer>()
Creates the connection to the SMTP server. When more than one hostname
was specified, the first which accepts a connection is taken. An
IO::Socket::INET object is returned.
=item $obj-E<gt>B<findBinary>(NAME [, DIRECTORIES])
See L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<remoteHost>()
See L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<retry>()
See L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<tryConnectTo>(HOST, OPTIONS)
Try to establish a connection to deliver SMTP to the specified HOST. The
OPTIONS are passed to the C<new> method of Net::SMTP.
=back
=head2 Error handling
See L<documentation in the base class|Mail::Transport::Send/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<addReport>(OBJECT)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=item Mail::Transport::SMTP-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
=item Mail::Transport::SMTP-E<gt>B<log>([LEVEL [,STRINGS]])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>(LEVEL)
=item Mail::Transport::SMTP-E<gt>B<logPriority>(LEVEL)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<report>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<reportAll>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<trace>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
See L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
See L<documentation in the base class|Mail::Transport::Send/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
See L<Mail::Reporter/"Cleanup">
=back
=head1 DIAGNOSTICS
=over 4
=item Warning: Message has no destination
It was not possible to figure-out where the message is intended to go
to.
=item Notice: No addresses found to send the message to, no connection made
=item Error: Package $package does not implement $method.
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.
=item Warning: Resent group does not specify a destination
The message which is sent is the result of a bounce (for instance
created with L<Mail::Message::bounce()|Mail::Message::Construct::Bounce/"Constructing a message">), and therefore starts with a
C<Received> header field. With the C<bounce>, the new destination(s)
of the message are given, which should be included as C<Resent-To>,
C<Resent-Cc>, and C<Resent-Bcc>.
The C<To>, C<Cc>, and C<Bcc> header information is only used if no
C<Received> was found. That seems to be the best explanation of the RFC.
As alternative, you may also specify the C<to> option to some of the senders
(for instance L<Mail::Transport::SMTP::send(to)|Mail::Transport::Send/"Sending mail"> to overrule any information
found in the message itself about the destination.
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.110,
built on January 05, 2014. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
Copyrights 2001-2014 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>
|