/usr/share/perl5/Mail/Transport/Send.pod is in libmail-box-perl 2.099-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 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | =head1 NAME
Mail::Transport::Send - send a message
=head1 INHERITANCE
Mail::Transport::Send
is a Mail::Transport
is a Mail::Reporter
Mail::Transport::Send is extended by
Mail::Transport::Exim
Mail::Transport::Mailx
Mail::Transport::Qmail
Mail::Transport::SMTP
Mail::Transport::Sendmail
=head1 SYNOPSIS
my $message = Mail::Message->new(...);
# Some extensions implement sending:
$message->send;
$message->send(via => 'sendmail');
my $sender = Mail::Transport::SMTP->new(...);
$sender->send($message);
=head1 DESCRIPTION
Send a message to the destinations as specified in the header. The
C<Mail::Transport::Send> module is capable of autodetecting which of the
following modules work on your system; you may simply call C<send>
without C<via> options to get a message transported.
=over 4
=item * L<Mail::Transport::Sendmail|Mail::Transport::Sendmail>
Use sendmail to process and deliver the mail. This requires the
C<sendmail> program to be installed on your system. Whether this
is an original sendmail, or a replacement from Postfix does matter.
=item * L<Mail::Transport::Exim|Mail::Transport::Exim>
Use C<exim> to distribute the message.
=item * L<Mail::Transport::Qmail|Mail::Transport::Qmail>
Use C<qmail-inject> to distribute the message.
=item * L<Mail::Transport::SMTP|Mail::Transport::SMTP>
In this case, Perl is handling mail transport on its own. This is less
desired but more portable than sending with sendmail or qmail.
The advantage is that this sender is environment independent, and easier to
configure. However, there is no daemon involved which means that your
program will wait until the message is delivered, and the message is
lost when your program is interrupted during delivery (which may
take hours to complete).
=item * L<Mail::Transport::Mailx|Mail::Transport::Mailx>
Use the external C<mail>, C<mailx>, or C<Mail> programs to send the
message. Usually, the result is poor, because some versions of these
programs do not support MIME headers. Besides, these programs are
known to have exploitable security breaches.
=back
=head1 METHODS
=head2 Constructors
=over 4
=item Mail::Transport::Send-E<gt>B<new>(OPTIONS)
-Option --Defined in --Default
executable Mail::Transport undef
hostname Mail::Transport 'localhost'
interval Mail::Transport 30
log Mail::Reporter 'WARNINGS'
password Mail::Transport undef
port Mail::Transport undef
proxy Mail::Transport undef
retry Mail::Transport <false>
timeout Mail::Transport 120
trace Mail::Reporter 'WARNINGS'
username Mail::Transport undef
via Mail::Transport 'sendmail'
=over 2
=item executable => FILENAME
=item hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
=item interval => SECONDS
=item log => LEVEL
=item password => STRING
=item port => INTEGER
=item proxy => PATH
=item retry => NUMBER|undef
=item timeout => SECONDS
=item trace => LEVEL
=item username => STRING
=item via => CLASS|NAME
=back
=back
=head2 Sending mail
=over 4
=item $obj-E<gt>B<destinations>(MESSAGE, [ADDRESS|ARRAY-OF-ADDRESSES])
Determine the destination for this message. If a valid ADDRESS is defined,
this is used to overrule the addresses within the message. If the ADDRESS
is C<undef> it is ignored.
If no ADDRESS is specified, the message is scanned for resent groups
(see L<Mail::Message::Head::Complete::resentGroups()|Mail::Message::Head::Complete/"Access to the header">). The addresses
found in the first (is latest added) group are used. If no resent groups
are found, the normal C<To>, C<Cc>, and C<Bcc> lines are taken.
=item $obj-E<gt>B<putContent>(MESSAGE, FILEHANDLE, OPTIONS)
Print the content of the MESSAGE to the FILEHANDLE.
-Option --Default
body_only <false>
undisclosed <false>
=over 2
=item body_only => BOOLEAN
Print only the body of the message, not the whole.
=item undisclosed => BOOLEAN
Do not print the C<Bcc> and C<Resent-Bcc> lines. Default false, which
means that they are not printed.
=back
=item $obj-E<gt>B<send>(MESSAGE, OPTIONS)
Transmit the MESSAGE, which may be anything what can be coerced into a
L<Mail::Message|Mail::Message>, so including L<Mail::Internet|Mail::Internet> and MIME::Entity
messages. It returns true when the transmission was successfully completed.
-Option --Default
interval new(interval)
retry new(retry)
to undef
=over 2
=item interval => SECONDS
=item retry => INTEGER
=item to => STRING
Overrules the destination(s) of the message, which is by default taken
from the (Resent-)To, (Resent-)Cc, and (Resent-)Bcc.
=back
=item $obj-E<gt>B<trySend>(MESSAGE, OPTIONS)
Try to send the message. This will return true if successful, and
false in case some problems where detected. The C<$?> contains
the exit status of the command which was started.
=back
=head2 Server connection
=over 4
=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">
=back
=head2 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::Send-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::Send-E<gt>B<log>([LEVEL [,STRINGS]])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>(LEVEL)
=item Mail::Transport::Send-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
=over 4
=item $obj-E<gt>B<DESTROY>
See L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<inGlobalDestruction>
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 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.
=item Error: Transporters of type $class cannot send.
The L<Mail::Transport|Mail::Transport> object of the specified type can not send messages,
but only receive message.
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.099,
built on July 07, 2011. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
Copyrights 2001-2011 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>
|