=head1 NAME

Mail::Transport::Qmail - transmit messages using external Qmail program

=head1 INHERITANCE

 Mail::Transport::Qmail
   is a Mail::Transport::Send
   is a Mail::Transport
   is a Mail::Reporter

=head1 SYNOPSIS

 my $sender = Mail::Transport::Qmail->new(...);
 $sender->send($message);

=head1 DESCRIPTION

Implements mail transport using the external programs C<'qmail-inject'>,
part of the qmail mail-delivery system.

=head1 METHODS

=head2 Constructors

Mail::Transport::Qmail-E<gt>B<new>(OPTIONS)

=over 4

 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  'qmail-inject'
 retry       Mail::Transport  <false>
 timeout     Mail::Transport  120
 trace       Mail::Reporter   'WARNINGS'
 username    Mail::Transport  undef
 via         Mail::Transport  'qmail'

. executable => FILENAME

. hostname => HOSTNAME|ARRAY-OF-HOSTNAMES

. interval => SECONDS

. log => LEVEL

. password => STRING

. port => INTEGER

. proxy => PATH

. retry => NUMBER|undef

. timeout => SECONDS

. trace => LEVEL

. username => STRING

. via => CLASS|NAME

=back

=head2 Sending mail

$obj-E<gt>B<destinations>(MESSAGE, [ADDRESS|ARRAY-OF-ADDRESSES])

=over 4

See L<Mail::Transport::Send/"Sending mail">

=back

$obj-E<gt>B<putContent>(MESSAGE, FILEHANDLE, OPTIONS)

=over 4

See L<Mail::Transport::Send/"Sending mail">

=back

$obj-E<gt>B<send>(MESSAGE, OPTIONS)

=over 4

See L<Mail::Transport::Send/"Sending mail">

=back

$obj-E<gt>B<trySend>(MESSAGE, OPTIONS)

=over 4

=back

=head2 Server connection

$obj-E<gt>B<findBinary>(NAME [, DIRECTORIES])

=over 4

See L<Mail::Transport/"Server connection">

=back

$obj-E<gt>B<remoteHost>

=over 4

See L<Mail::Transport/"Server connection">

=back

$obj-E<gt>B<retry>

=over 4

See L<Mail::Transport/"Server connection">

=back

=head2 Error handling

$obj-E<gt>B<AUTOLOAD>

=over 4

See L<Mail::Reporter/"Error handling">

=back

$obj-E<gt>B<addReport>(OBJECT)

=over 4

See L<Mail::Reporter/"Error handling">

=back

$obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Transport::Qmail-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

=over 4

See L<Mail::Reporter/"Error handling">

=back

$obj-E<gt>B<errors>

=over 4

See L<Mail::Reporter/"Error handling">

=back

$obj-E<gt>B<log>([LEVEL [,STRINGS]])

Mail::Transport::Qmail-E<gt>B<log>([LEVEL [,STRINGS]])

=over 4

See L<Mail::Reporter/"Error handling">

=back

$obj-E<gt>B<logPriority>(LEVEL)

Mail::Transport::Qmail-E<gt>B<logPriority>(LEVEL)

=over 4

See L<Mail::Reporter/"Error handling">

=back

$obj-E<gt>B<logSettings>

=over 4

See L<Mail::Reporter/"Error handling">

=back

$obj-E<gt>B<notImplemented>

=over 4

See L<Mail::Reporter/"Error handling">

=back

$obj-E<gt>B<report>([LEVEL])

=over 4

See L<Mail::Reporter/"Error handling">

=back

$obj-E<gt>B<reportAll>([LEVEL])

=over 4

See L<Mail::Reporter/"Error handling">

=back

$obj-E<gt>B<trace>([LEVEL])

=over 4

See L<Mail::Reporter/"Error handling">

=back

$obj-E<gt>B<warnings>

=over 4

See L<Mail::Reporter/"Error handling">

=back

=head2 Cleanup

$obj-E<gt>B<DESTROY>

=over 4

See L<Mail::Reporter/"Cleanup">

=back

$obj-E<gt>B<inGlobalDestruction>

=over 4

See L<Mail::Reporter/"Cleanup">

=back

=head1 DIAGNOSTICS

Error: Errors when closing Qmail mailer $program: $!

=over 4

The Qmail mail transfer agent did start, but was not able to handle the
message for some specific reason.

=back

Warning: Message has no destination

=over 4

It was not possible to figure-out where the message is intended to go
to.

=back

Error: Package $package does not implement $method.

=over 4

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.

=back

Warning: Resent group does not specify a destination

=over 4

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.079,
built on November 28, 2007. Website: F<http://perl.overmeer.net/mailbox/>

=head1 LICENSE

Copyrights 2001-2007 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>