/usr/share/perl5/Mail/Message/Construct/Bounce.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 | =head1 NAME
Mail::Message::Construct::Bounce - bounce a Mail::Message
=head1 SYNOPSIS
$message->bounce(To => 'you')->send;
=head1 DESCRIPTION
Complex functionality on L<Mail::Message|Mail::Message> objects is implemented in
different files which are autoloaded. This file implements the
functionality related to bouncing messages off to other destinations.
=head1 METHODS
=head2 Constructing a message
=over 4
=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
The program calling this method considers itself as an intermediate step
in the message delivery process; it therefore leaves a resent group
of header fields as trace.
When a message is received, the Mail Transfer Agent (MTA) adds a
C<Received> field to the header. As OPTIONS, you may specify lines
which are added to the resent group of that received field. C<Resent-*>
is prepended before the field-names automatically, unless already present.
You may also specify an instantiated L<Mail::Message::Head::ResentGroup|Mail::Message::Head::ResentGroup> (RG)
object. See L<Mail::Message::Head::ResentGroup::new()|Mail::Message::Head::ResentGroup/"METHODS"> for the available
options. This is required if you want to add a new resent group: create
a new C<Received> line in the header as well.
If you are planning to change the body of a bounce message, don't! Bounced
messages have the same message-id as the original message, and therefore
should have the same content (message-ids are universally unique). If you
still insist, use L<Mail::Message::body()|Mail::Message/"The body">.
example:
my $bounce = $folder->message(3)->bounce(To => 'you', Bcc => 'everyone');
$bounce->send;
$outbox->addMessage($bounce);
my $rg = Mail::Message::Head::ResentGroup->new(To => 'you',
Received => 'from ... by ...');
$msg->bounce($rg)->send;
=back
=head1 DIAGNOSTICS
=over 4
=item Error: Method bounce requires To, Cc, or Bcc
The message L<bounce()|Mail::Message::Construct::Bounce/"Constructing a message"> method forwards a received message off to someone
else without modification; you must specified it's new destination.
If you have the urge not to specify any destination, you probably
are looking for L<reply()|Mail::Message::Construct::Reply/"Constructing a message">. When you wish to modify the content, use
L<forward()|Mail::Message::Construct::Forward/"Constructing a 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>
|