@@ -5,6 +5,101 @@ Limitations to be fixed:
- when lines are over 997 chars, then the transfer-encoding should
automatically change from 'none' into 'quoted-printable' or 'base64'
+version 2.118: Thu Feb 26 12:52:42 CET 2015
+
+ Fixes:
+ - imap: reconstruction of foldername from url should be kept
+ in folderdir.
+ rt.cpan.org#82983 [Rotkraut]
+ - ::Body::Scalar::file() did not construct ::FastScalar correctly
+ [Andrew Beverley]
+ - fix attribute continuations
+ rt.cpan.org#90342 [Claus Jeppesen]
+
+ Improvements:
+ - accept blanks in some Content-* fields
+ rt.cpan.org#99183 [Randy Diffenderfer]
+
+version 2.117: Sun Aug 24 15:19:01 CEST 2014
+
+ Fixes:
+ - missed a line from the patch of
+ rt.cpan.org#98225 [Andrew Beverley]
+
+version 2.116: Sat Aug 23 11:27:16 CEST 2014
+
+ Improvements:
+ - add Mail::Transport::SMTP->new(esmtp_options) and
+ trySend(esmtp_options)
+ rt.cpan.org#97630 [Andrew Beverley]
+ - add Mail::Transport::SMTP->new(from)
+ rt.cpan.org#97636 [Andrew Beverley]
+ - ::Field::Date parse support for numeric months (format used
+ by some broken clients/Yahoo auto-responder)
+ rt.cpan.org#98225 [Andrew Beverley]
+
+version 2.115: Wed May 28 15:27:48 CEST 2014
+
+ Improvements:
+ - All regression tests pass on Windows!
+ [Markus Spann]
+
+version 2.114: Thu May 8 10:49:17 CEST 2014
+
+ Fixes:
+ - check for Test::Pod on Windows [cpantesters]
+ - do not break PATH in test.pl on Windows [Markus Spann]
+ - fix ::Locker::POSIX "read-only" error in Perl >5.18.2 [Jim In Aus]
+
+version 2.113: Wed Apr 16 14:07:37 CEST 2014
+
+ Fixes:
+ - revert change which replaced IO::File by open($fh), because it
+ does not support tell in Perl 5.10 [Scott Smedley]
+
+version 2.112: Fri Mar 14 13:18:57 CET 2014
+
+ Changes:
+ - do not attempt POSIX lock on Windows [Christian Walde]
+
+ Fixes:
+ - ::Field::Date do not attempt to restore TZ with undef.
+ [Andrew Beverley]
+ - many regression test fixes for Windows [Christian Walde]
+
+ Improvements:
+ - Mail::Transport::SMTP uses Net::SMTP which sometimes needs
+ Net::STMPS being installed. [Scott Smedley]
+
+version 2.111: Fri Jan 24 11:21:30 CET 2014
+
+ Fixes:
+ - do not explicitly clean-up head and body during DESTROY of a
+ message, because those may be reused in other messages.
+ Fix for rebuild bug, reported by [Andrew Beverley]
+ - open files in ::Body::File with :raw, not to corrupt line-
+ endings on Windows. rt.cpan.org#92374 [Joseph Strom]
+
+ Improvements:
+ - add dispositionFilename to replacement text of deleted parts
+ [Mark Nienberg]
+ - change documentation syntax
+
+version 2.110: Sun Jan 5 18:50:59 CET 2014
+
+ Fixes:
+ - ::Field::Date must compute in UTC [Andrew Beverley]
+ - ::Field::Date negated -0600 timestamp [Andrew Beverley]
+ - ::Field::Attribute should allow blanks around the '='
+ rt.cpan.org#90035 [Max Bowsher]
+ - ::dispositionFilename() should use a study()d header
+ rt.cpan.org#90342 [Claus Jeppesen]
+ - begin :html in ::Box-Index
+
+ Improvements:
+ - add Mail::Message::Construct::Rebuild::removeExtraAlternativeText()
+ Implemented by [Andrew Beverley]
+
version 2.109: Mon Aug 19 12:55:30 CEST 2013
Fixes:
@@ -26,7 +121,7 @@ version 2.108: Tue Jun 25 09:21:59 CEST 2013
Improvements:
- use Devel::GlobalDestruction
- rt.cpan.org#80611 [Riba Sushi]
+ rt.cpan.org#80611 [Ribasushi]
- imap4: support TLS
rt.cpan.org#82990 [Rolf Krahl]
@@ -44,7 +44,7 @@
"MIME::Base64" : "0",
"MIME::Types" : "1.004",
"Mail::Address" : "0",
- "Object::Realize::Later" : "0.14",
+ "Object::Realize::Later" : "0.19",
"Scalar::Util" : "1.13",
"Sys::Hostname" : "0",
"TAP::Harness" : "3.00",
@@ -52,10 +52,10 @@
"Test::Pod" : "1.00",
"Time::Zone" : "0",
"URI" : "1.23",
- "User::Identity" : "0.93"
+ "User::Identity" : "0.94"
}
}
},
"release_status" : "stable",
- "version" : "2.109"
+ "version" : "2.118"
}
@@ -30,7 +30,7 @@ requires:
MIME::Base64: 0
MIME::Types: 1.004
Mail::Address: 0
- Object::Realize::Later: 0.14
+ Object::Realize::Later: 0.19
Scalar::Util: 1.13
Sys::Hostname: 0
TAP::Harness: 3.00
@@ -38,5 +38,5 @@ requires:
Test::Pod: 1.00
Time::Zone: 0
URI: 1.23
- User::Identity: 0.93
-version: 2.109
+ User::Identity: 0.94
+version: 2.118
@@ -4,7 +4,7 @@ require 5.006_001;
use IO::Handle;
-my $VERSION = '2.109';
+my $VERSION = '2.118';
# Usually, Scalar::Util is installed (in core since perl 5.8.0)
# However, sometimes it is (incorrectly) installed without XS, but as
@@ -98,7 +98,7 @@ my %prereq =
, Mail::Address => 0.0
, MIME::Base64 => 0.0
, MIME::Types => 1.004
- , Object::Realize::Later => 0.14
+ , Object::Realize::Later => 0.19
, Scalar::Util => 1.13
, Sys::Hostname => 0.0
, TAP::Harness => '3.00'
@@ -106,7 +106,7 @@ my %prereq =
, Test::Pod => '1.00'
, Time::Zone => 0
, URI => 1.23
- , User::Identity => '0.93'
+ , User::Identity => '0.94'
, Devel::GlobalDestruction => 0.09
);
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Box::Collection;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base qw/User::Identity::Collection Mail::Reporter/;
@@ -22,41 +22,41 @@ objects, each describing a the location of a single mailbox (folder). The
collection is used by the L<Mail::Box::Manage::User|Mail::Box::Manage::User> object to administer
the folders of a single user, even if those folders are closed.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
-See L<documentation in the base class|User::Identity::Collection/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in User::Identity::Collection|User::Identity::Collection/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|User::Identity::Collection/"OVERLOADED">.
+Extends L<"OVERLOADED" in User::Identity::Collection|User::Identity::Collection/"OVERLOADED">.
=over 4
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<User::Identity::Collection/"OVERLOADED">
+Inherited, see L<User::Identity::Collection/"OVERLOADED">
-=item overload: B<stringification>()
+=item overload: B<stringification>
-See L<User::Identity::Collection/"OVERLOADED">
+Inherited, see L<User::Identity::Collection/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
-See L<documentation in the base class|User::Identity::Collection/"METHODS">.
+Extends L<"METHODS" in User::Identity::Collection|User::Identity::Collection/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
-See L<documentation in the base class|User::Identity::Collection/"Constructors">.
+Extends L<"Constructors" in User::Identity::Collection|User::Identity::Collection/"Constructors">.
=over 4
-=item Mail::Box::Collection-E<gt>B<new>([NAME], OPTIONS)
+=item Mail::Box::Collection-E<gt>B<new>( [$name], %options )
-Option --Defined in --Default
description User::Identity::Item undef
@@ -97,183 +97,183 @@ An L<Mail::Box::Manager|Mail::Box::Manager> OBJECT (could be a L<Mail::Box::Mana
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Collection-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Collection-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Collection-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Collection-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Collection-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Collection-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head2 Attributes
-See L<documentation in the base class|User::Identity::Collection/"Attributes">.
+Extends L<"Attributes" in User::Identity::Collection|User::Identity::Collection/"Attributes">.
=over 4
=item $obj-E<gt>B<description>()
-See L<User::Identity::Item/"Attributes">
+Inherited, see L<User::Identity::Item/"Attributes">
-=item $obj-E<gt>B<folderType>([FOLDERCLASS])
+=item $obj-E<gt>B<folderType>( [$folderclass] )
Returns the type of folder (on this location). When specified, then
-FOLDERCLASS must be a L<Mail::Box|Mail::Box> extension.
+$folderclass must be a L<Mail::Box|Mail::Box> extension.
=item $obj-E<gt>B<itemType>()
-See L<User::Identity::Collection/"Attributes">
+Inherited, see L<User::Identity::Collection/"Attributes">
=item $obj-E<gt>B<manager>()
The L<Mail::Box::Manager|Mail::Box::Manager> (usually a L<Mail::Box::Manage::User|Mail::Box::Manage::User> object),
which is handling the opening of folders.
-=item $obj-E<gt>B<name>([NEWNAME])
+=item $obj-E<gt>B<name>( [NEWNAME] )
-See L<User::Identity::Item/"Attributes">
+Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<roles>()
-See L<User::Identity::Collection/"Attributes">
+Inherited, see L<User::Identity::Collection/"Attributes">
=back
=head2 Collections
-See L<documentation in the base class|User::Identity::Collection/"Collections">.
+Extends L<"Collections" in User::Identity::Collection|User::Identity::Collection/"Collections">.
=over 4
=item $obj-E<gt>B<add>(COLLECTION, ROLE)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<addCollection>(OBJECT | ([TYPE], OPTIONS))
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<collection>(NAME)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
-=item $obj-E<gt>B<parent>([PARENT])
+=item $obj-E<gt>B<parent>( [PARENT] )
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<removeCollection>(OBJECT|NAME)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<type>()
=item Mail::Box::Collection-E<gt>B<type>()
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<user>()
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=back
=head2 Maintaining roles
-See L<documentation in the base class|User::Identity::Collection/"Maintaining roles">.
+Extends L<"Maintaining roles" in User::Identity::Collection|User::Identity::Collection/"Maintaining roles">.
=over 4
-=item $obj-E<gt>B<addRole>(ROLE| ( [NAME],OPTIONS ) | ARRAY-OF-OPTIONS)
+=item $obj-E<gt>B<addRole>(ROLE| ([NAME],OPTIONS) | ARRAY)
-See L<User::Identity::Collection/"Maintaining roles">
+Inherited, see L<User::Identity::Collection/"Maintaining roles">
=item $obj-E<gt>B<removeRole>(ROLE|NAME)
-See L<User::Identity::Collection/"Maintaining roles">
+Inherited, see L<User::Identity::Collection/"Maintaining roles">
-=item $obj-E<gt>B<renameRole>(ROLE|OLDNAME, NEWNAME)
+=item $obj-E<gt>B<renameRole>( <ROLE|OLDNAME>, NEWNAME )
-See L<User::Identity::Collection/"Maintaining roles">
+Inherited, see L<User::Identity::Collection/"Maintaining roles">
=item $obj-E<gt>B<sorted>()
-See L<User::Identity::Collection/"Maintaining roles">
+Inherited, see L<User::Identity::Collection/"Maintaining roles">
=back
=head2 Searching
-See L<documentation in the base class|User::Identity::Collection/"Searching">.
+Extends L<"Searching" in User::Identity::Collection|User::Identity::Collection/"Searching">.
=over 4
=item $obj-E<gt>B<find>(NAME|CODE|undef)
-See L<User::Identity::Collection/"Searching">
+Inherited, see L<User::Identity::Collection/"Searching">
=back
@@ -334,12 +334,12 @@ cannot add objects of a different $type.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Box::Dbx::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::File::Message';
@@ -19,23 +19,23 @@ Mail::Box::Dbx::Message - one message in a Dbx folder
=head1 DESCRIPTION
-See L<documentation in the base class|Mail::Box::File::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::File::Message|Mail::Box::File::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::File::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Box::File::Message|Mail::Box::File::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::File::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Box::File::Message|Mail::Box::File::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Box::Dbx::Message-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Dbx::Message-E<gt>B<new>(%options)
-Option --Defined in --Default
account_name <from dbx_record>
@@ -114,91 +114,91 @@ I<seen>. Folders store this flag in different ways.
=head2 Constructing a message
-See L<documentation in the base class|Mail::Box::File::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Box::File::Message|Mail::Box::File::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Box::Dbx::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Box::Dbx::Message-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Box::Dbx::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Box::Dbx::Message-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Box::Dbx::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Box::Dbx::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Box::Dbx::Message-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Box::File::Message/"The message">.
+Extends L<"The message" in Mail::Box::File::Message|Mail::Box::File::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<dbxRecord>()
@@ -206,375 +206,375 @@ Returns the Mail::Transport::Dbx::Email record of the message.
=item $obj-E<gt>B<escapedBody>()
-See L<Mail::Box::File::Message/"The message">
+Inherited, see L<Mail::Box::File::Message/"The message">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
-=item $obj-E<gt>B<fromLine>([LINE])
+=item $obj-E<gt>B<fromLine>( [$line] )
-See L<Mail::Box::File::Message/"The message">
+Inherited, see L<Mail::Box::File::Message/"The message">
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<moveTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<seqnr>([INTEGER])
+=item $obj-E<gt>B<seqnr>( [$integer] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<size>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Box::File::Message/"METHODS">
+Inherited, see L<Mail::Box::File::Message/"METHODS">
=back
=head2 The header
-See L<documentation in the base class|Mail::Box::File::Message/"The header">.
+Extends L<"The header" in Mail::Box::File::Message|Mail::Box::File::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Box::File::Message/"The body">.
+Extends L<"The body" in Mail::Box::File::Message|Mail::Box::File::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Box::File::Message/"Flags">.
+Extends L<"Flags" in Mail::Box::File::Message|Mail::Box::File::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Box::File::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Box::File::Message|Mail::Box::File::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::File::Message/"Internals">.
+Extends L<"Internals" in Mail::Box::File::Message|Mail::Box::File::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Box::Dbx::Message-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item Mail::Box::Dbx::Message-E<gt>B<coerce>($message, %options)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<diskDelete>()
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
=item $obj-E<gt>B<fileLocation>()
-See L<Mail::Box::File::Message/"Internals">
+Inherited, see L<Mail::Box::File::Message/"Internals">
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<loadBody>()
-See L<Mail::Box::File::Message/"Internals">
+Inherited, see L<Mail::Box::File::Message/"Internals">
-=item $obj-E<gt>B<moveLocation>(DISTANCE)
+=item $obj-E<gt>B<moveLocation>($distance)
-See L<Mail::Box::File::Message/"Internals">
+Inherited, see L<Mail::Box::File::Message/"Internals">
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER)
+=item $obj-E<gt>B<readFromParser>($parser)
-See L<Mail::Box::File::Message/"Internals">
+Inherited, see L<Mail::Box::File::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::File::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Box::File::Message|Mail::Box::File::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Dbx::Message-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Dbx::Message-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Dbx::Message-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Dbx::Message-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Dbx::Message-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Dbx::Message-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Box::Dbx::Message-E<gt>B<shortSize>([VALUE])
+=item Mail::Box::Dbx::Message-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::File::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::File::Message|Mail::Box::File::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
-See L<Mail::Box::Message/"Cleanup">
+Inherited, see L<Mail::Box::Message/"Cleanup">
=back
@@ -598,7 +598,7 @@ a string representation of the same fact.
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::File::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::File::Message|Mail::Box::File::Message/"DETAILS">.
=head1 DIAGNOSTICS
@@ -666,12 +666,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -6,7 +6,7 @@
use strict;
package Mail::Box::Dbx;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::File';
@@ -30,39 +30,39 @@ be found at L<http://alioth.debian.org/projects/libpst/>. The library does
not support writing of dbx files, and therefore limits the possibilities
of this package.
-See L<documentation in the base class|Mail::Box::File/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::File|Mail::Box::File/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Box::File/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Box::File|Mail::Box::File/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Box::File/"METHODS">.
+Extends L<"METHODS" in Mail::Box::File|Mail::Box::File/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::File/"Constructors">.
+Extends L<"Constructors" in Mail::Box::File|Mail::Box::File/"Constructors">.
=over 4
-=item Mail::Box::Dbx-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Dbx-E<gt>B<new>(%options)
-Option --Defined in --Default
access Mail::Box always 'r'
@@ -158,145 +158,145 @@ See L<documentation in the base class|Mail::Box::File/"Constructors">.
=head2 The folder
-See L<documentation in the base class|Mail::Box::File/"The folder">.
+Extends L<"The folder" in Mail::Box::File|Mail::Box::File/"The folder">.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<addMessage>($message, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<addMessages>(MESSAGE [, MESSAGE, ...])
+=item $obj-E<gt>B<addMessages>(@messages)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item Mail::Box::Dbx-E<gt>B<appendMessages>(OPTIONS)
+=item Mail::Box::Dbx-E<gt>B<appendMessages>(%options)
-See L<Mail::Box::File/"METHODS">
+Inherited, see L<Mail::Box::File/"METHODS">
-=item $obj-E<gt>B<close>(OPTIONS)
+=item $obj-E<gt>B<close>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<delete>(OPTIONS)
+=item $obj-E<gt>B<delete>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<filename>()
-See L<Mail::Box::File/"The folder">
+Inherited, see L<Mail::Box::File/"The folder">
-=item $obj-E<gt>B<folderdir>([DIRECTORY])
+=item $obj-E<gt>B<folderdir>( [$directory] )
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<name>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<update>(OPTIONS)
+=item $obj-E<gt>B<update>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<url>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=back
=head2 Folder flags
-See L<documentation in the base class|Mail::Box::File/"Folder flags">.
+Extends L<"Folder flags" in Mail::Box::File|Mail::Box::File/"Folder flags">.
=over 4
=item $obj-E<gt>B<access>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=back
=head2 The messages
-See L<documentation in the base class|Mail::Box::File/"The messages">.
+Extends L<"The messages" in Mail::Box::File|Mail::Box::File/"The messages">.
=over 4
-=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
+=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<find>(MESSAGE-ID)
+=item $obj-E<gt>B<find>($message_id)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
+=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
+=item $obj-E<gt>B<message>( $index, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
+=item $obj-E<gt>B<messageId>( $message_id, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
+=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<nrMessages>(OPTIONS)
+=item $obj-E<gt>B<nrMessages>(%options)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
+=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=back
=head2 Sub-folders
-See L<documentation in the base class|Mail::Box::File/"Sub-folders">.
+Extends L<"Sub-folders" in Mail::Box::File|Mail::Box::File/"Sub-folders">.
=over 4
-=item $obj-E<gt>B<listSubFolders>(OPTIONS)
+=item $obj-E<gt>B<listSubFolders>(%options)
-=item Mail::Box::Dbx-E<gt>B<listSubFolders>(OPTIONS)
+=item Mail::Box::Dbx-E<gt>B<listSubFolders>(%options)
It is advised to set the C<check> flag, because dbx folder often list
large amounts of folder names which do not really exist. However, checking
@@ -320,41 +320,41 @@ does consume some time.
=back
-=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-=item Mail::Box::Dbx-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item Mail::Box::Dbx-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
+=item $obj-E<gt>B<openRelatedFolder>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openSubFolder>(SUBNAME, OPTIONS)
+=item $obj-E<gt>B<openSubFolder>($subname, %options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<topFolderWithMessages>()
=item Mail::Box::Dbx-E<gt>B<topFolderWithMessages>()
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::File/"Internals">.
+Extends L<"Internals" in Mail::Box::File|Mail::Box::File/"Internals">.
=over 4
-=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<coerce>($message, %options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item $obj-E<gt>B<create>($foldername, %options)
-=item Mail::Box::Dbx-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item Mail::Box::Dbx-E<gt>B<create>($foldername, %options)
Creation is not supported for dbx folders.
@@ -367,20 +367,20 @@ Creation is not supported for dbx folders.
=back
-=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
+=item $obj-E<gt>B<determineBodyType>($message, $head)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<folderToFilename>(FOLDERNAME, FOLDERDIR)
+=item $obj-E<gt>B<folderToFilename>($foldername, $folderdir)
-=item Mail::Box::Dbx-E<gt>B<folderToFilename>(FOLDERNAME, FOLDERDIR)
+=item Mail::Box::Dbx-E<gt>B<folderToFilename>($foldername, $folderdir)
Translate a folder name into a filename, using the
-FOLDERDIR value to replace a leading C<=>.
+$folderdir value to replace a leading C<=>.
-=item Mail::Box::Dbx-E<gt>B<foundIn>([FOLDERNAME], [OPTIONS])
+=item Mail::Box::Dbx-E<gt>B<foundIn>( [$foldername], %options )
-If no FOLDERNAME is specified, then the value of the C<folder> option
+If no $foldername is specified, then the value of the C<folder> option
is taken. A dbx folder is a file which name ends on C<.dbx> (case
insensitive).
@@ -396,21 +396,21 @@ insensitive).
=back
-=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
+=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<messageCreateOptions>([TYPE, CONFIG])
+=item $obj-E<gt>B<messageCreateOptions>( [$type, $config] )
-See L<Mail::Box::File/"Internals">
+Inherited, see L<Mail::Box::File/"Internals">
-=item $obj-E<gt>B<moveAwaySubFolder>(DIRECTORY, EXTENSION)
+=item $obj-E<gt>B<moveAwaySubFolder>($directory, $extension)
-See L<Mail::Box::File/"Internals">
+Inherited, see L<Mail::Box::File/"Internals">
=item $obj-E<gt>B<parser>()
@@ -419,147 +419,147 @@ module (to get the right data) and L<read()|Mail::Box/"Internals">. Asking for
will provide the transporter object. If asked more than once, each time
the same object will be returned.
-=item $obj-E<gt>B<read>(OPTIONS)
+=item $obj-E<gt>B<read>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<readMessages>(OPTIONS)
+=item $obj-E<gt>B<readMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<storeMessage>(MESSAGE)
+=item $obj-E<gt>B<storeMessage>($message)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<updateMessages>(OPTIONS)
+=item $obj-E<gt>B<updateMessages>(%options)
-See L<Mail::Box::File/"Internals">
+Inherited, see L<Mail::Box::File/"Internals">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Box::File/"Internals">
+Inherited, see L<Mail::Box::File/"Internals">
-=item $obj-E<gt>B<writeMessages>(OPTIONS)
+=item $obj-E<gt>B<writeMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Box::File/"Other methods">.
+Extends L<"Other methods" in Mail::Box::File|Mail::Box::File/"Other methods">.
=over 4
-=item $obj-E<gt>B<timespan2seconds>(TIME)
+=item $obj-E<gt>B<timespan2seconds>($time)
-=item Mail::Box::Dbx-E<gt>B<timespan2seconds>(TIME)
+=item Mail::Box::Dbx-E<gt>B<timespan2seconds>($time)
-See L<Mail::Box/"Other methods">
+Inherited, see L<Mail::Box/"Other methods">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::File/"Error handling">.
+Extends L<"Error handling" in Mail::Box::File|Mail::Box::File/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Dbx-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Dbx-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Dbx-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Dbx-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Dbx-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Dbx-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::File/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::File|Mail::Box::File/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box/"Cleanup">
+Inherited, see L<Mail::Box/"Cleanup">
=back
=head2 DETAILS
-See L<documentation in the base class|Mail::Box::File/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::File|Mail::Box::File/"DETAILS">.
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::File/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::File|Mail::Box::File/"DETAILS">.
=head2 Different kinds of folders
-See L<documentation in the base class|Mail::Box::File/"Different kinds of folders">.
+Extends L<"Different kinds of folders" in Mail::Box::File|Mail::Box::File/"Different kinds of folders">.
=head2 Available folder types
-See L<documentation in the base class|Mail::Box::File/"Available folder types">.
+Extends L<"Available folder types" in Mail::Box::File|Mail::Box::File/"Available folder types">.
=head2 Folder class implementation
-See L<documentation in the base class|Mail::Box::File/"Folder class implementation">.
+Extends L<"Folder class implementation" in Mail::Box::File|Mail::Box::File/"Folder class implementation">.
=head2 How DBX folders work
@@ -703,12 +703,12 @@ error messages to indicate the real problem.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Box::Dir::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Message';
@@ -50,23 +50,23 @@ code is not GPLed (yet).
=back
-See L<documentation in the base class|Mail::Box::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Message|Mail::Box::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Message|Mail::Box::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Message|Mail::Box::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Box::Dir::Message-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Dir::Message-E<gt>B<new>(%options)
Create a messages in a directory organized folder.
@@ -132,344 +132,344 @@ See L<Mail::Box::new(fix_headers)|Mail::Box/"Constructors">.
=head2 Constructing a message
-See L<documentation in the base class|Mail::Box::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Box::Message|Mail::Box::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Box::Dir::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Box::Dir::Message-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Box::Dir::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Box::Dir::Message-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Box::Dir::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Box::Dir::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Box::Dir::Message-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Box::Message/"The message">.
+Extends L<"The message" in Mail::Box::Message|Mail::Box::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
-=item $obj-E<gt>B<filename>([FILENAME])
+=item $obj-E<gt>B<filename>( [$filename] )
Returns the name of the file in which this message is actually stored. This
will return C<undef> when the message is not stored in a file.
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<moveTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<seqnr>([INTEGER])
+=item $obj-E<gt>B<seqnr>( [$integer] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<size>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=back
=head2 The header
-See L<documentation in the base class|Mail::Box::Message/"The header">.
+Extends L<"The header" in Mail::Box::Message|Mail::Box::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Box::Message/"The body">.
+Extends L<"The body" in Mail::Box::Message|Mail::Box::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Box::Message/"Flags">.
+Extends L<"Flags" in Mail::Box::Message|Mail::Box::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Box::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Box::Message|Mail::Box::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Message/"Internals">.
+Extends L<"Internals" in Mail::Box::Message|Mail::Box::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Box::Dir::Message-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item Mail::Box::Dir::Message-E<gt>B<coerce>($message, %options)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<create>(FILENAME)
+=item $obj-E<gt>B<create>($filename)
Create the message in the specified file. If the message already has
a filename and is not modified, then a move is tried. Otherwise the
-message is printed to the file. If the FILENAME already exists for
-this message, nothing is done. In any case, the new FILENAME is set
+message is printed to the file. If the $filename already exists for
+this message, nothing is done. In any case, the new $filename is set
as well.
=item $obj-E<gt>B<diskDelete>()
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<loadBody>()
@@ -485,123 +485,123 @@ is needed.
Create and return a parser for this message (-file).
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Message|Mail::Box::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Dir::Message-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Dir::Message-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Dir::Message-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Dir::Message-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Dir::Message-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Dir::Message-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Box::Dir::Message-E<gt>B<shortSize>([VALUE])
+=item Mail::Box::Dir::Message-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Message|Mail::Box::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
-See L<Mail::Box::Message/"Cleanup">
+Inherited, see L<Mail::Box::Message/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Message|Mail::Box::Message/"DETAILS">.
=head1 DIAGNOSTICS
@@ -696,12 +696,12 @@ unreadible for some other reason.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::Dir;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box';
@@ -45,39 +45,39 @@ available (yet).
=back
-See L<documentation in the base class|Mail::Box/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box|Mail::Box/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Box/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Box|Mail::Box/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Box/"METHODS">.
+Extends L<"METHODS" in Mail::Box|Mail::Box/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box/"Constructors">.
+Extends L<"Constructors" in Mail::Box|Mail::Box/"Constructors">.
=over 4
-=item Mail::Box::Dir-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Dir-E<gt>B<new>(%options)
-Option --Defined in --Default
access Mail::Box 'r'
@@ -173,33 +173,33 @@ name.
=head2 The folder
-See L<documentation in the base class|Mail::Box/"The folder">.
+Extends L<"The folder" in Mail::Box|Mail::Box/"The folder">.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<addMessage>($message, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<addMessages>(MESSAGE [, MESSAGE, ...])
+=item $obj-E<gt>B<addMessages>(@messages)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item Mail::Box::Dir-E<gt>B<appendMessages>(OPTIONS)
+=item Mail::Box::Dir-E<gt>B<appendMessages>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<close>(OPTIONS)
+=item $obj-E<gt>B<close>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<delete>(OPTIONS)
+=item $obj-E<gt>B<delete>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<directory>()
@@ -209,306 +209,306 @@ example:
print $folder->directory;
-=item $obj-E<gt>B<folderdir>([DIRECTORY])
+=item $obj-E<gt>B<folderdir>( [$directory] )
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<name>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<update>(OPTIONS)
+=item $obj-E<gt>B<update>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<url>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=back
=head2 Folder flags
-See L<documentation in the base class|Mail::Box/"Folder flags">.
+Extends L<"Folder flags" in Mail::Box|Mail::Box/"Folder flags">.
=over 4
=item $obj-E<gt>B<access>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=back
=head2 The messages
-See L<documentation in the base class|Mail::Box/"The messages">.
+Extends L<"The messages" in Mail::Box|Mail::Box/"The messages">.
=over 4
-=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
+=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<find>(MESSAGE-ID)
+=item $obj-E<gt>B<find>($message_id)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
+=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
+=item $obj-E<gt>B<message>( $index, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
+=item $obj-E<gt>B<messageId>( $message_id, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
+=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<nrMessages>(OPTIONS)
+=item $obj-E<gt>B<nrMessages>(%options)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
+=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=back
=head2 Sub-folders
-See L<documentation in the base class|Mail::Box/"Sub-folders">.
+Extends L<"Sub-folders" in Mail::Box|Mail::Box/"Sub-folders">.
=over 4
-=item $obj-E<gt>B<listSubFolders>(OPTIONS)
+=item $obj-E<gt>B<listSubFolders>(%options)
-=item Mail::Box::Dir-E<gt>B<listSubFolders>(OPTIONS)
+=item Mail::Box::Dir-E<gt>B<listSubFolders>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-=item Mail::Box::Dir-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item Mail::Box::Dir-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
+=item $obj-E<gt>B<openRelatedFolder>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openSubFolder>(SUBNAME, OPTIONS)
+=item $obj-E<gt>B<openSubFolder>($subname, %options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<topFolderWithMessages>()
=item Mail::Box::Dir-E<gt>B<topFolderWithMessages>()
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box/"Internals">.
+Extends L<"Internals" in Mail::Box|Mail::Box/"Internals">.
=over 4
-=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<coerce>($message, %options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item $obj-E<gt>B<create>($foldername, %options)
-=item Mail::Box::Dir-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item Mail::Box::Dir-E<gt>B<create>($foldername, %options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
+=item $obj-E<gt>B<determineBodyType>($message, $head)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<folderToDirectory>(FOLDERNAME, FOLDERDIR)
+=item $obj-E<gt>B<folderToDirectory>($foldername, $folderdir)
(class method) Translate a foldername into a filename, with use of the
-FOLDERDIR to replace a leading C<=>.
+$folderdir to replace a leading C<=>.
-=item Mail::Box::Dir-E<gt>B<foundIn>([FOLDERNAME], OPTIONS)
+=item Mail::Box::Dir-E<gt>B<foundIn>( [$foldername], %options )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
+=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<read>(OPTIONS)
+=item $obj-E<gt>B<read>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<readMessageFilenames>(DIRECTORY)
+=item $obj-E<gt>B<readMessageFilenames>($directory)
Returns a list of all filenames which are found in this folder
directory and represent a message. The filenames are returned as
relative path.
-=item $obj-E<gt>B<readMessages>(OPTIONS)
+=item $obj-E<gt>B<readMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<storeMessage>(MESSAGE)
+=item $obj-E<gt>B<storeMessage>($message)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<updateMessages>(OPTIONS)
+=item $obj-E<gt>B<updateMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<writeMessages>(OPTIONS)
+=item $obj-E<gt>B<writeMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Box/"Other methods">.
+Extends L<"Other methods" in Mail::Box|Mail::Box/"Other methods">.
=over 4
-=item $obj-E<gt>B<timespan2seconds>(TIME)
+=item $obj-E<gt>B<timespan2seconds>($time)
-=item Mail::Box::Dir-E<gt>B<timespan2seconds>(TIME)
+=item Mail::Box::Dir-E<gt>B<timespan2seconds>($time)
-See L<Mail::Box/"Other methods">
+Inherited, see L<Mail::Box/"Other methods">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box/"Error handling">.
+Extends L<"Error handling" in Mail::Box|Mail::Box/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Dir-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Dir-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Dir-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Dir-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Dir-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Dir-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box|Mail::Box/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box/"Cleanup">
+Inherited, see L<Mail::Box/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box|Mail::Box/"DETAILS">.
=head1 DIAGNOSTICS
@@ -594,12 +594,12 @@ were changes made.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,10 +1,10 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::FastScalar;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
@@ -22,12 +22,12 @@ $/ must be undef or string - "" and \scalar unimplemented
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -6,7 +6,7 @@
use strict;
package Mail::Box::File::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Message';
@@ -25,23 +25,23 @@ Mail::Box::File::Message - one message in a Mbox folder
Maintain one message in an file based folder, any L<Mail::Box::File|Mail::Box::File>
extension.
-See L<documentation in the base class|Mail::Box::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Message|Mail::Box::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Message|Mail::Box::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Message|Mail::Box::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Box::File::Message-E<gt>B<new>(OPTIONS)
+=item Mail::Box::File::Message-E<gt>B<new>(%options)
Messages in file-based folders use the following options for creation:
@@ -103,91 +103,91 @@ this line, but this is just how things were invented...
=head2 Constructing a message
-See L<documentation in the base class|Mail::Box::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Box::Message|Mail::Box::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Box::File::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Box::File::Message-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Box::File::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Box::File::Message-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Box::File::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Box::File::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Box::File::Message-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Box::Message/"The message">.
+Extends L<"The message" in Mail::Box::Message|Mail::Box::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<escapedBody>()
@@ -198,11 +198,11 @@ therefore be translated.
This method will return the escaped text of the body as reference.
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
-=item $obj-E<gt>B<fromLine>([LINE])
+=item $obj-E<gt>B<fromLine>( [$line] )
Many people detest file-style folders because they store messages all in
one file, where a line starting with C<From > leads the header. If we
@@ -210,49 +210,49 @@ receive a message from a file-based folder, we store that line. If we write
to such a file, but there is no such line stored, then we try to generate
one.
-If LINE is provided, then the starting line is set to this value.
+If $line is provided, then the starting line is set to this value.
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<moveTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<seqnr>([INTEGER])
+=item $obj-E<gt>B<seqnr>( [$integer] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<size>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
Write one message to a file handle. It is the message including the
leading 'From ' line and trailing blank. The From-line may interfere
@@ -268,189 +268,189 @@ example:
=head2 The header
-See L<documentation in the base class|Mail::Box::Message/"The header">.
+Extends L<"The header" in Mail::Box::Message|Mail::Box::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Box::Message/"The body">.
+Extends L<"The body" in Mail::Box::Message|Mail::Box::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Box::Message/"Flags">.
+Extends L<"Flags" in Mail::Box::Message|Mail::Box::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Box::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Box::Message|Mail::Box::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Message/"Internals">.
+Extends L<"Internals" in Mail::Box::Message|Mail::Box::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Box::File::Message-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item Mail::Box::File::Message-E<gt>B<coerce>($message, %options)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<diskDelete>()
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
=item $obj-E<gt>B<fileLocation>()
@@ -460,134 +460,134 @@ the begin is passed back.
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<loadBody>()
-=item $obj-E<gt>B<moveLocation>(DISTANCE)
+=item $obj-E<gt>B<moveLocation>($distance)
-The message is relocated in the file, being moved over DISTANCE bytes.
+The message is relocated in the file, being moved over $distance bytes.
Setting a new location will update the according information in the header
and body.
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER)
+=item $obj-E<gt>B<readFromParser>($parser)
Read one message from a L<Mail::Box::File|Mail::Box::File> based folder, including the
leading message separator.
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Message|Mail::Box::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::File::Message-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::File::Message-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::File::Message-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::File::Message-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::File::Message-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::File::Message-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Box::File::Message-E<gt>B<shortSize>([VALUE])
+=item Mail::Box::File::Message-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Message|Mail::Box::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
-See L<Mail::Box::Message/"Cleanup">
+Inherited, see L<Mail::Box::Message/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Message|Mail::Box::Message/"DETAILS">.
=head1 DIAGNOSTICS
@@ -653,12 +653,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::File;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box';
@@ -26,7 +26,10 @@ use File::Copy;
use File::Spec;
use File::Basename;
use POSIX ':unistd_h';
-use IO::File ();
+
+# tell() is not available for open(my $fh) on perl versions <= 5.10 So,
+# we need to stick to IO::File syntax.
+use IO::File;
my $windows;
BEGIN { $windows = $^O =~ m/mswin32|cygwin/i }
@@ -124,15 +127,14 @@ sub create($@)
$class->moveAwaySubFolder($filename, $subext)
if -d $filename && defined $subext;
- if(my $create = IO::File->new($filename, 'w'))
- { $class->log(PROGRESS => "Created folder $name.");
- $create->close or return;
- }
- else
+ my $create = IO::File->new($filename, 'w');
+ unless($create)
{ $class->log(WARNING => "Cannot create folder file $name: $!");
return;
}
+ $class->log(PROGRESS => "Created folder $name.");
+ $create->close or return;
$class;
}
@@ -347,6 +349,7 @@ sub _write_new($)
my $new = IO::File->new($filename, 'w');
return 0 unless defined $new;
+ $new->binmode;
$_->write($new) foreach @{$args->{messages}};
$new->close or return 0;
@@ -368,7 +371,10 @@ sub _write_replace($)
my $tmpnew = $self->tmpNewFolder($filename);
my $new = IO::File->new($tmpnew, 'w') or return 0;
+ $new->binmode;
+
my $old = IO::File->new($filename, 'r') or return 0;
+ $old->binmode;
my ($reprint, $kept) = (0,0);
@@ -397,7 +403,7 @@ sub _write_replace($)
unless $size == $need;
$new->print($whole);
- $new->print("\n");
+ $new->print($Mail::Message::crlf_platform ? "\r\n" : "\n");
$message->moveLocation($newbegin - $oldbegin);
$kept++;
@@ -453,7 +459,6 @@ sub _write_inplace($)
my $mode = $^O eq 'MSWin32' ? 'a' : 'r+';
my $filename = $self->filename;
-
my $old = IO::File->new($filename, $mode) or return 0;
# Chop the folder after the messages which does not have to change.
@@ -23,39 +23,39 @@ which bundle multiple messages into one single file. Usually, these
messages are separated by a special line which indicates the start of
the next one.
-See L<documentation in the base class|Mail::Box/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box|Mail::Box/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Box/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Box|Mail::Box/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Box/"METHODS">.
+Extends L<"METHODS" in Mail::Box|Mail::Box/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box/"Constructors">.
+Extends L<"Constructors" in Mail::Box|Mail::Box/"Constructors">.
=over 4
-=item Mail::Box::File-E<gt>B<new>(OPTIONS)
+=item Mail::Box::File-E<gt>B<new>(%options)
-Option --Defined in --Default
access Mail::Box 'r'
@@ -183,26 +183,26 @@ L<write(policy)|Mail::Box::File/"Internals">. With C<undef>, the best policy is
=head2 The folder
-See L<documentation in the base class|Mail::Box/"The folder">.
+Extends L<"The folder" in Mail::Box|Mail::Box/"The folder">.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<addMessage>($message, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<addMessages>(MESSAGE [, MESSAGE, ...])
+=item $obj-E<gt>B<addMessages>(@messages)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item Mail::Box::File-E<gt>B<appendMessages>(OPTIONS)
+=item Mail::Box::File-E<gt>B<appendMessages>(%options)
Appending messages to a file based folder which is not opened is a little
risky. In practice, this is often done without locking the folder. So,
another application may write to the folder at the same time... :( Hopefully,
all goes fast enough that the chance on collition is small.
-All OPTIONS of L<Mail::Box::Mbox::new()|Mail::Box::Mbox/"METHODS"> can be supplied.
+All %options of L<Mail::Box::Mbox::new()|Mail::Box::Mbox/"METHODS"> can be supplied.
-Option --Defined in --Default
folder Mail::Box <required>
@@ -227,17 +227,17 @@ See L<Mail::Box::new(lock_type)|Mail::Box/"Constructors"> for possible values.
=back
-=item $obj-E<gt>B<close>(OPTIONS)
+=item $obj-E<gt>B<close>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<delete>(OPTIONS)
+=item $obj-E<gt>B<delete>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<filename>()
@@ -248,151 +248,151 @@ example:
print $folder->filename;
-=item $obj-E<gt>B<folderdir>([DIRECTORY])
+=item $obj-E<gt>B<folderdir>( [$directory] )
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<name>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<update>(OPTIONS)
+=item $obj-E<gt>B<update>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<url>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=back
=head2 Folder flags
-See L<documentation in the base class|Mail::Box/"Folder flags">.
+Extends L<"Folder flags" in Mail::Box|Mail::Box/"Folder flags">.
=over 4
=item $obj-E<gt>B<access>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=back
=head2 The messages
-See L<documentation in the base class|Mail::Box/"The messages">.
+Extends L<"The messages" in Mail::Box|Mail::Box/"The messages">.
=over 4
-=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
+=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<find>(MESSAGE-ID)
+=item $obj-E<gt>B<find>($message_id)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
+=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
+=item $obj-E<gt>B<message>( $index, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
+=item $obj-E<gt>B<messageId>( $message_id, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
+=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<nrMessages>(OPTIONS)
+=item $obj-E<gt>B<nrMessages>(%options)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
+=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=back
=head2 Sub-folders
-See L<documentation in the base class|Mail::Box/"Sub-folders">.
+Extends L<"Sub-folders" in Mail::Box|Mail::Box/"Sub-folders">.
=over 4
-=item $obj-E<gt>B<listSubFolders>(OPTIONS)
+=item $obj-E<gt>B<listSubFolders>(%options)
-=item Mail::Box::File-E<gt>B<listSubFolders>(OPTIONS)
+=item Mail::Box::File-E<gt>B<listSubFolders>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-=item Mail::Box::File-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item Mail::Box::File-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
+=item $obj-E<gt>B<openRelatedFolder>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openSubFolder>(SUBNAME, OPTIONS)
+=item $obj-E<gt>B<openSubFolder>($subname, %options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<topFolderWithMessages>()
=item Mail::Box::File-E<gt>B<topFolderWithMessages>()
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box/"Internals">.
+Extends L<"Internals" in Mail::Box|Mail::Box/"Internals">.
=over 4
-=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<coerce>($message, %options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item $obj-E<gt>B<create>($foldername, %options)
-=item Mail::Box::File-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item Mail::Box::File-E<gt>B<create>($foldername, %options)
-Option --Defined in--Default
folderdir Mail::Box undef
@@ -403,42 +403,42 @@ See L<Mail::Box/"Internals">
=back
-=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
+=item $obj-E<gt>B<determineBodyType>($message, $head)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<folderToFilename>(FOLDERNAME, FOLDERDIR, [SUBEXT])
+=item $obj-E<gt>B<folderToFilename>( $foldername, $folderdir, [$subext] )
-=item Mail::Box::File-E<gt>B<folderToFilename>(FOLDERNAME, FOLDERDIR, [SUBEXT])
+=item Mail::Box::File-E<gt>B<folderToFilename>( $foldername, $folderdir, [$subext] )
Translate a folder name into a filename, using the
-FOLDERDIR value to replace a leading C<=>. SUBEXT is only used for MBOX
+$folderdir value to replace a leading C<=>. $subext is only used for MBOX
folders.
-=item Mail::Box::File-E<gt>B<foundIn>([FOLDERNAME], OPTIONS)
+=item Mail::Box::File-E<gt>B<foundIn>( [$foldername], %options )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
+=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<messageCreateOptions>([TYPE, CONFIG])
+=item $obj-E<gt>B<messageCreateOptions>( [$type, $config] )
Returns a key-value list of options to be used each time a new message
-is read from a file. The list is preceded by the TYPE of message which
+is read from a file. The list is preceded by the $type of message which
has to be created.
This data is used by L<readMessages()|Mail::Box/"Internals"> and L<updateMessages()|Mail::Box::File/"Internals">. With
-TYPE and CONFIG, a new configuration is set.
+$type and $config, a new configuration is set.
-=item $obj-E<gt>B<moveAwaySubFolder>(DIRECTORY, EXTENSION)
+=item $obj-E<gt>B<moveAwaySubFolder>($directory, $extension)
-The DIRECTORY is renamed by appending the EXTENSION, which defaults to C<".d">,
+The $directory is renamed by appending the $extension, which defaults to C<".d">,
to make place for a folder file on that specific location. C<false> is
returned if this failed.
@@ -447,33 +447,33 @@ returned if this failed.
Create a parser for this mailbox. The parser stays alive as long as
the folder is open.
-=item $obj-E<gt>B<read>(OPTIONS)
+=item $obj-E<gt>B<read>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<readMessages>(OPTIONS)
+=item $obj-E<gt>B<readMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<storeMessage>(MESSAGE)
+=item $obj-E<gt>B<storeMessage>($message)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<updateMessages>(OPTIONS)
+=item $obj-E<gt>B<updateMessages>(%options)
For file based folders, the file handle stays open until the folder
is closed. Update is therefore rather simple: move to the end
of the last known message, and continue reading...
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-Option --Defined in --Default
force Mail::Box <false>
@@ -534,97 +534,97 @@ possible as well.
=back
-=item $obj-E<gt>B<writeMessages>(OPTIONS)
+=item $obj-E<gt>B<writeMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Box/"Other methods">.
+Extends L<"Other methods" in Mail::Box|Mail::Box/"Other methods">.
=over 4
-=item $obj-E<gt>B<timespan2seconds>(TIME)
+=item $obj-E<gt>B<timespan2seconds>($time)
-=item Mail::Box::File-E<gt>B<timespan2seconds>(TIME)
+=item Mail::Box::File-E<gt>B<timespan2seconds>($time)
-See L<Mail::Box/"Other methods">
+Inherited, see L<Mail::Box/"Other methods">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box/"Error handling">.
+Extends L<"Error handling" in Mail::Box|Mail::Box/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::File-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::File-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::File-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::File-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::File-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::File-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box|Mail::Box/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box/"Cleanup">
+Inherited, see L<Mail::Box/"Cleanup">
=back
@@ -645,7 +645,7 @@ the whole folder must be read.
=head1 DETAILS
-See L<documentation in the base class|Mail::Box/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box|Mail::Box/"DETAILS">.
=head1 DIAGNOSTICS
@@ -779,12 +779,12 @@ error messages to indicate the real problem.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,13 +1,12 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
-
use strict;
package Mail::Box::IMAP4::Head;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Head';
@@ -57,5 +56,4 @@ sub guessTimestamp() {undef}
#------------------------------------------
-
1;
@@ -24,39 +24,39 @@ get a message header which is capable of performing all possible
games with headers. On the other hand: the other settings are not
100% safe...
-See L<documentation in the base class|Mail::Message::Head/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Head|Mail::Message::Head/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Head/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Head|Mail::Message::Head/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Head/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Head|Mail::Message::Head/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Head/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Head|Mail::Message::Head/"Constructors">.
=over 4
-=item Mail::Box::IMAP4::Head-E<gt>B<build>([PAIR|FIELD]-LIST)
+=item Mail::Box::IMAP4::Head-E<gt>B<build>( [PAIR|$field]-LIST )
-See L<Mail::Message::Head/"Constructors">
+Inherited, see L<Mail::Message::Head/"Constructors">
-=item Mail::Box::IMAP4::Head-E<gt>B<new>(OPTIONS)
+=item Mail::Box::IMAP4::Head-E<gt>B<new>(%options)
-Option --Defined in --Default
cache_fields false
@@ -90,186 +90,186 @@ this value is set to C<false> for C<NO> and C<true> for C<PARTIAL>..
=head2 The header
-See L<documentation in the base class|Mail::Message::Head/"The header">.
+Extends L<"The header" in Mail::Message::Head|Mail::Message::Head/"The header">.
=over 4
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isEmpty>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<knownNames>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<orderedFields>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=back
=head2 Access to the header
-See L<documentation in the base class|Mail::Message::Head/"Access to the header">.
+Extends L<"Access to the header" in Mail::Message::Head|Mail::Message::Head/"Access to the header">.
=over 4
-=item $obj-E<gt>B<get>(NAME [,INDEX])
+=item $obj-E<gt>B<get>( $name, [$index] )
-Get the information about the header line NAME. Realization will
+Get the information about the header line $name. Realization will
take place.
-=item $obj-E<gt>B<study>(NAME [,INDEX])
+=item $obj-E<gt>B<study>( $name, [$index] )
-See L<Mail::Message::Head/"Access to the header">
+Inherited, see L<Mail::Message::Head/"Access to the header">
=back
=head2 About the body
-See L<documentation in the base class|Mail::Message::Head/"About the body">.
+Extends L<"About the body" in Mail::Message::Head|Mail::Message::Head/"About the body">.
=over 4
=item $obj-E<gt>B<guessBodySize>()
-See L<Mail::Message::Head/"About the body">
+Inherited, see L<Mail::Message::Head/"About the body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message::Head/"About the body">
+Inherited, see L<Mail::Message::Head/"About the body">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Head/"Internals">.
+Extends L<"Internals" in Mail::Message::Head|Mail::Message::Head/"Internals">.
=over 4
-=item $obj-E<gt>B<addNoRealize>(FIELD)
+=item $obj-E<gt>B<addNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<addOrderedFields>(FIELDS)
+=item $obj-E<gt>B<addOrderedFields>($fields)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<fileLocation>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<load>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<moveLocation>(DISTANCE)
+=item $obj-E<gt>B<moveLocation>($distance)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<read>(PARSER)
+=item $obj-E<gt>B<read>($parser)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<setNoRealize>(FIELD)
+=item $obj-E<gt>B<setNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Head/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Head|Mail::Message::Head/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::IMAP4::Head-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::IMAP4::Head-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::IMAP4::Head-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::IMAP4::Head-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::IMAP4::Head-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::IMAP4::Head-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Head/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Head|Mail::Message::Head/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Head/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Head|Mail::Message::Head/"DETAILS">.
=head1 DIAGNOSTICS
@@ -287,12 +287,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Box::IMAP4::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Net::Message';
@@ -24,23 +24,23 @@ maintained by a L<Mail::Box::IMAP4|Mail::Box::IMAP4> folder. Each message is sto
separate entity on the server, and maybe temporarily in your program
as well.
-See L<documentation in the base class|Mail::Box::Net::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Net::Message|Mail::Box::Net::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Net::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Net::Message|Mail::Box::Net::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Net::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Box::IMAP4::Message-E<gt>B<new>(OPTIONS)
+=item Mail::Box::IMAP4::Message-E<gt>B<new>(%options)
-Option --Defined in --Default
body Mail::Message undef
@@ -119,127 +119,127 @@ changes in the same folder, and will get the updates too late or never...
=head2 Constructing a message
-See L<documentation in the base class|Mail::Box::Net::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Box::IMAP4::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Box::IMAP4::Message-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Box::IMAP4::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Box::IMAP4::Message-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Box::IMAP4::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Box::IMAP4::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Box::IMAP4::Message-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Box::Net::Message/"The message">.
+Extends L<"The message" in Mail::Box::Net::Message|Mail::Box::Net::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<moveTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<seqnr>([INTEGER])
+=item $obj-E<gt>B<seqnr>( [$integer] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<size>()
@@ -250,143 +250,143 @@ sizes can differ because the difference in line-ending representation.
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<unique>([STRING|undef])
+=item $obj-E<gt>B<unique>( [STRING|undef] )
-See L<Mail::Box::Net::Message/"The message">
+Inherited, see L<Mail::Box::Net::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=back
=head2 The header
-See L<documentation in the base class|Mail::Box::Net::Message/"The header">.
+Extends L<"The header" in Mail::Box::Net::Message|Mail::Box::Net::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Box::Net::Message/"The body">.
+Extends L<"The body" in Mail::Box::Net::Message|Mail::Box::Net::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Box::Net::Message/"Flags">.
+Extends L<"Flags" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-With only one argument, the value related to LABEL is returned. With
+With only one argument, the value related to $label is returned. With
more that one argument, the list is interpreted a label-value PAIRS
to be set.
@@ -404,106 +404,106 @@ to the remote server. See L<labels()|Mail::Box::IMAP4::Message/"METHODS"> to se
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Box::Net::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Box::Net::Message|Mail::Box::Net::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Net::Message/"Internals">.
+Extends L<"Internals" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Box::IMAP4::Message-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item Mail::Box::IMAP4::Message-E<gt>B<coerce>($message, %options)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<diskDelete>()
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
-=item $obj-E<gt>B<fetch>([INFO, ...])
+=item $obj-E<gt>B<fetch>( [$info, ...] )
Use the IMAP's C<UID FETCH IMAP> command to get some data about this
-message. The INFO request is passed to L<Mail::Box::IMAP4::fetch()|Mail::Box::IMAP4/"Internals">.
-Without INFO, C<ALL> information is retrieved and returned as a HASH.
+message. The $info request is passed to L<Mail::Box::IMAP4::fetch()|Mail::Box::IMAP4/"Internals">.
+Without $info, C<ALL> information is retrieved and returned as a HASH.
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<loadBody>()
-See L<Mail::Box::Net::Message/"Internals">
+Inherited, see L<Mail::Box::Net::Message/"Internals">
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<writeDelayed>(IMAP)
+=item $obj-E<gt>B<writeDelayed>($imap)
Write all delayed information, like label changes, to the server. This
is done under force, so should even be done for folders opened without
write-access. This method is called indirectly by a L<Mail::Box::write()|Mail::Box/"Internals">
or L<Mail::Box::close()|Mail::Box/"The folder">.
-The IMAP argument is a Mail::IMAPClient which has the right folder
+The $imap argument is a Mail::IMAPClient which has the right folder
already selected.
Writing changes to the remote folder is not without hassle: IMAP4
@@ -516,119 +516,119 @@ for deletion.
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Net::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::IMAP4::Message-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::IMAP4::Message-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::IMAP4::Message-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::IMAP4::Message-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::IMAP4::Message-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::IMAP4::Message-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Box::IMAP4::Message-E<gt>B<shortSize>([VALUE])
+=item Mail::Box::IMAP4::Message-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Net::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
-See L<Mail::Box::Message/"Cleanup">
+Inherited, see L<Mail::Box::Message/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Net::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Net::Message|Mail::Box::Net::Message/"DETAILS">.
=head2 Structure of a Message
-See L<documentation in the base class|Mail::Box::Net::Message/"Structure of a Message">.
+Extends L<"Structure of a Message" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Structure of a Message">.
=head2 Message object implementation
-See L<documentation in the base class|Mail::Box::Net::Message/"Message object implementation">.
+Extends L<"Message object implementation" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Message object implementation">.
=head2 Message class implementation
-See L<documentation in the base class|Mail::Box::Net::Message/"Message class implementation">.
+Extends L<"Message class implementation" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Message class implementation">.
=head2 Labels
-See L<documentation in the base class|Mail::Box::Net::Message/"Labels">.
+Extends L<"Labels" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Labels">.
=head3 Predefined labels
-See L<documentation in the base class|Mail::Box::Net::Message/"Predefined labels">.
+Extends L<"Predefined labels" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Predefined labels">.
=head3 Status and X-Status fields
-See L<documentation in the base class|Mail::Box::Net::Message/"Status and X-Status fields">.
+Extends L<"Status and X-Status fields" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Status and X-Status fields">.
=head3 IMAP protocol flags
@@ -733,12 +733,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Box::IMAP4;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Net';
@@ -344,5 +344,4 @@ sub fetch($@)
#-------------------------------------------
-
1;
@@ -27,42 +27,42 @@ information, and focusses solely on the correct handling of messages
within a IMAP4 folder. More than one IMAP4 folder can be handled by
one single IMAP4 connection.
-See L<documentation in the base class|Mail::Box::Net/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Net|Mail::Box::Net/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Box::Net/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Box::Net|Mail::Box::Net/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Net/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Net|Mail::Box::Net/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Net/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Net|Mail::Box::Net/"Constructors">.
=over 4
-=item Mail::Box::IMAP4-E<gt>B<new>(OPTIONS)
+=item Mail::Box::IMAP4-E<gt>B<new>(%options)
-The C<new> can have many OPTIONS. Not only the ones listed here below,
-but also all the OPTIONS for L<Mail::Transport::IMAP4::new()|Mail::Transport::IMAP4/"METHODS"> can be
+The C<new> can have many %options. Not only the ones listed here below,
+but also all the %options for L<Mail::Transport::IMAP4::new()|Mail::Transport::IMAP4/"METHODS"> can be
passed.
The default depends on the value of L<new(cache_head)|Mail::Box::IMAP4/"METHODS">.
@@ -84,7 +84,7 @@ folder names. Usually, the folder named C<INBOX> will be present.
field_type Mail::Box undef
fix_headers Mail::Box <false>
folder Mail::Box /
- folderdir Mail::Box <not used>
+ folderdir Mail::Box <network location>
head_delayed_type Mail::Box Mail::Message::Head::Delayed
head_type Mail::Box Mail::Box::IMAP4::Head or Mail::Message::Head::Complete
join_connection true
@@ -259,23 +259,23 @@ example:
=head2 The folder
-See L<documentation in the base class|Mail::Box::Net/"The folder">.
+Extends L<"The folder" in Mail::Box::Net|Mail::Box::Net/"The folder">.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<addMessage>($message, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<addMessages>(MESSAGE [, MESSAGE, ...])
+=item $obj-E<gt>B<addMessages>(@messages)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item Mail::Box::IMAP4-E<gt>B<appendMessages>(OPTIONS)
+=item Mail::Box::IMAP4-E<gt>B<appendMessages>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<close>(OPTIONS)
+=item $obj-E<gt>B<close>(%options)
Close the folder. In the case of IMAP, more than one folder can use
the same connection, therefore, closing a folder does not always close
@@ -298,168 +298,168 @@ L<Mail::Transport::IMAP4::DESTROY()|Mail::Transport::IMAP4/"Cleanup">
=back
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<delete>(OPTIONS)
+=item $obj-E<gt>B<delete>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<folderdir>([DIRECTORY])
+=item $obj-E<gt>B<folderdir>( [$directory] )
-See L<Mail::Box::Net/"METHODS">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<name>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<update>(OPTIONS)
+=item $obj-E<gt>B<update>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<url>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=back
=head2 Folder flags
-See L<documentation in the base class|Mail::Box::Net/"Folder flags">.
+Extends L<"Folder flags" in Mail::Box::Net|Mail::Box::Net/"Folder flags">.
=over 4
=item $obj-E<gt>B<access>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=back
=head2 The messages
-See L<documentation in the base class|Mail::Box::Net/"The messages">.
+Extends L<"The messages" in Mail::Box::Net|Mail::Box::Net/"The messages">.
=over 4
-=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
+=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<find>(MESSAGE-ID)
+=item $obj-E<gt>B<find>($message_id)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
+=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
+=item $obj-E<gt>B<message>( $index, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
+=item $obj-E<gt>B<messageId>( $message_id, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
+=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<nrMessages>(OPTIONS)
+=item $obj-E<gt>B<nrMessages>(%options)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
+=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=back
=head2 Sub-folders
-See L<documentation in the base class|Mail::Box::Net/"Sub-folders">.
+Extends L<"Sub-folders" in Mail::Box::Net|Mail::Box::Net/"Sub-folders">.
=over 4
-=item $obj-E<gt>B<listSubFolders>(OPTIONS)
+=item $obj-E<gt>B<listSubFolders>(%options)
-=item Mail::Box::IMAP4-E<gt>B<listSubFolders>(OPTIONS)
+=item Mail::Box::IMAP4-E<gt>B<listSubFolders>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-=item Mail::Box::IMAP4-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item Mail::Box::IMAP4-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
+=item $obj-E<gt>B<openRelatedFolder>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openSubFolder>(SUBNAME, OPTIONS)
+=item $obj-E<gt>B<openSubFolder>($subname, %options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<topFolderWithMessages>()
=item Mail::Box::IMAP4-E<gt>B<topFolderWithMessages>()
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Net/"Internals">.
+Extends L<"Internals" in Mail::Box::Net|Mail::Box::Net/"Internals">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<coerce>($message, %options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<create>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<create>($folder, %options)
-=item Mail::Box::IMAP4-E<gt>B<create>(FOLDER, OPTIONS)
+=item Mail::Box::IMAP4-E<gt>B<create>($folder, %options)
-See L<Mail::Box::Net/"METHODS">
+Inherited, see L<Mail::Box::Net/"METHODS">
-=item $obj-E<gt>B<createTransporter>(CLASS, OPTIONS)
+=item $obj-E<gt>B<createTransporter>($class, %options)
Create a transporter object (an instance of L<Mail::Transport::IMAP4|Mail::Transport::IMAP4>), where
-CLASS defines the exact object type. As OPTIONS, everything which is
+$class defines the exact object type. As %options, everything which is
acceptable to a transporter initiation can be used (see
L<Mail::Transport::IMAP4::new()|Mail::Transport::IMAP4/"METHODS">.
@@ -475,11 +475,11 @@ with other IMAP mail boxes.
=back
-=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
+=item $obj-E<gt>B<determineBodyType>($message, $head)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<fetch>(ARRAY-OF-MESSAGES|MESSAGE-SELECTION, INFO)
+=item $obj-E<gt>B<fetch>( <$messages|$selection>, $info )
Low-level data retreival about one or more messages via IMAP4 from
the remote server. Some of this data may differ from the information
@@ -488,68 +488,68 @@ so you should avoid the use of this method for your own purposes.
The IMAP implementation provides some wrappers around this, providing
the correct behavior.
-An array of MESSAGES may be specified or some MESSAGE SELECTION,
+An ARRAY of $messages may be specified or some message $selection,
acceptable to L<Mail::Box::messages()|Mail::Box/"The messages">. Examples of the latter are
C<'ALL'>, C<'DELETED'>, or C<spam> (messages labelled to contain spam).
-The INFO contains one or more attributes as defined by the IMAP protocol.
+The $info contains one or more attributes as defined by the IMAP protocol.
You have to read the full specs of the related RFCs to see these.
-=item Mail::Box::IMAP4-E<gt>B<foundIn>([FOLDERNAME], OPTIONS)
+=item Mail::Box::IMAP4-E<gt>B<foundIn>( [$foldername], %options )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<getHead>(MESSAGE)
+=item $obj-E<gt>B<getHead>($message)
Read the header for the specified message from the remote server.
C<undef> is returned in case the message disappeared.
-=item $obj-E<gt>B<getHeadAndBody>(MESSAGE)
+=item $obj-E<gt>B<getHeadAndBody>($message)
Read all data for the specified message from the remote server.
Return head and body of the mesasge as list, or an empty list
-if the MESSAGE disappeared from the server.
+if the $message disappeared from the server.
-=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
+=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<read>(OPTIONS)
+=item $obj-E<gt>B<read>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<readMessages>(OPTIONS)
+=item $obj-E<gt>B<readMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<storeMessage>(MESSAGE)
+=item $obj-E<gt>B<storeMessage>($message)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<transporter>([OBJECT])
+=item $obj-E<gt>B<transporter>( [$object] )
Returns the object which is the interface to the IMAP4 protocol handler.
The IMAP4 handler has the current folder selected.
-When an OBJECT is specified, it is set to be the transporter from
-that moment on. The OBJECT must extend L<Mail::Transport::IMAP4|Mail::Transport::IMAP4>.
+When an $object is specified, it is set to be the transporter from
+that moment on. The $object must extend L<Mail::Transport::IMAP4|Mail::Transport::IMAP4>.
-=item $obj-E<gt>B<updateMessages>(OPTIONS)
+=item $obj-E<gt>B<updateMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
The IMAP protocol usually writes the data immediately to the remote server,
because that's what the protocol wants. However, some options to L<new()|Mail::Box::IMAP4/"METHODS">
@@ -571,7 +571,7 @@ but they will be removed anyway when the folder is closed.
=back
-=item $obj-E<gt>B<writeMessages>(OPTIONS)
+=item $obj-E<gt>B<writeMessages>(%options)
-Option --Defined in --Default
messages Mail::Box <required>
@@ -589,95 +589,95 @@ but they will be removed anyway when the folder is closed.
=head2 Other methods
-See L<documentation in the base class|Mail::Box::Net/"Other methods">.
+Extends L<"Other methods" in Mail::Box::Net|Mail::Box::Net/"Other methods">.
=over 4
-=item $obj-E<gt>B<timespan2seconds>(TIME)
+=item $obj-E<gt>B<timespan2seconds>($time)
-=item Mail::Box::IMAP4-E<gt>B<timespan2seconds>(TIME)
+=item Mail::Box::IMAP4-E<gt>B<timespan2seconds>($time)
-See L<Mail::Box/"Other methods">
+Inherited, see L<Mail::Box/"Other methods">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Net/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Net|Mail::Box::Net/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::IMAP4-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::IMAP4-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::IMAP4-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::IMAP4-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::IMAP4-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::IMAP4-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Net/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Net|Mail::Box::Net/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box/"Cleanup">
+Inherited, see L<Mail::Box/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Net/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Net|Mail::Box::Net/"DETAILS">.
=head1 DIAGNOSTICS
@@ -767,12 +767,12 @@ to copy one of these. Copying will proceed for all other sub-folders.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Box::Identity;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base qw/User::Identity::Item Mail::Reporter/;
@@ -199,13 +199,7 @@ sub folder(@)
sub open(@)
{ my $self = shift;
- my $mgr = $self->manager;
-
- $mgr->open
- ( $self->fullname
- , type => $self->folderType
- , @_
- );
+ $self->manager->open($self->fullname, type => $self->folderType, @_);
}
#-------------------------------------------
@@ -35,25 +35,25 @@ object. This corresponds with IMAP's C<\NoSelect>, for instance.
Nearly all methods can return undef.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
-See L<documentation in the base class|User::Identity::Item/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in User::Identity::Item|User::Identity::Item/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
-See L<documentation in the base class|User::Identity::Item/"METHODS">.
+Extends L<"METHODS" in User::Identity::Item|User::Identity::Item/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
-See L<documentation in the base class|User::Identity::Item/"Constructors">.
+Extends L<"Constructors" in User::Identity::Item|User::Identity::Item/"Constructors">.
=over 4
-=item Mail::Box::Identity-E<gt>B<new>([NAME], OPTIONS)
+=item Mail::Box::Identity-E<gt>B<new>( [$name], %options )
-Option --Defined in --Default
deleted <false>
@@ -124,30 +124,30 @@ L<Mail::Box::Collection|Mail::Box::Collection>.
=head2 Attributes
-See L<documentation in the base class|User::Identity::Item/"Attributes">.
+Extends L<"Attributes" in User::Identity::Item|User::Identity::Item/"Attributes">.
=over 4
=item $obj-E<gt>B<description>()
-See L<User::Identity::Item/"Attributes">
+Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<folderType>()
Returns the type of this folder.
-=item $obj-E<gt>B<fullname>([DELIMETER])
+=item $obj-E<gt>B<fullname>( [$delimeter] )
Returns the name of the folder, from the toplevel until this one, with
-the DELIMETER string between each level. DELIMETER default to a forward
+the $delimeter string between each level. $delimeter default to a forward
slash (a C</>).
-=item $obj-E<gt>B<inferiors>([BOOLEAN])
+=item $obj-E<gt>B<inferiors>( [BOOLEAN] )
C<Inferiors> are C<subfolders>. When this flag is set, it is permitted
to create subfolders.
-=item $obj-E<gt>B<location>([FILENAME|DIRECTORY|undef])
+=item $obj-E<gt>B<location>( [$filename|$directory|undef] )
Returns the directory or filename of the folder. If this is not pre-defined,
it is computed based on the knowledge about the folder type. Be sure to set
@@ -159,18 +159,18 @@ this to work.
Returns the manager (usually a L<Mail::Box::Manage::User|Mail::Box::Manage::User> which owns
the folders. May be undefined, by default from parent.
-=item $obj-E<gt>B<marked>([BOOLEAN|undef])
+=item $obj-E<gt>B<marked>( [BOOLEAN|undef] )
When something special has happened with the folder, this flag can
be set (or cleared). The C<undef> status is an "unknown". In the
IMAP4 protocol, C<0> will result in a C<\Unmarked>, a C<1> results
in a C<\Marked>, and C<undef> in nothing.
-=item $obj-E<gt>B<name>([NEWNAME])
+=item $obj-E<gt>B<name>( [NEWNAME] )
-See L<User::Identity::Item/"Attributes">
+Inherited, see L<User::Identity::Item/"Attributes">
-=item $obj-E<gt>B<onlySubfolders>([BOOLEAN])
+=item $obj-E<gt>B<onlySubfolders>( [BOOLEAN] )
Than this folder be opened (without trying) or not? The default
depends on the folder type, and whether this is the toplevel folder
@@ -184,43 +184,43 @@ Run up the tree to find the highest level folder.
=head2 Collections
-See L<documentation in the base class|User::Identity::Item/"Collections">.
+Extends L<"Collections" in User::Identity::Item|User::Identity::Item/"Collections">.
=over 4
=item $obj-E<gt>B<add>(COLLECTION, ROLE)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<addCollection>(OBJECT | ([TYPE], OPTIONS))
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<collection>(NAME)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<find>(COLLECTION, ROLE)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
-=item $obj-E<gt>B<parent>([PARENT])
+=item $obj-E<gt>B<parent>( [PARENT] )
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<removeCollection>(OBJECT|NAME)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<type>()
=item Mail::Box::Identity-E<gt>B<type>()
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<user>()
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=back
@@ -228,16 +228,16 @@ See L<User::Identity::Item/"Collections">
=over 4
-=item $obj-E<gt>B<addSubfolder>(L<Mail::Box::Identity|Mail::Box::Identity>|DATA)
+=item $obj-E<gt>B<addSubfolder>($m<Mail::Box::Identity>|$data)
-Add a new folder into the administration. With DATA, a new object
+Add a new folder into the administration. With $data, a new object
will be instantiated first. The identity is returned on success.
-=item $obj-E<gt>B<folder>([[NAME, ...], NAME])
+=item $obj-E<gt>B<folder>( [..., $name] )
-Returns the subfolder's object with NAME or C<undef> if it does not
+Returns the subfolder's object with $name or C<undef> if it does not
exist. When multiple NAMEs are added, those super folders are traverst
-first. Without any NAME, the current object is returned
+first. Without any $name, the current object is returned
example: get some folder
@@ -253,23 +253,23 @@ For each of the subfolders found below this point call CODE. This current
folder is called first. Be warned that you may find identities with
the Mail::Box::Identity subroutine deleted flag on.
-=item $obj-E<gt>B<open>(OPTIONS)
+=item $obj-E<gt>B<open>(%options)
Open the folder which is described by this identity. Returned is some
L<Mail::Box|Mail::Box>. The options are passed to L<Mail::Box::Manager::open()|Mail::Box::Manager/"Manage open folders">.
-=item $obj-E<gt>B<remove>([NAME])
+=item $obj-E<gt>B<remove>( [$name] )
-Remove the folder (plus subfolders) with the NAME. Without NAME, this
+Remove the folder (plus subfolders) with the $name. Without $name, this
C<Mail::Box::Identity> itself is removed.
The removed structure is returned, which is C<undef> if not
found. This is only an administrative remove, you still need a
L<Mail::Box::Manager::delete()|Mail::Box::Manager/"Manage existing folders">.
-=item $obj-E<gt>B<rename>(FOLDER, [NEWSUBNAME])
+=item $obj-E<gt>B<rename>( $folder, [$newsubname] )
-Move the folder to a different super-FOLDER, under a NEW SUBfolder NAME.
+Move the folder to a different super-$folder, under a NEW SUBfolder NAME.
example: renaming a folder
@@ -295,75 +295,75 @@ the collection, the L<Mail::Box::Collection|Mail::Box::Collection>.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Identity-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Identity-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Identity-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Identity-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Identity-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Identity-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -396,7 +396,7 @@ the latter case, the type of collection must be specified.
=item Error: It is not permitted to add subfolders to $name
-The L<inferiors()|Mail::Box::Identity/"Attributes"> flag prohibits the creation of subfolders to this
+The $m<inferiors()> flag prohibits the creation of subfolders to this
folder.
=item Warning: No collection $name
@@ -426,12 +426,12 @@ you have to look for a method of that object.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Box::Locker::DotLock;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Locker';
@@ -19,19 +19,19 @@ Mail::Box::Locker::DotLock - lock a folder with a separate file
The C<::DotLock> object lock the folder by creating a file with the
same name as the folder, extended by C<.lock>.
-See L<documentation in the base class|Mail::Box::Locker/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Locker|Mail::Box::Locker/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Locker/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Locker|Mail::Box::Locker/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Locker/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Locker|Mail::Box::Locker/"Constructors">.
=over 4
-=item Mail::Box::Locker::DotLock-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Locker::DotLock-E<gt>B<new>(%options)
Name of the file to lock. By default, the folder's name is extended
with C<.lock>.
@@ -73,37 +73,37 @@ the multi locker is used.
=head2 The Locker
-See L<documentation in the base class|Mail::Box::Locker/"The Locker">.
+Extends L<"The Locker" in Mail::Box::Locker|Mail::Box::Locker/"The Locker">.
=over 4
-=item $obj-E<gt>B<filename>([FILENAME])
+=item $obj-E<gt>B<filename>( [$filename] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=item $obj-E<gt>B<name>()
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=back
=head2 Locking
-See L<documentation in the base class|Mail::Box::Locker/"Locking">.
+Extends L<"Locking" in Mail::Box::Locker|Mail::Box::Locker/"Locking">.
=over 4
=item $obj-E<gt>B<hasLock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<isLocked>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<lock>()
@@ -113,75 +113,75 @@ See L<Mail::Box::Locker/"Locking">
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Locker/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Locker|Mail::Box::Locker/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Locker::DotLock-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Locker::DotLock-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Locker::DotLock-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Locker::DotLock-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Locker::DotLock-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Locker::DotLock-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Locker/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Locker|Mail::Box::Locker/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box::Locker/"Cleanup">
+Inherited, see L<Mail::Box::Locker/"Cleanup">
=back
@@ -209,12 +209,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Box::Locker::FcntlLock;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Locker';
@@ -23,19 +23,19 @@ on more systems, for instance Darwin.
You will need to install File::FcntlLock separately: there is no
dependency to it by the MailBox distribution.
-See L<documentation in the base class|Mail::Box::Locker/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Locker|Mail::Box::Locker/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Locker/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Locker|Mail::Box::Locker/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Locker/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Locker|Mail::Box::Locker/"Constructors">.
=over 4
-=item Mail::Box::Locker::FcntlLock-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Locker::FcntlLock-E<gt>B<new>(%options)
-Option --Defined in --Default
expires Mail::Box::Locker 1 hour
@@ -68,33 +68,33 @@ See L<documentation in the base class|Mail::Box::Locker/"Constructors">.
=head2 The Locker
-See L<documentation in the base class|Mail::Box::Locker/"The Locker">.
+Extends L<"The Locker" in Mail::Box::Locker|Mail::Box::Locker/"The Locker">.
=over 4
-=item $obj-E<gt>B<filename>([FILENAME])
+=item $obj-E<gt>B<filename>( [$filename] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=item $obj-E<gt>B<name>()
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=back
=head2 Locking
-See L<documentation in the base class|Mail::Box::Locker/"Locking">.
+Extends L<"Locking" in Mail::Box::Locker|Mail::Box::Locker/"Locking">.
=over 4
=item $obj-E<gt>B<hasLock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<isLocked>()
@@ -102,81 +102,81 @@ See L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<unlock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Locker/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Locker|Mail::Box::Locker/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Locker::FcntlLock-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Locker::FcntlLock-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Locker::FcntlLock-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Locker::FcntlLock-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Locker::FcntlLock-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Locker::FcntlLock-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Locker/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Locker|Mail::Box::Locker/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box::Locker/"Cleanup">
+Inherited, see L<Mail::Box::Locker/"Cleanup">
=back
@@ -215,12 +215,12 @@ try again.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Box::Locker::Flock;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Locker';
@@ -24,19 +24,19 @@ is reading.
File locking does not work in some situations, for instance for
operating systems do not support C<flock>.
-See L<documentation in the base class|Mail::Box::Locker/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Locker|Mail::Box::Locker/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Locker/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Locker|Mail::Box::Locker/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Locker/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Locker|Mail::Box::Locker/"Constructors">.
=over 4
-=item Mail::Box::Locker::Flock-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Locker::Flock-E<gt>B<new>(%options)
-Option --Defined in --Default
expires Mail::Box::Locker 1 hour
@@ -69,33 +69,33 @@ See L<documentation in the base class|Mail::Box::Locker/"Constructors">.
=head2 The Locker
-See L<documentation in the base class|Mail::Box::Locker/"The Locker">.
+Extends L<"The Locker" in Mail::Box::Locker|Mail::Box::Locker/"The Locker">.
=over 4
-=item $obj-E<gt>B<filename>([FILENAME])
+=item $obj-E<gt>B<filename>( [$filename] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=item $obj-E<gt>B<name>()
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=back
=head2 Locking
-See L<documentation in the base class|Mail::Box::Locker/"Locking">.
+Extends L<"Locking" in Mail::Box::Locker|Mail::Box::Locker/"Locking">.
=over 4
=item $obj-E<gt>B<hasLock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<isLocked>()
@@ -103,81 +103,81 @@ See L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<unlock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Locker/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Locker|Mail::Box::Locker/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Locker::Flock-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Locker::Flock-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Locker::Flock-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Locker::Flock-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Locker::Flock-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Locker::Flock-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Locker/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Locker|Mail::Box::Locker/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box::Locker/"Cleanup">
+Inherited, see L<Mail::Box::Locker/"Cleanup">
=back
@@ -220,12 +220,12 @@ try again.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Box::Locker::Multi;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Locker';
@@ -20,7 +20,7 @@ sub init($)
my @use
= exists $args->{use} ? @{delete $args->{use}}
- : $^O =~ m/mswin/i ? qw/ POSIX Flock/
+ : $^O eq 'MSWin32' ? qw/Flock/
: qw/NFS POSIX Flock/;
my (@lockers, @used);
@@ -24,21 +24,21 @@ NFS-lock and Flock are tried. More may be added when the ways to
lock are extended. DotLock overlaps with NFS-lock, but NFS-lock is
safer, so that version is preferred.
-See L<documentation in the base class|Mail::Box::Locker/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Locker|Mail::Box::Locker/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Locker/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Locker|Mail::Box::Locker/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Locker/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Locker|Mail::Box::Locker/"Constructors">.
=over 4
-=item Mail::Box::Locker::Multi-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Locker::Multi-E<gt>B<new>(%options)
-You may also pass all OPTIONS understood by the initiated lockers
+You may also pass all %options understood by the initiated lockers
used by the multi locker.
-Option --Defined in --Default
@@ -87,17 +87,17 @@ example: using a subset of multi-lockers
=head2 The Locker
-See L<documentation in the base class|Mail::Box::Locker/"The Locker">.
+Extends L<"The Locker" in Mail::Box::Locker|Mail::Box::Locker/"The Locker">.
=over 4
-=item $obj-E<gt>B<filename>([FILENAME])
+=item $obj-E<gt>B<filename>( [$filename] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=item $obj-E<gt>B<lockers>()
@@ -105,105 +105,105 @@ Returns a list with all locker objects used by this object.
=item $obj-E<gt>B<name>()
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=back
=head2 Locking
-See L<documentation in the base class|Mail::Box::Locker/"Locking">.
+Extends L<"Locking" in Mail::Box::Locker|Mail::Box::Locker/"Locking">.
=over 4
=item $obj-E<gt>B<hasLock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<isLocked>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
-=item $obj-E<gt>B<lock>(FOLDER)
+=item $obj-E<gt>B<lock>($folder)
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<unlock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Locker/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Locker|Mail::Box::Locker/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Locker::Multi-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Locker::Multi-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Locker::Multi-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Locker::Multi-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Locker::Multi-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Locker::Multi-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Locker/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Locker|Mail::Box::Locker/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box::Locker/"Cleanup">
+Inherited, see L<Mail::Box::Locker/"Cleanup">
=back
@@ -223,12 +223,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Box::Locker::Mutt;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Locker';
@@ -20,11 +20,11 @@ The C<mutt> mail reader includes an separate program which is specialized
in locking folders. This locker class uses this external program.
Mutt is not automatically installed.
-See L<documentation in the base class|Mail::Box::Locker/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Locker|Mail::Box::Locker/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Locker/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Locker|Mail::Box::Locker/"METHODS">.
=over 4
@@ -36,11 +36,11 @@ Returns the name of the external binary.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Locker/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Locker|Mail::Box::Locker/"Constructors">.
=over 4
-=item Mail::Box::Locker::Mutt-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Locker::Mutt-E<gt>B<new>(%options)
-Option --Defined in --Default
exe mutt_dotlock
@@ -78,37 +78,37 @@ The name of the program. May be a relative or absolute path.
=head2 The Locker
-See L<documentation in the base class|Mail::Box::Locker/"The Locker">.
+Extends L<"The Locker" in Mail::Box::Locker|Mail::Box::Locker/"The Locker">.
=over 4
-=item $obj-E<gt>B<filename>([FILENAME])
+=item $obj-E<gt>B<filename>( [$filename] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=item $obj-E<gt>B<name>()
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=back
=head2 Locking
-See L<documentation in the base class|Mail::Box::Locker/"Locking">.
+Extends L<"Locking" in Mail::Box::Locker|Mail::Box::Locker/"Locking">.
=over 4
=item $obj-E<gt>B<hasLock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<isLocked>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<lock>()
@@ -118,75 +118,75 @@ See L<Mail::Box::Locker/"Locking">
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Locker/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Locker|Mail::Box::Locker/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Locker::Mutt-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Locker::Mutt-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Locker::Mutt-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Locker::Mutt-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Locker::Mutt-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Locker::Mutt-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Locker/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Locker|Mail::Box::Locker/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box::Locker/"Cleanup">
+Inherited, see L<Mail::Box::Locker/"Cleanup">
=back
@@ -214,12 +214,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Box::Locker::NFS;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Locker';
@@ -23,19 +23,19 @@ which accessed over NFS. The C<::NFS>
locker is therefore more complicated (so therefore slower), but will work
for NFS --and for local disks as well.
-See L<documentation in the base class|Mail::Box::Locker/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Locker|Mail::Box::Locker/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Locker/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Locker|Mail::Box::Locker/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Locker/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Locker|Mail::Box::Locker/"Constructors">.
=over 4
-=item Mail::Box::Locker::NFS-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Locker::NFS-E<gt>B<new>(%options)
-Option --Defined in --Default
expires Mail::Box::Locker 1 hour
@@ -68,117 +68,117 @@ See L<documentation in the base class|Mail::Box::Locker/"Constructors">.
=head2 The Locker
-See L<documentation in the base class|Mail::Box::Locker/"The Locker">.
+Extends L<"The Locker" in Mail::Box::Locker|Mail::Box::Locker/"The Locker">.
=over 4
-=item $obj-E<gt>B<filename>([FILENAME])
+=item $obj-E<gt>B<filename>( [$filename] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=item $obj-E<gt>B<name>()
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=back
=head2 Locking
-See L<documentation in the base class|Mail::Box::Locker/"Locking">.
+Extends L<"Locking" in Mail::Box::Locker|Mail::Box::Locker/"Locking">.
=over 4
=item $obj-E<gt>B<hasLock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<isLocked>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<lock>()
=item $obj-E<gt>B<unlock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Locker/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Locker|Mail::Box::Locker/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Locker::NFS-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Locker::NFS-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Locker::NFS-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Locker::NFS-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Locker::NFS-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Locker::NFS-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Locker/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Locker|Mail::Box::Locker/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box::Locker/"Cleanup">
+Inherited, see L<Mail::Box::Locker/"Cleanup">
=back
@@ -215,12 +215,12 @@ lock file, so we need to wait until it vanishes by some external cause.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Box::Locker::POSIX;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Locker';
@@ -26,13 +26,15 @@ sub name() {'POSIX'}
sub _try_lock($)
{ my ($self, $file) = @_;
- $? = fcntl($file, F_SETLK, pack('s @256', F_WRLCK)) || ($!+0);
+ my $p = pack 's @256', F_WRLCK;
+ $? = fcntl($file, F_SETLK, $p) || ($!+0);
$?==0;
}
sub _unlock($)
{ my ($self, $file) = @_;
- fcntl($file, F_SETLK, pack('s @256', F_UNLCK));
+ my $p = pack 's @256', F_UNLCK;
+ fcntl $file, F_SETLK, $p;
delete $self->{MBL_has_lock};
$self;
}
@@ -21,19 +21,19 @@ the file which contains the data using the kernel's POSIX facilities. This
lock is created on a separate file-handle to the folder file, so not the
handle which is reading. Not all platforms support POSIX locking.
-See L<documentation in the base class|Mail::Box::Locker/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Locker|Mail::Box::Locker/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Locker/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Locker|Mail::Box::Locker/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Locker/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Locker|Mail::Box::Locker/"Constructors">.
=over 4
-=item Mail::Box::Locker::POSIX-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Locker::POSIX-E<gt>B<new>(%options)
-Option --Defined in --Default
expires Mail::Box::Locker 1 hour
@@ -72,33 +72,33 @@ when the multi-locker is used.
=head2 The Locker
-See L<documentation in the base class|Mail::Box::Locker/"The Locker">.
+Extends L<"The Locker" in Mail::Box::Locker|Mail::Box::Locker/"The Locker">.
=over 4
-=item $obj-E<gt>B<filename>([FILENAME])
+=item $obj-E<gt>B<filename>( [$filename] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=item $obj-E<gt>B<name>()
-See L<Mail::Box::Locker/"The Locker">
+Inherited, see L<Mail::Box::Locker/"The Locker">
=back
=head2 Locking
-See L<documentation in the base class|Mail::Box::Locker/"Locking">.
+Extends L<"Locking" in Mail::Box::Locker|Mail::Box::Locker/"Locking">.
=over 4
=item $obj-E<gt>B<hasLock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<isLocked>()
@@ -106,81 +106,81 @@ See L<Mail::Box::Locker/"Locking">
=item $obj-E<gt>B<unlock>()
-See L<Mail::Box::Locker/"Locking">
+Inherited, see L<Mail::Box::Locker/"Locking">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Locker/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Locker|Mail::Box::Locker/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Locker::POSIX-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Locker::POSIX-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Locker::POSIX-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Locker::POSIX-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Locker::POSIX-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Locker::POSIX-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Locker/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Locker|Mail::Box::Locker/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box::Locker/"Cleanup">
+Inherited, see L<Mail::Box::Locker/"Cleanup">
=back
@@ -219,12 +219,12 @@ try again.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Box::Locker;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -38,19 +38,19 @@ Each L<Mail::Box|Mail::Box> will create its own C<Mail::Box::Locker> object whic
will handle the locking for it. You can access of the object directly
from the folder, as shown in the examples below.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Box::Locker-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Locker-E<gt>B<new>(%options)
Create a new lock. You may do this directly. However, in most cases the
lock will not be separately instantiated but will be the second class in
@@ -174,16 +174,16 @@ will always wait until the lock has been received.
=over 4
-=item $obj-E<gt>B<filename>([FILENAME])
+=item $obj-E<gt>B<filename>( [$filename] )
Returns the filename which is used to lock the folder, optionally after
-setting it to the specified FILENAME.
+setting it to the specified $filename.
example:
print $locker->filename;
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
Returns the folder object which is locker.
@@ -221,7 +221,7 @@ example:
if($locker->isLocked) {...}
if($folder->locker->isLocked) {...}
-=item $obj-E<gt>B<lock>(FOLDER)
+=item $obj-E<gt>B<lock>($folder)
Get a lock on a folder. This will return false if the lock fails.
@@ -243,69 +243,69 @@ example:
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Locker-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Locker-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Locker-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Locker-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Locker-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Locker-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
@@ -332,12 +332,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::MH::Index;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -33,19 +33,19 @@ or removes message files without updating the index. If the index is not
trustworthy it will not be used (costing some performance for the reader
of the folder).
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Box::MH::Index-E<gt>B<new>(OPTIONS)
+=item Mail::Box::MH::Index-E<gt>B<new>(%options)
-Option --Defined in --Default
filename <required>
@@ -85,17 +85,17 @@ The preferred number of character in each header line.
=over 4
-=item $obj-E<gt>B<append>(MESSAGES)
+=item $obj-E<gt>B<append>($messages)
-Append MESSAGES to the index file.
+Append $messages to the index file.
=item $obj-E<gt>B<filename>()
Returns the name of the index file.
-=item $obj-E<gt>B<get>(MSGFILE)
+=item $obj-E<gt>B<get>($msgfile)
-Look if there is header info for the specified MSGFILE. The filename
+Look if there is header info for the specified $msgfile. The filename
represents one message in folder type which are organized as directory.
This method will return an object of the L<new(head_type)|Mail::Box::MH::Index/"Constructors"> as specified
during creation of the index object, or C<undef> if the information
@@ -106,84 +106,84 @@ is not known or not trustworthy -i.e. the file size changed.
Read the index file. The header objects can after this be requested
with the L<get()|Mail::Box::MH::Index/"The Index"> method.
-=item $obj-E<gt>B<write>(MESSAGES)
+=item $obj-E<gt>B<write>($messages)
-Write an index file containing the headers specified MESSAGES
+Write an index file containing the headers specified $messages
(L<Mail::Message|Mail::Message> objects).
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::MH::Index-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::MH::Index-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::MH::Index-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::MH::Index-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::MH::Index-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::MH::Index-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -203,12 +203,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Box::MH::Labels;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -25,19 +25,19 @@ Labels can be used to group messages, for instance to reflect which
messages have been read or which look like spam. Some labels are
predefined, but more can be added without limitation.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Box::MH::Labels-E<gt>B<new>(OPTIONS)
+=item Mail::Box::MH::Labels-E<gt>B<new>(%options)
-Option --Defined in --Default
filename <required>
@@ -63,9 +63,9 @@ mails. The filename must be an absolute path.
=over 4
-=item $obj-E<gt>B<append>(MESSAGES)
+=item $obj-E<gt>B<append>($messages)
-Append the label information about the specified MESSAGES to the end
+Append the label information about the specified $messages to the end
of the label file. The information will not be merged with the
information already present in the label file.
@@ -73,11 +73,11 @@ information already present in the label file.
Returns the name of the index file.
-=item $obj-E<gt>B<get>(MSGNR)
+=item $obj-E<gt>B<get>($msgnr)
-Look if there is label info for message MSGNR.
+Look if there is label info for message $msgnr.
-=item $obj-E<gt>B<print>(FILEHANDLE, MESSAGES)
+=item $obj-E<gt>B<print>($fh, $messages)
Print the labels of the specified messages to the opened file.
@@ -85,7 +85,7 @@ Print the labels of the specified messages to the opened file.
Read all label information from file.
-=item $obj-E<gt>B<write>(MESSAGES)
+=item $obj-E<gt>B<write>($messages)
Write the labels related to the specified messages to the label file.
@@ -93,75 +93,75 @@ Write the labels related to the specified messages to the label file.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::MH::Labels-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::MH::Labels-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::MH::Labels-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::MH::Labels-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::MH::Labels-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::MH::Labels-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -181,12 +181,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Box::MH::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Dir::Message';
@@ -23,153 +23,153 @@ A C<Mail::Box::MH::Message> represents one message in an
L<Mail::Box::MH|Mail::Box::MH> folder . Each message is stored in a separate file,
as for all L<Mail::Box::Dir|Mail::Box::Dir> folder types.
-See L<documentation in the base class|Mail::Box::Dir::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Dir::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Dir::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Box::MH::Message-E<gt>B<new>(OPTIONS)
+=item Mail::Box::MH::Message-E<gt>B<new>(%options)
-See L<Mail::Box::Dir::Message/"METHODS">
+Inherited, see L<Mail::Box::Dir::Message/"METHODS">
=back
=head2 Constructing a message
-See L<documentation in the base class|Mail::Box::Dir::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Box::MH::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Box::MH::Message-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Box::MH::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Box::MH::Message-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Box::MH::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Box::MH::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Box::MH::Message-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Box::Dir::Message/"The message">.
+Extends L<"The message" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
-=item $obj-E<gt>B<filename>([FILENAME])
+=item $obj-E<gt>B<filename>( [$filename] )
-See L<Mail::Box::Dir::Message/"The message">
+Inherited, see L<Mail::Box::Dir::Message/"The message">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<moveTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<seqnr>([INTEGER])
+=item $obj-E<gt>B<seqnr>( [$integer] )
The order of this message in the folder, counted from zero. Do not
change the number (unless you understand the implications).
@@ -180,365 +180,365 @@ that one, use the File::Basename subroutine basename of the filename.
=item $obj-E<gt>B<size>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=back
=head2 The header
-See L<documentation in the base class|Mail::Box::Dir::Message/"The header">.
+Extends L<"The header" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Box::Dir::Message/"The body">.
+Extends L<"The body" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Box::Dir::Message/"Flags">.
+Extends L<"Flags" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Box::Dir::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Dir::Message/"Internals">.
+Extends L<"Internals" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Box::MH::Message-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item Mail::Box::MH::Message-E<gt>B<coerce>($message, %options)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<create>(FILENAME)
+=item $obj-E<gt>B<create>($filename)
-See L<Mail::Box::Dir::Message/"Internals">
+Inherited, see L<Mail::Box::Dir::Message/"Internals">
=item $obj-E<gt>B<diskDelete>()
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<loadBody>()
-See L<Mail::Box::Dir::Message/"Internals">
+Inherited, see L<Mail::Box::Dir::Message/"Internals">
=item $obj-E<gt>B<loadHead>()
-See L<Mail::Box::Dir::Message/"Internals">
+Inherited, see L<Mail::Box::Dir::Message/"Internals">
=item $obj-E<gt>B<parser>()
-See L<Mail::Box::Dir::Message/"Internals">
+Inherited, see L<Mail::Box::Dir::Message/"Internals">
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Dir::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::MH::Message-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::MH::Message-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::MH::Message-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::MH::Message-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::MH::Message-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::MH::Message-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Box::MH::Message-E<gt>B<shortSize>([VALUE])
+=item Mail::Box::MH::Message-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Dir::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
-See L<Mail::Box::Message/"Cleanup">
+Inherited, see L<Mail::Box::Message/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Dir::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"DETAILS">.
=head2 Structure of a Message
-See L<documentation in the base class|Mail::Box::Dir::Message/"Structure of a Message">.
+Extends L<"Structure of a Message" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Structure of a Message">.
=head2 Message object implementation
-See L<documentation in the base class|Mail::Box::Dir::Message/"Message object implementation">.
+Extends L<"Message object implementation" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Message object implementation">.
=head2 Message class implementation
-See L<documentation in the base class|Mail::Box::Dir::Message/"Message class implementation">.
+Extends L<"Message class implementation" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Message class implementation">.
=head2 Labels
-See L<documentation in the base class|Mail::Box::Dir::Message/"Labels">.
+Extends L<"Labels" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Labels">.
=head3 Predefined labels
-See L<documentation in the base class|Mail::Box::Dir::Message/"Predefined labels">.
+Extends L<"Predefined labels" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Predefined labels">.
=head3 Status and X-Status fields
-See L<documentation in the base class|Mail::Box::Dir::Message/"Status and X-Status fields">.
+Extends L<"Status and X-Status fields" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Status and X-Status fields">.
=head3 The .mh_sequences file
@@ -667,12 +667,12 @@ unreadible for some other reason.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::MH;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Dir';
@@ -21,39 +21,39 @@ Mail::Box::MH - handle MH folders
This documentation describes how MH mailboxes work, and what you
can do with the MH folder object C<Mail::Box::MH>.
-See L<documentation in the base class|Mail::Box::Dir/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Dir|Mail::Box::Dir/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Box::Dir/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Box::Dir|Mail::Box::Dir/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Dir/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Dir|Mail::Box::Dir/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Dir/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Dir|Mail::Box::Dir/"Constructors">.
=over 4
-=item Mail::Box::MH-E<gt>B<new>(OPTIONS)
+=item Mail::Box::MH-E<gt>B<new>(%options)
-Option --Defined in --Default
access Mail::Box 'r'
@@ -191,19 +191,19 @@ be overruled with this flag.
=head2 The folder
-See L<documentation in the base class|Mail::Box::Dir/"The folder">.
+Extends L<"The folder" in Mail::Box::Dir|Mail::Box::Dir/"The folder">.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<addMessage>($message, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<addMessages>(MESSAGE [, MESSAGE, ...])
+=item $obj-E<gt>B<addMessages>(@messages)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item Mail::Box::MH-E<gt>B<appendMessages>(OPTIONS)
+=item Mail::Box::MH-E<gt>B<appendMessages>(%options)
Append a message to a folder which is not open.
@@ -225,167 +225,167 @@ Append a message to a folder which is not open.
=back
-=item $obj-E<gt>B<close>(OPTIONS)
+=item $obj-E<gt>B<close>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<delete>(OPTIONS)
+=item $obj-E<gt>B<delete>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<directory>()
-See L<Mail::Box::Dir/"The folder">
+Inherited, see L<Mail::Box::Dir/"The folder">
-=item $obj-E<gt>B<folderdir>([DIRECTORY])
+=item $obj-E<gt>B<folderdir>( [$directory] )
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<name>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<update>(OPTIONS)
+=item $obj-E<gt>B<update>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<url>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=back
=head2 Folder flags
-See L<documentation in the base class|Mail::Box::Dir/"Folder flags">.
+Extends L<"Folder flags" in Mail::Box::Dir|Mail::Box::Dir/"Folder flags">.
=over 4
=item $obj-E<gt>B<access>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=back
=head2 The messages
-See L<documentation in the base class|Mail::Box::Dir/"The messages">.
+Extends L<"The messages" in Mail::Box::Dir|Mail::Box::Dir/"The messages">.
=over 4
-=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
+=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<find>(MESSAGE-ID)
+=item $obj-E<gt>B<find>($message_id)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
+=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
+=item $obj-E<gt>B<message>( $index, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
+=item $obj-E<gt>B<messageId>( $message_id, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
+=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<nrMessages>(OPTIONS)
+=item $obj-E<gt>B<nrMessages>(%options)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
+=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=back
=head2 Sub-folders
-See L<documentation in the base class|Mail::Box::Dir/"Sub-folders">.
+Extends L<"Sub-folders" in Mail::Box::Dir|Mail::Box::Dir/"Sub-folders">.
=over 4
-=item $obj-E<gt>B<listSubFolders>(OPTIONS)
+=item $obj-E<gt>B<listSubFolders>(%options)
-=item Mail::Box::MH-E<gt>B<listSubFolders>(OPTIONS)
+=item Mail::Box::MH-E<gt>B<listSubFolders>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-=item Mail::Box::MH-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item Mail::Box::MH-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
+=item $obj-E<gt>B<openRelatedFolder>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openSubFolder>(SUBNAME, OPTIONS)
+=item $obj-E<gt>B<openSubFolder>($subname, %options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<topFolderWithMessages>()
=item Mail::Box::MH-E<gt>B<topFolderWithMessages>()
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Dir/"Internals">.
+Extends L<"Internals" in Mail::Box::Dir|Mail::Box::Dir/"Internals">.
=over 4
-=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<coerce>($message, %options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item $obj-E<gt>B<create>($foldername, %options)
-=item Mail::Box::MH-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item Mail::Box::MH-E<gt>B<create>($foldername, %options)
-Option --Defined in--Default
folderdir Mail::Box undef
@@ -396,17 +396,17 @@ See L<Mail::Box/"Internals">
=back
-=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
+=item $obj-E<gt>B<determineBodyType>($message, $head)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<folderToDirectory>(FOLDERNAME, FOLDERDIR)
+=item $obj-E<gt>B<folderToDirectory>($foldername, $folderdir)
-See L<Mail::Box::Dir/"Internals">
+Inherited, see L<Mail::Box::Dir/"Internals">
-=item Mail::Box::MH-E<gt>B<foundIn>([FOLDERNAME], OPTIONS)
+=item Mail::Box::MH-E<gt>B<foundIn>( [$foldername], %options )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<highestMessageNumber>()
@@ -423,47 +423,47 @@ Create a index reader/writer object.
Create a label reader/writer object.
-=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
+=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<read>(OPTIONS)
+=item $obj-E<gt>B<read>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<readMessageFilenames>(DIRECTORY)
+=item $obj-E<gt>B<readMessageFilenames>($directory)
-See L<Mail::Box::Dir/"Internals">
+Inherited, see L<Mail::Box::Dir/"Internals">
-=item $obj-E<gt>B<readMessages>(OPTIONS)
+=item $obj-E<gt>B<readMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<storeMessage>(MESSAGE)
+=item $obj-E<gt>B<storeMessage>($message)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<updateMessages>(OPTIONS)
+=item $obj-E<gt>B<updateMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<writeMessages>(OPTIONS)
+=item $obj-E<gt>B<writeMessages>(%options)
-Option --Defined in --Default
messages Mail::Box <required>
@@ -484,107 +484,107 @@ unknown reason, you may be thinking that messages should not be renumbered.
=head2 Other methods
-See L<documentation in the base class|Mail::Box::Dir/"Other methods">.
+Extends L<"Other methods" in Mail::Box::Dir|Mail::Box::Dir/"Other methods">.
=over 4
-=item $obj-E<gt>B<timespan2seconds>(TIME)
+=item $obj-E<gt>B<timespan2seconds>($time)
-=item Mail::Box::MH-E<gt>B<timespan2seconds>(TIME)
+=item Mail::Box::MH-E<gt>B<timespan2seconds>($time)
-See L<Mail::Box/"Other methods">
+Inherited, see L<Mail::Box/"Other methods">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Dir/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Dir|Mail::Box::Dir/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::MH-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::MH-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::MH-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::MH-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::MH-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::MH-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Dir/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Dir|Mail::Box::Dir/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box/"Cleanup">
+Inherited, see L<Mail::Box/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Dir/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Dir|Mail::Box::Dir/"DETAILS">.
=head2 Different kinds of folders
-See L<documentation in the base class|Mail::Box::Dir/"Different kinds of folders">.
+Extends L<"Different kinds of folders" in Mail::Box::Dir|Mail::Box::Dir/"Different kinds of folders">.
=head2 Available folder types
-See L<documentation in the base class|Mail::Box::Dir/"Available folder types">.
+Extends L<"Available folder types" in Mail::Box::Dir|Mail::Box::Dir/"Available folder types">.
=head2 Folder class implementation
-See L<documentation in the base class|Mail::Box::Dir/"Folder class implementation">.
+Extends L<"Folder class implementation" in Mail::Box::Dir|Mail::Box::Dir/"Folder class implementation">.
=head2 How MH folders work
@@ -737,12 +737,12 @@ were changes made.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Box::Maildir::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Dir::Message';
@@ -22,203 +22,203 @@ Mail::Box::Maildir::Message - one message in a Maildir folder
A C<Mail::Box::Maildir::Message> represents one message in an
L<Mail::Box::Maildir|Mail::Box::Maildir> folder. Each message is stored in a separate file.
-See L<documentation in the base class|Mail::Box::Dir::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Dir::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Dir::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Box::Maildir::Message-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Maildir::Message-E<gt>B<new>(%options)
-See L<Mail::Box::Dir::Message/"METHODS">
+Inherited, see L<Mail::Box::Dir::Message/"METHODS">
=back
=head2 Constructing a message
-See L<documentation in the base class|Mail::Box::Dir::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Box::Maildir::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Box::Maildir::Message-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Box::Maildir::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Box::Maildir::Message-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Box::Maildir::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Box::Maildir::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Box::Maildir::Message-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Box::Dir::Message/"The message">.
+Extends L<"The message" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
-=item $obj-E<gt>B<filename>([FILENAME])
+=item $obj-E<gt>B<filename>( [$filename] )
-Returns the current filename for this message. If the FILENAME argument
+Returns the current filename for this message. If the $filename argument
is specified, a new filename will be set. For maildir messages this
means that modifications are immediately performed: there will be
a rename (move) from the old name to the new name. Labels may change
within in the message object as well.
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<moveTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<seqnr>([INTEGER])
+=item $obj-E<gt>B<seqnr>( [$integer] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<size>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=back
=head2 The header
-See L<documentation in the base class|Mail::Box::Dir::Message/"The header">.
+Extends L<"The header" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
@@ -227,137 +227,137 @@ is a wild guess about the actual time of sending of the message: it is the
time of receipt which may be seconds to hours off. But is still a good
guess... When the message header is not parsed, then this date is used.
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Box::Dir::Message/"The body">.
+Extends L<"The body" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Box::Dir::Message/"Flags">.
+Extends L<"Flags" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Box::Dir::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
@@ -376,11 +376,11 @@ C<undef> is returned when the rename is required but fails.
=head2 Internals
-See L<documentation in the base class|Mail::Box::Dir::Message/"Internals">.
+Extends L<"Internals" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Internals">.
=over 4
-=item $obj-E<gt>B<accept>([BOOLEAN])
+=item $obj-E<gt>B<accept>( [BOOLEAN] )
Accept a message for the folder. This will move it from the C<new>
or C<tmp> sub-directories into the C<cur> sub-directory (or back when
@@ -389,177 +389,177 @@ nothing will happen.
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Box::Maildir::Message-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item Mail::Box::Maildir::Message-E<gt>B<coerce>($message, %options)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<create>(FILENAME)
+=item $obj-E<gt>B<create>($filename)
-See L<Mail::Box::Dir::Message/"Internals">
+Inherited, see L<Mail::Box::Dir::Message/"Internals">
=item $obj-E<gt>B<diskDelete>()
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<loadBody>()
-See L<Mail::Box::Dir::Message/"Internals">
+Inherited, see L<Mail::Box::Dir::Message/"Internals">
=item $obj-E<gt>B<loadHead>()
-See L<Mail::Box::Dir::Message/"Internals">
+Inherited, see L<Mail::Box::Dir::Message/"Internals">
=item $obj-E<gt>B<parser>()
-See L<Mail::Box::Dir::Message/"Internals">
+Inherited, see L<Mail::Box::Dir::Message/"Internals">
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Dir::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Maildir::Message-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Maildir::Message-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Maildir::Message-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Maildir::Message-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Maildir::Message-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Maildir::Message-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Box::Maildir::Message-E<gt>B<shortSize>([VALUE])
+=item Mail::Box::Maildir::Message-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Dir::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
-See L<Mail::Box::Message/"Cleanup">
+Inherited, see L<Mail::Box::Message/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Dir::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"DETAILS">.
=head2 Structure of a Message
-See L<documentation in the base class|Mail::Box::Dir::Message/"Structure of a Message">.
+Extends L<"Structure of a Message" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Structure of a Message">.
=head2 Message object implementation
-See L<documentation in the base class|Mail::Box::Dir::Message/"Message object implementation">.
+Extends L<"Message object implementation" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Message object implementation">.
=head2 Message class implementation
-See L<documentation in the base class|Mail::Box::Dir::Message/"Message class implementation">.
+Extends L<"Message class implementation" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Message class implementation">.
=head2 Labels
-See L<documentation in the base class|Mail::Box::Dir::Message/"Labels">.
+Extends L<"Labels" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Labels">.
=head3 Predefined labels
-See L<documentation in the base class|Mail::Box::Dir::Message/"Predefined labels">.
+Extends L<"Predefined labels" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Predefined labels">.
=head3 Status and X-Status fields
-See L<documentation in the base class|Mail::Box::Dir::Message/"Status and X-Status fields">.
+Extends L<"Status and X-Status fields" in Mail::Box::Dir::Message|Mail::Box::Dir::Message/"Status and X-Status fields">.
=head3 Flags in filename
@@ -706,12 +706,12 @@ unreadible for some other reason.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::Maildir;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Dir';
@@ -219,7 +219,7 @@ sub readMessageFilenames
opendir DIR, $dirname or return ();
# unsorted list of untainted filenames.
- my @files = map { /^(\d[\w.:,=\-]+)$/
+ my @files = map { /^([0-9][\w.:,=\-]+)$/
&& -f "$dirname/$1" ? $1 : () }
readdir DIR;
closedir DIR;
@@ -232,8 +232,8 @@ sub readMessageFilenames
my %unified;
m/^(\d+)/ and $unified{ ('0' x (9-length($1))).$_ } = $_ foreach @files;
- map { "$dirname/$unified{$_}" }
- sort keys %unified;
+ map "$dirname/$unified{$_}"
+ , sort keys %unified;
}
sub readMessages(@)
@@ -247,10 +247,10 @@ sub readMessages(@)
#
my $curdir = "$directory/cur";
- my @cur = map { [$_, 1] } $self->readMessageFilenames($curdir);
+ my @cur = map +[$_, 1], $self->readMessageFilenames($curdir);
my $newdir = "$directory/new";
- my @new = map { [$_, 0] } $self->readMessageFilenames($newdir);
+ my @new = map +[$_, 0], $self->readMessageFilenames($newdir);
my @log = $self->logSettings;
foreach (@cur, @new)
@@ -24,39 +24,39 @@ can do with the Maildir folder object C<Mail::Box::Maildir>.
Maildir is B<not supported for Windows>, because it create filenames
which are not accepted by the Windows system.
-See L<documentation in the base class|Mail::Box::Dir/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Dir|Mail::Box::Dir/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Box::Dir/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Box::Dir|Mail::Box::Dir/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Dir/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Dir|Mail::Box::Dir/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Dir/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Dir|Mail::Box::Dir/"Constructors">.
=over 4
-=item Mail::Box::Maildir-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Maildir-E<gt>B<new>(%options)
-Option --Defined in --Default
accept_new <false>
@@ -157,173 +157,173 @@ to call L<acceptMessages()|Mail::Box::Maildir/"Internals"> or L<Mail::Box::Maild
=head2 The folder
-See L<documentation in the base class|Mail::Box::Dir/"The folder">.
+Extends L<"The folder" in Mail::Box::Dir|Mail::Box::Dir/"The folder">.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<addMessage>($message, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<addMessages>(MESSAGE [, MESSAGE, ...])
+=item $obj-E<gt>B<addMessages>(@messages)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item Mail::Box::Maildir-E<gt>B<appendMessages>(OPTIONS)
+=item Mail::Box::Maildir-E<gt>B<appendMessages>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<close>(OPTIONS)
+=item $obj-E<gt>B<close>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<delete>(OPTIONS)
+=item $obj-E<gt>B<delete>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<directory>()
-See L<Mail::Box::Dir/"The folder">
+Inherited, see L<Mail::Box::Dir/"The folder">
-=item $obj-E<gt>B<folderdir>([DIRECTORY])
+=item $obj-E<gt>B<folderdir>( [$directory] )
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<name>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<update>(OPTIONS)
+=item $obj-E<gt>B<update>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<url>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=back
=head2 Folder flags
-See L<documentation in the base class|Mail::Box::Dir/"Folder flags">.
+Extends L<"Folder flags" in Mail::Box::Dir|Mail::Box::Dir/"Folder flags">.
=over 4
=item $obj-E<gt>B<access>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=back
=head2 The messages
-See L<documentation in the base class|Mail::Box::Dir/"The messages">.
+Extends L<"The messages" in Mail::Box::Dir|Mail::Box::Dir/"The messages">.
=over 4
-=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
+=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<find>(MESSAGE-ID)
+=item $obj-E<gt>B<find>($message_id)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
+=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
+=item $obj-E<gt>B<message>( $index, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
+=item $obj-E<gt>B<messageId>( $message_id, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
+=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<nrMessages>(OPTIONS)
+=item $obj-E<gt>B<nrMessages>(%options)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
+=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=back
=head2 Sub-folders
-See L<documentation in the base class|Mail::Box::Dir/"Sub-folders">.
+Extends L<"Sub-folders" in Mail::Box::Dir|Mail::Box::Dir/"Sub-folders">.
=over 4
-=item $obj-E<gt>B<listSubFolders>(OPTIONS)
+=item $obj-E<gt>B<listSubFolders>(%options)
-=item Mail::Box::Maildir-E<gt>B<listSubFolders>(OPTIONS)
+=item Mail::Box::Maildir-E<gt>B<listSubFolders>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-=item Mail::Box::Maildir-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item Mail::Box::Maildir-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
+=item $obj-E<gt>B<openRelatedFolder>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openSubFolder>(SUBNAME, OPTIONS)
+=item $obj-E<gt>B<openSubFolder>($subname, %options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<topFolderWithMessages>()
=item Mail::Box::Maildir-E<gt>B<topFolderWithMessages>()
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Dir/"Internals">.
+Extends L<"Internals" in Mail::Box::Dir|Mail::Box::Dir/"Internals">.
=over 4
@@ -333,13 +333,13 @@ Accept all messages which are waiting in the C<new> directory to be
moved to the C<cur> directory. This will not rescan the directory
for newly arrived messages, because that's a task for L<update()|Mail::Box/"The folder">.
-=item Mail::Box::Maildir-E<gt>B<appendMessage>(OPTIONS)
+=item Mail::Box::Maildir-E<gt>B<appendMessage>(%options)
-=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<coerce>($message, %options)
-=item $obj-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item $obj-E<gt>B<create>($foldername, %options)
-=item Mail::Box::Maildir-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item Mail::Box::Maildir-E<gt>B<create>($foldername, %options)
-Option --Defined in--Default
folderdir Mail::Box undef
@@ -350,170 +350,170 @@ for newly arrived messages, because that's a task for L<update()|Mail::Box/"The
=back
-=item $obj-E<gt>B<createDirs>(FOLDERDIR)
+=item $obj-E<gt>B<createDirs>($folderdir)
-=item Mail::Box::Maildir-E<gt>B<createDirs>(FOLDERDIR)
+=item Mail::Box::Maildir-E<gt>B<createDirs>($folderdir)
-The FOLDERDIR contains the absolute path of the location where the
+The $folderdir contains the absolute path of the location where the
messages are kept. Maildir folders contain a C<tmp>, C<new>, and
C<cur> sub-directory within that folder directory as well. This
method will ensure that all directories exist.
Returns false on failure.
-=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
+=item $obj-E<gt>B<determineBodyType>($message, $head)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<folderIsEmpty>(FOLDERDIR)
+=item $obj-E<gt>B<folderIsEmpty>($folderdir)
-=item Mail::Box::Maildir-E<gt>B<folderIsEmpty>(FOLDERDIR)
+=item Mail::Box::Maildir-E<gt>B<folderIsEmpty>($folderdir)
-Checks whether the folder whose directory is specified as absolute FOLDERDIR
+Checks whether the folder whose directory is specified as absolute $folderdir
is empty or not. A folder is empty when the C<tmp>, C<new>, and C<cur>
subdirectories are empty and some files which are left there by application
programs. The maildir spec explicitly states: C<.qmail>, C<bulletintime>,
C<bulletinlock> and C<seriallock>. If any other files are found, the
directory is considered not-empty.
-=item $obj-E<gt>B<folderToDirectory>(FOLDERNAME, FOLDERDIR)
+=item $obj-E<gt>B<folderToDirectory>($foldername, $folderdir)
-See L<Mail::Box::Dir/"Internals">
+Inherited, see L<Mail::Box::Dir/"Internals">
-=item Mail::Box::Maildir-E<gt>B<foundIn>([FOLDERNAME], OPTIONS)
+=item Mail::Box::Maildir-E<gt>B<foundIn>( [$foldername], %options )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
+=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<read>(OPTIONS)
+=item $obj-E<gt>B<read>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<readMessageFilenames>(DIRECTORY)
+=item $obj-E<gt>B<readMessageFilenames>($directory)
-See L<Mail::Box::Dir/"Internals">
+Inherited, see L<Mail::Box::Dir/"Internals">
-=item $obj-E<gt>B<readMessages>(OPTIONS)
+=item $obj-E<gt>B<readMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<storeMessage>(MESSAGE)
+=item $obj-E<gt>B<storeMessage>($message)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<updateMessages>(OPTIONS)
+=item $obj-E<gt>B<updateMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<writeMessages>(OPTIONS)
+=item $obj-E<gt>B<writeMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Box::Dir/"Other methods">.
+Extends L<"Other methods" in Mail::Box::Dir|Mail::Box::Dir/"Other methods">.
=over 4
-=item $obj-E<gt>B<timespan2seconds>(TIME)
+=item $obj-E<gt>B<timespan2seconds>($time)
-=item Mail::Box::Maildir-E<gt>B<timespan2seconds>(TIME)
+=item Mail::Box::Maildir-E<gt>B<timespan2seconds>($time)
-See L<Mail::Box/"Other methods">
+Inherited, see L<Mail::Box/"Other methods">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Dir/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Dir|Mail::Box::Dir/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Maildir-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Maildir-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Maildir-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Maildir-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Maildir-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Maildir-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Dir/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Dir|Mail::Box::Dir/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box/"Cleanup">
+Inherited, see L<Mail::Box/"Cleanup">
=back
@@ -522,19 +522,19 @@ See L<Mail::Box/"Cleanup">
The explanation is complicated, but for normal use you should bother
yourself with all details.
-See L<documentation in the base class|Mail::Box::Dir/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Dir|Mail::Box::Dir/"DETAILS">.
=head2 Different kinds of folders
-See L<documentation in the base class|Mail::Box::Dir/"Different kinds of folders">.
+Extends L<"Different kinds of folders" in Mail::Box::Dir|Mail::Box::Dir/"Different kinds of folders">.
=head2 Available folder types
-See L<documentation in the base class|Mail::Box::Dir/"Available folder types">.
+Extends L<"Available folder types" in Mail::Box::Dir|Mail::Box::Dir/"Available folder types">.
=head2 Folder class implementation
-See L<documentation in the base class|Mail::Box::Dir/"Folder class implementation">.
+Extends L<"Folder class implementation" in Mail::Box::Dir|Mail::Box::Dir/"Folder class implementation">.
=head2 How MAILDIR folders work
@@ -655,12 +655,12 @@ were changes made.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Box::Manage::User;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Manager';
@@ -32,19 +32,19 @@ this extension will add knowledge about some related person. At the
same time, it will try to cache some information about that person's
folder files.
-See L<documentation in the base class|Mail::Box::Manager/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Manager|Mail::Box::Manager/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Manager/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Manager|Mail::Box::Manager/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Manager/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Manager|Mail::Box::Manager/"Constructors">.
=over 4
-=item Mail::Box::Manage::User-E<gt>B<new>(ARGS)
+=item Mail::Box::Manage::User-E<gt>B<new>($args)
Use L<new(default_folder_type)|Mail::Box::Manager/"METHODS"> to explicitly state which kind of folders
you use.
@@ -112,73 +112,73 @@ The name of the user's inbox.
=head2 Attributes
-See L<documentation in the base class|Mail::Box::Manager/"Attributes">.
+Extends L<"Attributes" in Mail::Box::Manager|Mail::Box::Manager/"Attributes">.
=over 4
=item $obj-E<gt>B<defaultFolderType>()
-See L<Mail::Box::Manager/"Attributes">
+Inherited, see L<Mail::Box::Manager/"Attributes">
=item $obj-E<gt>B<folderTypes>()
-See L<Mail::Box::Manager/"Attributes">
+Inherited, see L<Mail::Box::Manager/"Attributes">
=item $obj-E<gt>B<folderdir>()
-See L<Mail::Box::Manager/"Attributes">
+Inherited, see L<Mail::Box::Manager/"Attributes">
=item $obj-E<gt>B<identity>()
Returns a L<User::Identity|User::Identity> object.
-=item $obj-E<gt>B<inbox>([NAME])
+=item $obj-E<gt>B<inbox>( [$name] )
-(Set and) get the NAME of the mailbox which is considered the folder
+(Set and) get the $name of the mailbox which is considered the folder
for incoming mail. In many protocols, this folder is handled separately.
For instance in IMAP this is the only case-insensitive folder name.
-=item $obj-E<gt>B<registerType>(TYPE, CLASS [,OPTIONS])
+=item $obj-E<gt>B<registerType>($type, $class, %options)
-See L<Mail::Box::Manager/"Attributes">
+Inherited, see L<Mail::Box::Manager/"Attributes">
=back
=head2 Manage open folders
-See L<documentation in the base class|Mail::Box::Manager/"Manage open folders">.
+Extends L<"Manage open folders" in Mail::Box::Manager|Mail::Box::Manager/"Manage open folders">.
=over 4
-=item $obj-E<gt>B<close>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<close>($folder, %options)
-See L<Mail::Box::Manager/"Manage open folders">
+Inherited, see L<Mail::Box::Manager/"Manage open folders">
-=item $obj-E<gt>B<closeAllFolders>(, OPTIONS)
+=item $obj-E<gt>B<closeAllFolders>(, %options)
-See L<Mail::Box::Manager/"Manage open folders">
+Inherited, see L<Mail::Box::Manager/"Manage open folders">
-=item $obj-E<gt>B<isOpenFolder>(FOLDER)
+=item $obj-E<gt>B<isOpenFolder>($folder)
-See L<Mail::Box::Manager/"Manage open folders">
+Inherited, see L<Mail::Box::Manager/"Manage open folders">
-=item $obj-E<gt>B<open>([FOLDERNAME], OPTIONS)
+=item $obj-E<gt>B<open>( [$foldername], %options )
-See L<Mail::Box::Manager/"Manage open folders">
+Inherited, see L<Mail::Box::Manager/"Manage open folders">
=item $obj-E<gt>B<openFolders>()
-See L<Mail::Box::Manager/"Manage open folders">
+Inherited, see L<Mail::Box::Manager/"Manage open folders">
=back
=head2 Manage existing folders
-See L<documentation in the base class|Mail::Box::Manager/"Manage existing folders">.
+Extends L<"Manage existing folders" in Mail::Box::Manager|Mail::Box::Manager/"Manage existing folders">.
=over 4
-=item $obj-E<gt>B<create>(NAME, OPTIONS)
+=item $obj-E<gt>B<create>($name, %options)
Creates a new folder with the specified name. An folder's administrative
structure (L<Mail::Box::Identity|Mail::Box::Identity>) is returned, but the folder is not
@@ -187,7 +187,7 @@ opened.
In the accidental case that the folder already
exists, a warning will be issued, and an empty list/undef returned.
-The OPTIONS are passed to L<Mail::Box::create()|Mail::Box/"Internals"> of your default folder
+The %options are passed to L<Mail::Box::create()|Mail::Box/"Internals"> of your default folder
type, except for the options intended for this method itself.
-Option --Default
@@ -219,7 +219,7 @@ is very picky about the initiation values it accepts.
=back
-=item $obj-E<gt>B<delete>(NAME)
+=item $obj-E<gt>B<delete>($name)
Remove all signs from the folder on the file-system. Messages still in
the folder will be removed. This method returns a true value when the
@@ -243,18 +243,18 @@ example: how to delete a folder
print "no xyz (anymore)\n" if $user->delete('xyz');
-=item $obj-E<gt>B<folder>(NAME)
+=item $obj-E<gt>B<folder>($name)
Returns the folder description, a L<Mail::Box::Identity|Mail::Box::Identity>.
-=item $obj-E<gt>B<folderCollection>(NAME)
+=item $obj-E<gt>B<folderCollection>($name)
Returns a pair: the folder collection (L<Mail::Box::Collection|Mail::Box::Collection>) and
-the base name of NAME.
+the base name of $name.
-=item $obj-E<gt>B<rename>(OLDNAME, NEWNAME, OPTIONS)
+=item $obj-E<gt>B<rename>($oldname, $newname, %options)
-Rename the folder with name OLDNAME to NEWNAME. Both names are full
+Rename the folder with name $oldname to $newname. Both names are full
pathnames.
-Option --Default
@@ -277,133 +277,133 @@ Returns the top folder of the user's mailbox storage.
=head2 Move messages to folders
-See L<documentation in the base class|Mail::Box::Manager/"Move messages to folders">.
+Extends L<"Move messages to folders" in Mail::Box::Manager|Mail::Box::Manager/"Move messages to folders">.
=over 4
-=item $obj-E<gt>B<appendMessage>([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)
+=item $obj-E<gt>B<appendMessage>( [$folder|$foldername], $messages, %options )
-See L<Mail::Box::Manager/"Move messages to folders">
+Inherited, see L<Mail::Box::Manager/"Move messages to folders">
-=item $obj-E<gt>B<copyMessage>([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)
+=item $obj-E<gt>B<copyMessage>( [$folder|$foldername], $messages, %options )
-See L<Mail::Box::Manager/"Move messages to folders">
+Inherited, see L<Mail::Box::Manager/"Move messages to folders">
-=item $obj-E<gt>B<moveMessage>([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)
+=item $obj-E<gt>B<moveMessage>( [$folder|$foldername], $messages, %options )
-See L<Mail::Box::Manager/"Move messages to folders">
+Inherited, see L<Mail::Box::Manager/"Move messages to folders">
=back
=head2 Manage message threads
-See L<documentation in the base class|Mail::Box::Manager/"Manage message threads">.
+Extends L<"Manage message threads" in Mail::Box::Manager|Mail::Box::Manager/"Manage message threads">.
=over 4
-=item $obj-E<gt>B<threads>([FOLDERS], OPTIONS)
+=item $obj-E<gt>B<threads>( [$folders], %options )
-See L<Mail::Box::Manager/"Manage message threads">
+Inherited, see L<Mail::Box::Manager/"Manage message threads">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Manager/"Internals">.
+Extends L<"Internals" in Mail::Box::Manager|Mail::Box::Manager/"Internals">.
=over 4
-=item $obj-E<gt>B<decodeFolderURL>(URL)
+=item $obj-E<gt>B<decodeFolderURL>($url)
-See L<Mail::Box::Manager/"Internals">
+Inherited, see L<Mail::Box::Manager/"Internals">
-=item $obj-E<gt>B<toBeThreaded>(FOLDER, MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($folder, $messages)
-See L<Mail::Box::Manager/"Internals">
+Inherited, see L<Mail::Box::Manager/"Internals">
-=item $obj-E<gt>B<toBeUnthreaded>(FOLDER, MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($folder, $messages)
-See L<Mail::Box::Manager/"Internals">
+Inherited, see L<Mail::Box::Manager/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Manager/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Manager|Mail::Box::Manager/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Manage::User-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Manage::User-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Manage::User-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Manage::User-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Manage::User-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Manage::User-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Manager/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Manager|Mail::Box::Manager/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Manager/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Manager|Mail::Box::Manager/"DETAILS">.
=head1 DIAGNOSTICS
@@ -498,12 +498,12 @@ only useful for folders which have write or append access modes
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Box::Manager;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -136,7 +136,7 @@ sub open(@)
$name = defined $args{folder} ? $args{folder} : ($ENV{MAIL} || '')
unless defined $name;
- if($name =~ m/^(\w+)\:/ && grep { $_ eq $1 } $self->folderTypes)
+ if($name =~ m/^(\w+)\:/ && grep $_ eq $1, $self->folderTypes)
{ # Complicated folder URL
my %decoded = $self->decodeFolderURL($name);
if(keys %decoded)
@@ -159,19 +159,19 @@ sub open(@)
{ my $un = $args{username} ||= $ENV{USER} || $ENV{LOGIN};
my $srv = $args{server_name} ||= 'localhost';
my $port = $args{server_port} ||= 110;
- $args{folder} = $name = "pop3://$un\@$srv:$port";
+ $args{folderdir} = $name = "pop3://$un\@$srv:$port";
}
elsif($type eq 'pop3s')
{ my $un = $args{username} ||= $ENV{USER} || $ENV{LOGIN};
my $srv = $args{server_name} ||= 'localhost';
my $port = $args{server_port} ||= 995;
- $args{folder} = $name = "pop3s://$un\@$srv:$port";
+ $args{folderdir} = $name = "pop3s://$un\@$srv:$port";
}
elsif($type eq 'imap4')
{ my $un = $args{username} ||= $ENV{USER} || $ENV{LOGIN};
my $srv = $args{server_name} ||= 'localhost';
my $port = $args{server_port} ||= 143;
- $args{folder} = $name = "imap4://$un\@$srv:$port";
+ $args{folderdir} = $name = "imap4://$un\@$srv:$port";
}
unless(defined $name && length $name)
@@ -43,19 +43,19 @@ supporting objects. You are not obliged to use this object (you can
directly create a L<Mail::Box::Mbox|Mail::Box::Mbox> if you prefer), but you will create
more portable and safer code if you do use it.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Box::Manager-E<gt>B<new>(ARGS)
+=item Mail::Box::Manager-E<gt>B<new>($args)
-Option --Defined in --Default
autodetect undef
@@ -132,11 +132,11 @@ example:
In list context, this returns all folderdirs specified. In SCALAR
context only the first.
-=item $obj-E<gt>B<registerType>(TYPE, CLASS [,OPTIONS])
+=item $obj-E<gt>B<registerType>($type, $class, %options)
-With C<registerType> you can register one TYPE of folders. The CLASS
+With C<registerType> you can register one $type of folders. The $class
is compiled automatically, so you do not need to C<use> them in your own
-modules. The TYPE is just an arbitrary name.
+modules. The $type is just an arbitrary name.
The added types are prepended to the list of known types, so they are
checked first when a folder is opened in autodetect mode.
@@ -152,11 +152,11 @@ example:
=over 4
-=item $obj-E<gt>B<close>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<close>($folder, %options)
C<close> removes the specified folder from the list of open folders.
Indirectly it will update the files on disk if needed (depends on
-the L<Mail::Box::new(save_on_exit)|Mail::Box/"Constructors"> flag for each folder). OPTIONS are
+the L<Mail::Box::new(save_on_exit)|Mail::Box/"Constructors"> flag for each folder). %options are
passed to L<Mail::Box::close()|Mail::Box/"The folder"> of the folder.
The folder's messages will also be withdrawn from the known message threads.
@@ -181,21 +181,21 @@ example:
$mgr->close($inbox);
$inbox->close; # alternative
-=item $obj-E<gt>B<closeAllFolders>(, OPTIONS)
+=item $obj-E<gt>B<closeAllFolders>(, %options)
C<closeAllFolders> calls close() for each folder managed by
this object. It is called just before the program stops (before global
cleanup).
-=item $obj-E<gt>B<isOpenFolder>(FOLDER)
+=item $obj-E<gt>B<isOpenFolder>($folder)
-Returns true if the FOLDER is currently open.
+Returns true if the $folder is currently open.
example:
print "Yes\n" if $mgr->isOpenFolder('Inbox');
-=item $obj-E<gt>B<open>([FOLDERNAME], OPTIONS)
+=item $obj-E<gt>B<open>( [$foldername], %options )
Open a folder which name is specified as first parameter or with
the option flag C<folder>. The folder type is autodetected unless
@@ -286,9 +286,9 @@ Returns a list of all open folders.
=over 4
-=item $obj-E<gt>B<delete>(FOLDERNAME, OPTIONS)
+=item $obj-E<gt>B<delete>($foldername, %options)
-Remove the named folder. The OPTIONS are the same as those for L<open()|Mail::Box::Manager/"Manage open folders">.
+Remove the named folder. The %options are the same as those for L<open()|Mail::Box::Manager/"Manage open folders">.
The deletion of a folder can take some time. Dependent on the type of
folder, the folder must be read first. For some folder-types this will
@@ -311,10 +311,10 @@ Some folder can only be recursively deleted, other have more flexibility.
=over 4
-=item $obj-E<gt>B<appendMessage>([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)
+=item $obj-E<gt>B<appendMessage>( [$folder|$foldername], $messages, %options )
Append one or more messages to a folder (therefore, an C<appendMessages()>
-is defined as well). You may specify a FOLDERNAME or an opened folder
+is defined as well). You may specify a $foldername or an opened folder
as the first argument. When the name is that of an open folder, it is
treated as if the folder-object was specified, and not directly access
the folder-files. You may also specify the foldername as part of the
@@ -331,7 +331,7 @@ type does not have to match the folder type--the folder will try to
resolve the differences with minimal loss of information. The coerced
messages (how the were actually written) are returned as list.
-The OPTIONS is a list of key/values, which are added to (overriding)
+The %options is a list of key/values, which are added to (overriding)
the default options for the detected folder type.
example:
@@ -343,7 +343,7 @@ example:
folder => 'Drafts');
$_->label(seen => 1) foreach @appended;
-=item $obj-E<gt>B<copyMessage>([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)
+=item $obj-E<gt>B<copyMessage>( [$folder|$foldername], $messages, %options )
Copy a message from one folder into another folder. If the destination
folder is already opened, L<Mail::Box::copyTo()|Mail::Box/"The folder"> is used. Otherwise,
@@ -380,7 +380,7 @@ example:
folder => '=Drafts' folderdir => '/tmp',
create => 1);
-=item $obj-E<gt>B<moveMessage>([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)
+=item $obj-E<gt>B<moveMessage>( [$folder|$foldername], $messages, %options )
Move a message from one folder to another.
@@ -414,11 +414,11 @@ is equivalent to
=over 4
-=item $obj-E<gt>B<threads>([FOLDERS], OPTIONS)
+=item $obj-E<gt>B<threads>( [$folders], %options )
Create a new object which keeps track of message threads. You can
read about the possible options in L<Mail::Box::Thread::Manager|Mail::Box::Thread::Manager>.
-As OPTIONS specify one folder or an array of FOLDERS.
+As %options specify one folder or an array of $folders.
It is also permitted to specify folders before the options.
example:
@@ -433,19 +433,19 @@ example:
=over 4
-=item $obj-E<gt>B<decodeFolderURL>(URL)
+=item $obj-E<gt>B<decodeFolderURL>($url)
-Try to decompose a folder name which is specified as URL (see open())
+Try to decompose a folder name which is specified as $url (see open())
into separate options. Special characters like @-sign, colon, and slash
-used in the user or password parts must be passed URL-encoded.
+used in the user or password parts must be passed $url-encoded.
-=item $obj-E<gt>B<toBeThreaded>(FOLDER, MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($folder, $messages)
Signal to the manager that all thread managers which are using the
specified folder must be informed that new messages are
coming in.
-=item $obj-E<gt>B<toBeUnthreaded>(FOLDER, MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($folder, $messages)
Signal to the manager that all thread managers which are using the
specified folder must be informed that new messages are
@@ -455,75 +455,75 @@ or going out.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Manager-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Manager-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Manager-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Manager-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Manager-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Manager-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -671,12 +671,12 @@ only useful for folders which have write or append access modes
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -6,7 +6,7 @@
use strict;
package Mail::Box::Mbox::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::File::Message';
@@ -21,15 +21,15 @@ Mail::Box::Mbox::Message - one message in a Mbox folder
Maintain one message in an L<Mail::Box::Mbox|Mail::Box::Mbox> folder.
-See L<documentation in the base class|Mail::Box::File::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::File::Message|Mail::Box::File::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::File::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Box::File::Message|Mail::Box::File::Message/"METHODS">.
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::File::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::File::Message|Mail::Box::File::Message/"DETAILS">.
=head1 DIAGNOSTICS
@@ -95,12 +95,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::Mbox;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::File';
@@ -21,39 +21,39 @@ Mail::Box::Mbox - handle folders in Mbox format
This documentation describes how Mbox mailboxes work, and also describes
what you can do with the Mbox folder object Mail::Box::Mbox.
-See L<documentation in the base class|Mail::Box::File/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::File|Mail::Box::File/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Box::File/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Box::File|Mail::Box::File/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Box::File/"METHODS">.
+Extends L<"METHODS" in Mail::Box::File|Mail::Box::File/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::File/"Constructors">.
+Extends L<"Constructors" in Mail::Box::File|Mail::Box::File/"Constructors">.
=over 4
-=item Mail::Box::Mbox-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Mbox-E<gt>B<new>(%options)
-Option --Defined in --Default
access Mail::Box 'r'
@@ -157,145 +157,145 @@ to contain them. This extension C<.d> can be changed using this option.
=head2 The folder
-See L<documentation in the base class|Mail::Box::File/"The folder">.
+Extends L<"The folder" in Mail::Box::File|Mail::Box::File/"The folder">.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<addMessage>($message, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<addMessages>(MESSAGE [, MESSAGE, ...])
+=item $obj-E<gt>B<addMessages>(@messages)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item Mail::Box::Mbox-E<gt>B<appendMessages>(OPTIONS)
+=item Mail::Box::Mbox-E<gt>B<appendMessages>(%options)
-See L<Mail::Box::File/"METHODS">
+Inherited, see L<Mail::Box::File/"METHODS">
-=item $obj-E<gt>B<close>(OPTIONS)
+=item $obj-E<gt>B<close>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<delete>(OPTIONS)
+=item $obj-E<gt>B<delete>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<filename>()
-See L<Mail::Box::File/"The folder">
+Inherited, see L<Mail::Box::File/"The folder">
-=item $obj-E<gt>B<folderdir>([DIRECTORY])
+=item $obj-E<gt>B<folderdir>( [$directory] )
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<name>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<update>(OPTIONS)
+=item $obj-E<gt>B<update>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<url>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=back
=head2 Folder flags
-See L<documentation in the base class|Mail::Box::File/"Folder flags">.
+Extends L<"Folder flags" in Mail::Box::File|Mail::Box::File/"Folder flags">.
=over 4
=item $obj-E<gt>B<access>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=back
=head2 The messages
-See L<documentation in the base class|Mail::Box::File/"The messages">.
+Extends L<"The messages" in Mail::Box::File|Mail::Box::File/"The messages">.
=over 4
-=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
+=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<find>(MESSAGE-ID)
+=item $obj-E<gt>B<find>($message_id)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
+=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
+=item $obj-E<gt>B<message>( $index, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
+=item $obj-E<gt>B<messageId>( $message_id, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
+=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<nrMessages>(OPTIONS)
+=item $obj-E<gt>B<nrMessages>(%options)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
+=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=back
=head2 Sub-folders
-See L<documentation in the base class|Mail::Box::File/"Sub-folders">.
+Extends L<"Sub-folders" in Mail::Box::File|Mail::Box::File/"Sub-folders">.
=over 4
-=item $obj-E<gt>B<listSubFolders>(OPTIONS)
+=item $obj-E<gt>B<listSubFolders>(%options)
-=item Mail::Box::Mbox-E<gt>B<listSubFolders>(OPTIONS)
+=item Mail::Box::Mbox-E<gt>B<listSubFolders>(%options)
-Option --Defined in --Default
check Mail::Box <false>
@@ -321,41 +321,41 @@ used to detect sub-folders by default. Otherwise, C<'.d'> is taken.
=back
-=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-=item Mail::Box::Mbox-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item Mail::Box::Mbox-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
+=item $obj-E<gt>B<openRelatedFolder>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openSubFolder>(SUBNAME, OPTIONS)
+=item $obj-E<gt>B<openSubFolder>($subname, %options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<topFolderWithMessages>()
=item Mail::Box::Mbox-E<gt>B<topFolderWithMessages>()
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::File/"Internals">.
+Extends L<"Internals" in Mail::Box::File|Mail::Box::File/"Internals">.
=over 4
-=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<coerce>($message, %options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item $obj-E<gt>B<create>($foldername, %options)
-=item Mail::Box::Mbox-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item Mail::Box::Mbox-E<gt>B<create>($foldername, %options)
-Option --Defined in --Default
folderdir Mail::Box undef
@@ -374,22 +374,22 @@ is passed to L<folderToFilename()|Mail::Box::Mbox/"Internals">.
=back
-=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
+=item $obj-E<gt>B<determineBodyType>($message, $head)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<folderToFilename>(FOLDERNAME, FOLDERDIR, [EXTENSION])
+=item $obj-E<gt>B<folderToFilename>( $foldername, $folderdir, [$extension] )
-=item Mail::Box::Mbox-E<gt>B<folderToFilename>(FOLDERNAME, FOLDERDIR, [EXTENSION])
+=item Mail::Box::Mbox-E<gt>B<folderToFilename>( $foldername, $folderdir, [$extension] )
Translate a folder name into a filename, using the
-FOLDERDIR value to replace a leading C<=>. If no EXTENSION is specified and
+$folderdir value to replace a leading C<=>. If no $extension is specified and
this method is called as instance method, new(subfolder_extension) is used.
Otherwise, the extension default to C<'.d'>.
-=item Mail::Box::Mbox-E<gt>B<foundIn>([FOLDERNAME], [OPTIONS])
+=item Mail::Box::Mbox-E<gt>B<foundIn>( [$foldername], %options )
-If no FOLDERNAME is specified, then the value of the C<folder> option
+If no $foldername is specified, then the value of the C<folder> option
is taken. A mbox folder is a file which starts with a separator
line: a line with C<'From '> as first characters. Blank lines which
start the file are ignored, which is not for all MUA's acceptable.
@@ -409,167 +409,167 @@ start the file are ignored, which is not for all MUA's acceptable.
=back
-=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
+=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<messageCreateOptions>([TYPE, CONFIG])
+=item $obj-E<gt>B<messageCreateOptions>( [$type, $config] )
-See L<Mail::Box::File/"Internals">
+Inherited, see L<Mail::Box::File/"Internals">
-=item $obj-E<gt>B<moveAwaySubFolder>(DIRECTORY, EXTENSION)
+=item $obj-E<gt>B<moveAwaySubFolder>($directory, $extension)
-See L<Mail::Box::File/"Internals">
+Inherited, see L<Mail::Box::File/"Internals">
=item $obj-E<gt>B<parser>()
-See L<Mail::Box::File/"Internals">
+Inherited, see L<Mail::Box::File/"Internals">
-=item $obj-E<gt>B<read>(OPTIONS)
+=item $obj-E<gt>B<read>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<readMessages>(OPTIONS)
+=item $obj-E<gt>B<readMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<storeMessage>(MESSAGE)
+=item $obj-E<gt>B<storeMessage>($message)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<updateMessages>(OPTIONS)
+=item $obj-E<gt>B<updateMessages>(%options)
-See L<Mail::Box::File/"Internals">
+Inherited, see L<Mail::Box::File/"Internals">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Box::File/"Internals">
+Inherited, see L<Mail::Box::File/"Internals">
-=item $obj-E<gt>B<writeMessages>(OPTIONS)
+=item $obj-E<gt>B<writeMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Box::File/"Other methods">.
+Extends L<"Other methods" in Mail::Box::File|Mail::Box::File/"Other methods">.
=over 4
-=item $obj-E<gt>B<timespan2seconds>(TIME)
+=item $obj-E<gt>B<timespan2seconds>($time)
-=item Mail::Box::Mbox-E<gt>B<timespan2seconds>(TIME)
+=item Mail::Box::Mbox-E<gt>B<timespan2seconds>($time)
-See L<Mail::Box/"Other methods">
+Inherited, see L<Mail::Box/"Other methods">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::File/"Error handling">.
+Extends L<"Error handling" in Mail::Box::File|Mail::Box::File/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Mbox-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Mbox-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Mbox-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Mbox-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Mbox-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Mbox-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::File/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::File|Mail::Box::File/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box/"Cleanup">
+Inherited, see L<Mail::Box/"Cleanup">
=back
=head2 DETAILS
-See L<documentation in the base class|Mail::Box::File/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::File|Mail::Box::File/"DETAILS">.
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::File/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::File|Mail::Box::File/"DETAILS">.
=head2 Different kinds of folders
-See L<documentation in the base class|Mail::Box::File/"Different kinds of folders">.
+Extends L<"Different kinds of folders" in Mail::Box::File|Mail::Box::File/"Different kinds of folders">.
=head2 Available folder types
-See L<documentation in the base class|Mail::Box::File/"Available folder types">.
+Extends L<"Available folder types" in Mail::Box::File|Mail::Box::File/"Available folder types">.
=head2 Folder class implementation
-See L<documentation in the base class|Mail::Box::File/"Folder class implementation">.
+Extends L<"Folder class implementation" in Mail::Box::File|Mail::Box::File/"Folder class implementation">.
=head2 How MBOX folders work
@@ -603,6 +603,8 @@ is similar to the first example and you want to put messages in that empty
folder, the directory is automatically (and transparently) renamed, so
that the second situation is reached.
+=encoding utf8
+
=head1 DIAGNOSTICS
=over 4
@@ -712,12 +714,12 @@ error messages to indicate the real problem.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Box::Message::Destructed;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Message';
@@ -20,12 +20,8 @@ sub new(@)
undef;
}
-#-------------------------------------------
-
sub isDummy() { 1 }
-#-------------------------------------------
-
sub head(;$)
{ my $self = shift;
@@ -35,8 +31,6 @@ sub head(;$)
undef;
}
-#-------------------------------------------
-
sub body(;$)
{ my $self = shift;
@@ -46,8 +40,6 @@ sub body(;$)
undef;
}
-#-------------------------------------------
-
sub coerce($)
{ my ($class, $message) = @_;
@@ -64,8 +56,6 @@ sub coerce($)
bless $message, $class;
}
-#-------------------------------------------
-
sub modified(;$)
{ my $self = shift;
@@ -77,8 +67,6 @@ sub modified(;$)
sub isModified() { 0 }
-#-------------------------------------------
-
sub label($;@)
{ my $self = shift;
@@ -102,8 +90,6 @@ sub label($;@)
1;
}
-#-------------------------------------------
-
-sub labels() { wantarray ? ('deleted') : { deleted => 1 } }
+sub labels() { wantarray ? ('deleted') : +{deleted => 1} }
1;
@@ -29,23 +29,23 @@ enforces irreversable deletion from the folder. If you have a folder opened
for read-only, the message will stay in that folder, but otherwise it may
be deleted.
-See L<documentation in the base class|Mail::Box::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Message|Mail::Box::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Message|Mail::Box::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Message|Mail::Box::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Box::Message::Destructed-E<gt>B<new>(MESSAGE-ID, OPTIONS)
+=item Mail::Box::Message::Destructed-E<gt>B<new>($message_id, %options)
You cannot instantiate a destructed message object. Destruction is
done by calling L<Mail::Box::Message::destruct()|Mail::Box::Message/"Cleanup">.
@@ -102,325 +102,325 @@ done by calling L<Mail::Box::Message::destruct()|Mail::Box::Message/"Cleanup">.
=head2 Constructing a message
-See L<documentation in the base class|Mail::Box::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Box::Message|Mail::Box::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Box::Message::Destructed-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Box::Message::Destructed-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Box::Message::Destructed-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Box::Message::Destructed-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Box::Message::Destructed-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Box::Message::Destructed-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Box::Message::Destructed-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Box::Message/"The message">.
+Extends L<"The message" in Mail::Box::Message|Mail::Box::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<moveTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<seqnr>([INTEGER])
+=item $obj-E<gt>B<seqnr>( [$integer] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<size>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=back
=head2 The header
-See L<documentation in the base class|Mail::Box::Message/"The header">.
+Extends L<"The header" in Mail::Box::Message|Mail::Box::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-When C<undef> is specified for HEAD, no change has to take place and
+When C<undef> is specified for $head, no change has to take place and
the method returns silently. In all other cases, this method will
complain that the header has been removed.
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Box::Message/"The body">.
+Extends L<"The body" in Mail::Box::Message|Mail::Box::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-When C<undef> is specified for BODY, no change has to take place and
+When C<undef> is specified for $body, no change has to take place and
the method returns silently. In all other cases, this method will
complain that the body data has been removed.
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Box::Message/"Flags">.
+Extends L<"Flags" in Mail::Box::Message|Mail::Box::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
It is possible to delete a destructed message, but not to undelete it.
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Box::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Box::Message|Mail::Box::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Message/"Internals">.
+Extends L<"Internals" in Mail::Box::Message|Mail::Box::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Box::Message::Destructed-E<gt>B<coerce>(MESSAGE)
+=item Mail::Box::Message::Destructed-E<gt>B<coerce>($message)
Coerce a L<Mail::Box::Message|Mail::Box::Message> into destruction.
@@ -435,129 +435,129 @@ example: of coercion to death
=item $obj-E<gt>B<diskDelete>()
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Message|Mail::Box::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Message::Destructed-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Message::Destructed-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Message::Destructed-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Message::Destructed-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Message::Destructed-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Message::Destructed-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Box::Message::Destructed-E<gt>B<shortSize>([VALUE])
+=item Mail::Box::Message::Destructed-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Message|Mail::Box::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
-See L<Mail::Box::Message/"Cleanup">
+Inherited, see L<Mail::Box::Message/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Message|Mail::Box::Message/"DETAILS">.
=head1 DIAGNOSTICS
@@ -644,12 +644,12 @@ destruction, which is not possible.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Box::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message';
@@ -35,23 +35,23 @@ During its life, a message will pass through certain stages. These
stages were introduced to reduce the access-time to the folder. Changing
from stage, the message's body and head objects may change.
-See L<documentation in the base class|Mail::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message|Mail::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Message|Mail::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Message|Mail::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Box::Message-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Message-E<gt>B<new>(%options)
-Option --Defined in --Default
body Mail::Message undef
@@ -115,91 +115,91 @@ message separators which may be used by the folder type.
=head2 Constructing a message
-See L<documentation in the base class|Mail::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Message|Mail::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Box::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Box::Message-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Box::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Box::Message-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Box::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Box::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Box::Message-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Message/"The message">.
+Extends L<"The message" in Mail::Message|Mail::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-Copy the message to the indicated opened FOLDER, without deleting the
+Copy the message to the indicated opened $folder, without deleting the
original. The coerced message (the clone in the destination folder)
is returned.
@@ -236,32 +236,32 @@ example:
my $draft = $mgr->open(folder => 'Draft');
$message->copyTo($draft, share => 1);
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
In with folder did we detect this message/dummy? This is a reference
to the folder-object.
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<moveTo>($folder, %options)
-Move the message from this folder to the FOLDER specified. This will
+Move the message from this folder to the $folder specified. This will
create a copy using L<clone()|Mail::Message/"Constructors"> first. Then, this original message is
flagged to get deleted. So until the source folder is closed, two copies
of the message may stay in memory.
The newly created message clone (part of the destination folder)
-is returned. All OPTIONS are passed to L<copyTo()|Mail::Box::Message/"The message">
+is returned. All %options are passed to L<copyTo()|Mail::Box::Message/"The message">
-Option --Default
shallow_body <undef>
@@ -295,216 +295,216 @@ is equivalent to
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<seqnr>([INTEGER])
+=item $obj-E<gt>B<seqnr>( [$integer] )
Get the number of this message is the current folder. It starts counting
from zero. Do not change the number.
=item $obj-E<gt>B<size>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=back
=head2 The header
-See L<documentation in the base class|Mail::Message/"The header">.
+Extends L<"The header" in Mail::Message|Mail::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Message/"The body">.
+Extends L<"The body" in Mail::Message|Mail::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Message/"Flags">.
+Extends L<"Flags" in Mail::Message|Mail::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Message|Mail::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message/"Internals">.
+Extends L<"Internals" in Mail::Message|Mail::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Box::Message-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item Mail::Box::Message-E<gt>B<coerce>($message, %options)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<diskDelete>()
@@ -514,122 +514,122 @@ folder.
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-Read the body of one message. The PARSER gives access to the folder file.
-The HEAD has been read with L<readHead()|Mail::Message/"Internals">. The optional BODYTYPE supplies
+Read the body of one message. The $parser gives access to the folder file.
+The $head has been read with L<readHead()|Mail::Message/"Internals">. The optional $bodytype supplies
the class name of the body to be created, or a code reference to a
routine which can produce a body type based on the head (passed as
first argument).
-By default, the BODYTYPE will call L<Mail::Box::determineBodyType()|Mail::Box/"Internals">
+By default, the $bodytype will call L<Mail::Box::determineBodyType()|Mail::Box/"Internals">
where the message will be added to.
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Message|Mail::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Message-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Message-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Message-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Message-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Message-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Message-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Box::Message-E<gt>B<shortSize>([VALUE])
+=item Mail::Box::Message-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message|Mail::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
@@ -642,7 +642,7 @@ with the usage of this method.
=head1 DETAILS
-See L<documentation in the base class|Mail::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message|Mail::Message/"DETAILS">.
=head1 DIAGNOSTICS
@@ -706,12 +706,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Box::Net::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Message';
@@ -26,23 +26,23 @@ A L<Mail::Box::Net::Message|Mail::Box::Net::Message> represents one message in a
can only be accessed via some kind of protocol. On this moment, only
a POP3 client is available. IMAP, DBI, and NNTP are other candidates.
-See L<documentation in the base class|Mail::Box::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Message|Mail::Box::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Message|Mail::Box::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Message|Mail::Box::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Box::Net::Message-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Net::Message-E<gt>B<new>(%options)
-Option --Defined in --Default
body Mail::Message undef
@@ -101,457 +101,457 @@ The unique keys which identifies this message on the remote server.
=head2 Constructing a message
-See L<documentation in the base class|Mail::Box::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Box::Message|Mail::Box::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Box::Net::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Box::Net::Message-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Box::Net::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Box::Net::Message-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Box::Net::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Box::Net::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Box::Net::Message-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Box::Message/"The message">.
+Extends L<"The message" in Mail::Box::Message|Mail::Box::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<moveTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<seqnr>([INTEGER])
+=item $obj-E<gt>B<seqnr>( [$integer] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<size>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<unique>([STRING|undef])
+=item $obj-E<gt>B<unique>( [STRING|undef] )
Returns the name of the file in which this message is actually stored. This
will return C<undef> when the message is not stored in a file. When a STRING
is specified, a new identifier is stored first.
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=back
=head2 The header
-See L<documentation in the base class|Mail::Box::Message/"The header">.
+Extends L<"The header" in Mail::Box::Message|Mail::Box::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Box::Message/"The body">.
+Extends L<"The body" in Mail::Box::Message|Mail::Box::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Box::Message/"Flags">.
+Extends L<"Flags" in Mail::Box::Message|Mail::Box::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Box::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Box::Message|Mail::Box::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Message/"Internals">.
+Extends L<"Internals" in Mail::Box::Message|Mail::Box::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Box::Net::Message-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item Mail::Box::Net::Message-E<gt>B<coerce>($message, %options)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<diskDelete>()
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<loadBody>()
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Message|Mail::Box::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Net::Message-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Net::Message-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Net::Message-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Net::Message-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Net::Message-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Net::Message-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Box::Net::Message-E<gt>B<shortSize>([VALUE])
+=item Mail::Box::Net::Message-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Message|Mail::Box::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
-See L<Mail::Box::Message/"Cleanup">
+Inherited, see L<Mail::Box::Message/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Message|Mail::Box::Message/"DETAILS">.
=head1 DIAGNOSTICS
@@ -619,12 +619,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -6,7 +6,7 @@
use strict;
package Mail::Box::Net;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box';
@@ -32,15 +32,31 @@ sub init($)
$args->{lock_type} ||= 'NONE';
$args->{body_type} ||= 'Mail::Message::Body::Lines';
- $args->{folder} ||= '/';
$args->{trusted} ||= 0;
+ my ($scheme, $s, $port, $u, $pwd, $f);
+ if(my $d = $args->{folderdir})
+ { # cannot use URI, because some scheme's are fake
+ ($scheme, $u, $pwd, $s, $port, $f) = $a =~
+ m! ^ (\w+) \:// # scheme
+ (?: ( [^:\@/]+ ) # username
+ (?: \: ( [^\@/]+ ))? # password
+ \@ )?
+ ( [a-zA-Z0-9.-]+ )? # hostname
+ (?: \: ([0-9]+) )? # port
+ ( / .* )? # path
+ !x;
+ $args->{folderdir} =~ s!/$!!;
+ }
+
+ $args->{folder} ||= $f || '/';
+
$self->SUPER::init($args);
- $self->{MBN_username} = $args->{username};
- $self->{MBN_password} = $args->{password};
- $self->{MBN_hostname} = $args->{server_name};
- $self->{MBN_port} = $args->{server_port};
+ $self->{MBN_hostname} = $args->{server_name} || $s;
+ $self->{MBN_port} = $args->{server_port} || $port;
+ $self->{MBN_username} = $args->{username} || $u;
+ $self->{MBN_password} = $args->{password} || $pwd;
$self->log(WARNING => "The term 'hostname' is confusing wrt folder. You probably need 'server_name'")
if exists $args->{hostname};
@@ -48,22 +64,10 @@ sub init($)
$self;
}
-#-------------------------------------------
-
sub create(@) {shift->notImplemented}
-
-#-------------------------------------------
-
-
-sub folderdir(;$) { undef }
-
-#-------------------------------------------
-
sub organization() { 'REMOTE' }
-#-------------------------------------------
-
sub url()
{ my $self = shift;
@@ -88,6 +92,4 @@ sub url()
$self->type . '://' . $perm . $loc;
}
-#-------------------------------------------
-
1;
@@ -34,39 +34,39 @@ Implements the IMAP4 protocol. B<UNDER DEVELOPMENT>
=back
-See L<documentation in the base class|Mail::Box/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box|Mail::Box/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Box/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Box|Mail::Box/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Box/"METHODS">.
+Extends L<"METHODS" in Mail::Box|Mail::Box/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box/"Constructors">.
+Extends L<"Constructors" in Mail::Box|Mail::Box/"Constructors">.
=over 4
-=item Mail::Box::Net-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Net-E<gt>B<new>(%options)
-Option --Defined in --Default
access Mail::Box 'r'
@@ -78,7 +78,7 @@ See L<documentation in the base class|Mail::Box/"Constructors">.
field_type Mail::Box undef
fix_headers Mail::Box <false>
folder Mail::Box '/'
- folderdir Mail::Box <not used>
+ folderdir Mail::Box <network location>
head_delayed_type Mail::Box Mail::Message::Head::Delayed
head_type Mail::Box Mail::Message::Head::Complete
keep_dups Mail::Box <false>
@@ -176,185 +176,184 @@ The username which is to be used for the remote server.
=head2 The folder
-See L<documentation in the base class|Mail::Box/"The folder">.
+Extends L<"The folder" in Mail::Box|Mail::Box/"The folder">.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<addMessage>($message, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<addMessages>(MESSAGE [, MESSAGE, ...])
+=item $obj-E<gt>B<addMessages>(@messages)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item Mail::Box::Net-E<gt>B<appendMessages>(OPTIONS)
+=item Mail::Box::Net-E<gt>B<appendMessages>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<close>(OPTIONS)
+=item $obj-E<gt>B<close>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<delete>(OPTIONS)
+=item $obj-E<gt>B<delete>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<folderdir>([DIRECTORY])
+=item $obj-E<gt>B<folderdir>( [$directory] )
-Not applicatable for folders on a remote server, so will always return
-the C<undef>.
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<name>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<update>(OPTIONS)
+=item $obj-E<gt>B<update>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<url>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=back
=head2 Folder flags
-See L<documentation in the base class|Mail::Box/"Folder flags">.
+Extends L<"Folder flags" in Mail::Box|Mail::Box/"Folder flags">.
=over 4
=item $obj-E<gt>B<access>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=back
=head2 The messages
-See L<documentation in the base class|Mail::Box/"The messages">.
+Extends L<"The messages" in Mail::Box|Mail::Box/"The messages">.
=over 4
-=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
+=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<find>(MESSAGE-ID)
+=item $obj-E<gt>B<find>($message_id)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
+=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
+=item $obj-E<gt>B<message>( $index, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
+=item $obj-E<gt>B<messageId>( $message_id, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
+=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<nrMessages>(OPTIONS)
+=item $obj-E<gt>B<nrMessages>(%options)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
+=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=back
=head2 Sub-folders
-See L<documentation in the base class|Mail::Box/"Sub-folders">.
+Extends L<"Sub-folders" in Mail::Box|Mail::Box/"Sub-folders">.
=over 4
-=item $obj-E<gt>B<listSubFolders>(OPTIONS)
+=item $obj-E<gt>B<listSubFolders>(%options)
-=item Mail::Box::Net-E<gt>B<listSubFolders>(OPTIONS)
+=item Mail::Box::Net-E<gt>B<listSubFolders>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-=item Mail::Box::Net-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item Mail::Box::Net-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
+=item $obj-E<gt>B<openRelatedFolder>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openSubFolder>(SUBNAME, OPTIONS)
+=item $obj-E<gt>B<openSubFolder>($subname, %options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<topFolderWithMessages>()
=item Mail::Box::Net-E<gt>B<topFolderWithMessages>()
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box/"Internals">.
+Extends L<"Internals" in Mail::Box|Mail::Box/"Internals">.
=over 4
-=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<coerce>($message, %options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<create>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<create>($folder, %options)
-=item Mail::Box::Net-E<gt>B<create>(FOLDER, OPTIONS)
+=item Mail::Box::Net-E<gt>B<create>($folder, %options)
Create a new folder on the remote server.
-Option --Defined in--Default
- folderdir Mail::Box <not used>
+ folderdir Mail::Box undef
=over 2
@@ -362,147 +361,147 @@ Create a new folder on the remote server.
=back
-=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
+=item $obj-E<gt>B<determineBodyType>($message, $head)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item Mail::Box::Net-E<gt>B<foundIn>([FOLDERNAME], OPTIONS)
+=item Mail::Box::Net-E<gt>B<foundIn>( [$foldername], %options )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
+=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<read>(OPTIONS)
+=item $obj-E<gt>B<read>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<readMessages>(OPTIONS)
+=item $obj-E<gt>B<readMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<storeMessage>(MESSAGE)
+=item $obj-E<gt>B<storeMessage>($message)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<updateMessages>(OPTIONS)
+=item $obj-E<gt>B<updateMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<writeMessages>(OPTIONS)
+=item $obj-E<gt>B<writeMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Box/"Other methods">.
+Extends L<"Other methods" in Mail::Box|Mail::Box/"Other methods">.
=over 4
-=item $obj-E<gt>B<timespan2seconds>(TIME)
+=item $obj-E<gt>B<timespan2seconds>($time)
-=item Mail::Box::Net-E<gt>B<timespan2seconds>(TIME)
+=item Mail::Box::Net-E<gt>B<timespan2seconds>($time)
-See L<Mail::Box/"Other methods">
+Inherited, see L<Mail::Box/"Other methods">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box/"Error handling">.
+Extends L<"Error handling" in Mail::Box|Mail::Box/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Net-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Net-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Net-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Net-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Net-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Net-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box|Mail::Box/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box/"Cleanup">
+Inherited, see L<Mail::Box/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box|Mail::Box/"DETAILS">.
=head1 DIAGNOSTICS
@@ -580,12 +579,12 @@ were changes made.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Box::POP3::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Net::Message';
@@ -24,23 +24,23 @@ maintained by a L<Mail::Box::POP3|Mail::Box::POP3> folder. Each message is store
separate entity on the server, and maybe temporarily in your program
as well.
-See L<documentation in the base class|Mail::Box::Net::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Net::Message|Mail::Box::Net::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Net::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Net::Message|Mail::Box::Net::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Net::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Box::POP3::Message-E<gt>B<new>(OPTIONS)
+=item Mail::Box::POP3::Message-E<gt>B<new>(%options)
-Option --Defined in --Default
body Mail::Message undef
@@ -97,127 +97,127 @@ See L<Mail::Message/"Constructors">
=head2 Constructing a message
-See L<documentation in the base class|Mail::Box::Net::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Box::POP3::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Box::POP3::Message-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Box::POP3::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Box::POP3::Message-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Box::POP3::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Box::POP3::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Box::POP3::Message-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Box::Net::Message/"The message">.
+Extends L<"The message" in Mail::Box::Net::Message|Mail::Box::Net::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
-=item $obj-E<gt>B<folder>([FOLDER])
+=item $obj-E<gt>B<folder>( [$folder] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<moveTo>($folder, %options)
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<seqnr>([INTEGER])
+=item $obj-E<gt>B<seqnr>( [$integer] )
-See L<Mail::Box::Message/"The message">
+Inherited, see L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<size>()
@@ -228,329 +228,329 @@ sizes can differ because the difference in line-ending representation.
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<unique>([STRING|undef])
+=item $obj-E<gt>B<unique>( [STRING|undef] )
-See L<Mail::Box::Net::Message/"The message">
+Inherited, see L<Mail::Box::Net::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=back
=head2 The header
-See L<documentation in the base class|Mail::Box::Net::Message/"The header">.
+Extends L<"The header" in Mail::Box::Net::Message|Mail::Box::Net::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Box::Net::Message/"The body">.
+Extends L<"The body" in Mail::Box::Net::Message|Mail::Box::Net::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Box::Net::Message/"Flags">.
+Extends L<"Flags" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Box::Net::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Box::Net::Message|Mail::Box::Net::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Net::Message/"Internals">.
+Extends L<"Internals" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Box::POP3::Message-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item Mail::Box::POP3::Message-E<gt>B<coerce>($message, %options)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<diskDelete>()
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<loadBody>()
-See L<Mail::Box::Net::Message/"Internals">
+Inherited, see L<Mail::Box::Net::Message/"Internals">
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Box::Message/"Internals">
+Inherited, see L<Mail::Box::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Net::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::POP3::Message-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::POP3::Message-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::POP3::Message-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::POP3::Message-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::POP3::Message-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::POP3::Message-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Box::POP3::Message-E<gt>B<shortSize>([VALUE])
+=item Mail::Box::POP3::Message-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Net::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Net::Message|Mail::Box::Net::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
-See L<Mail::Box::Message/"Cleanup">
+Inherited, see L<Mail::Box::Message/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Net::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Net::Message|Mail::Box::Net::Message/"DETAILS">.
=head1 DIAGNOSTICS
@@ -618,12 +618,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::POP3;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Net';
@@ -27,39 +27,39 @@ using the POP3 protocol. This class uses L<Mail::Transport::POP3|Mail::Transpor
hide the transport of information, and focusses solely on the correct
handling of messages within a POP3 folder.
-See L<documentation in the base class|Mail::Box::Net/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Net|Mail::Box::Net/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Box::Net/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Box::Net|Mail::Box::Net/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Net/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Net|Mail::Box::Net/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Net/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Net|Mail::Box::Net/"Constructors">.
=over 4
-=item Mail::Box::POP3-E<gt>B<new>(OPTIONS)
+=item Mail::Box::POP3-E<gt>B<new>(%options)
For authentications, you have three choices: specify a foldername which
resembles an URL, or specify a pop-client object, or separate options
@@ -76,7 +76,7 @@ for user, password, pop-server and server-port.
field_type Mail::Box undef
fix_headers Mail::Box <false>
folder Mail::Box <not applicable>
- folderdir Mail::Box <not used>
+ folderdir Mail::Box <network location>
head_delayed_type Mail::Box Mail::Message::Head::Delayed
head_type Mail::Box Mail::Message::Head::Complete
keep_dups Mail::Box <false>
@@ -189,18 +189,18 @@ example:
=head2 The folder
-See L<documentation in the base class|Mail::Box::Net/"The folder">.
+Extends L<"The folder" in Mail::Box::Net|Mail::Box::Net/"The folder">.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE)
+=item $obj-E<gt>B<addMessage>($message)
It is impossible to write messages to the average POP3 server. There are
extensions to the protocol which do permit it, however these are not
implemented (yet, patches welcome).
C<undef> is returned, and an error displayed. However, no complaint is
-given when the MESSAGE is C<undef> itself.
+given when the $message is C<undef> itself.
-Option--Defined in--Default
share Mail::Box <not used>
@@ -211,24 +211,24 @@ given when the MESSAGE is C<undef> itself.
=back
-=item $obj-E<gt>B<addMessages>(MESSAGES)
+=item $obj-E<gt>B<addMessages>($messages)
As useless as L<addMessage()|Mail::Box::POP3/"METHODS">. The only acceptable call to this method
is without any message.
-=item Mail::Box::POP3-E<gt>B<appendMessages>(OPTIONS)
+=item Mail::Box::POP3-E<gt>B<appendMessages>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<close>(OPTIONS)
+=item $obj-E<gt>B<close>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<delete>(OPTIONS)
+=item $obj-E<gt>B<delete>(%options)
It is not possible to delete a POP3 folder remotely: the best we can do
is remove all the messages in it... which is the action implemented here.
@@ -243,25 +243,25 @@ A notice is logged about this.
=back
-=item $obj-E<gt>B<folderdir>([DIRECTORY])
+=item $obj-E<gt>B<folderdir>( [$directory] )
-See L<Mail::Box::Net/"METHODS">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<name>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<update>()
@@ -269,87 +269,87 @@ NOT IMPLEMENTED YET
=item $obj-E<gt>B<url>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=back
=head2 Folder flags
-See L<documentation in the base class|Mail::Box::Net/"Folder flags">.
+Extends L<"Folder flags" in Mail::Box::Net|Mail::Box::Net/"Folder flags">.
=over 4
=item $obj-E<gt>B<access>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=back
=head2 The messages
-See L<documentation in the base class|Mail::Box::Net/"The messages">.
+Extends L<"The messages" in Mail::Box::Net|Mail::Box::Net/"The messages">.
=over 4
-=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
+=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<find>(MESSAGE-ID)
+=item $obj-E<gt>B<find>($message_id)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
+=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
+=item $obj-E<gt>B<message>( $index, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
+=item $obj-E<gt>B<messageId>( $message_id, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
+=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<nrMessages>(OPTIONS)
+=item $obj-E<gt>B<nrMessages>(%options)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
+=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=back
=head2 Sub-folders
-See L<documentation in the base class|Mail::Box::Net/"Sub-folders">.
+Extends L<"Sub-folders" in Mail::Box::Net|Mail::Box::Net/"Sub-folders">.
=over 4
-=item $obj-E<gt>B<listSubFolders>(OPTIONS)
+=item $obj-E<gt>B<listSubFolders>(%options)
-=item Mail::Box::POP3-E<gt>B<listSubFolders>(OPTIONS)
+=item Mail::Box::POP3-E<gt>B<listSubFolders>(%options)
The standard POP3 protocol does not support sub-folders, so an
empty list will be returned in any case.
@@ -372,17 +372,17 @@ empty list will be returned in any case.
=back
-=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-=item Mail::Box::POP3-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item Mail::Box::POP3-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
+=item $obj-E<gt>B<openRelatedFolder>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openSubFolder>(OPTIONS)
+=item $obj-E<gt>B<openSubFolder>(%options)
It is not possible to open a sub-folder for a POP3 folder, because that
is not supported by the official POP3 protocol. In any case, C<undef>
@@ -392,29 +392,29 @@ is returned to indicate a failure.
=item Mail::Box::POP3-E<gt>B<topFolderWithMessages>()
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Net/"Internals">.
+Extends L<"Internals" in Mail::Box::Net|Mail::Box::Net/"Internals">.
=over 4
-=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<coerce>($message, %options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<create>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<create>($folder, %options)
-=item Mail::Box::POP3-E<gt>B<create>(FOLDER, OPTIONS)
+=item Mail::Box::POP3-E<gt>B<create>($folder, %options)
It is not possible to create a new folder on a POP3 server. This method
will always return C<false>.
-Option --Defined in--Default
- folderdir Mail::Box <not used>
+ folderdir Mail::Box undef
=over 2
@@ -422,31 +422,31 @@ will always return C<false>.
=back
-=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
+=item $obj-E<gt>B<determineBodyType>($message, $head)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item Mail::Box::POP3-E<gt>B<foundIn>([FOLDERNAME], OPTIONS)
+=item Mail::Box::POP3-E<gt>B<foundIn>( [$foldername], %options )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<getHead>(MESSAGE)
+=item $obj-E<gt>B<getHead>($message)
Read the header for the specified message from the remote server.
-=item $obj-E<gt>B<getHeadAndBody>(MESSAGE)
+=item $obj-E<gt>B<getHeadAndBody>($message)
Read all data for the specified message from the remote server.
-=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
+=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<popClient>(OPTIONS)
+=item $obj-E<gt>B<popClient>(%options)
Returns the pop client object. This does not establish the connection.
@@ -459,35 +459,35 @@ Returns the pop client object. This does not establish the connection.
=back
-=item $obj-E<gt>B<read>(OPTIONS)
+=item $obj-E<gt>B<read>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<readMessages>(OPTIONS)
+=item $obj-E<gt>B<readMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<storeMessage>(MESSAGE)
+=item $obj-E<gt>B<storeMessage>($message)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<updateMessages>(OPTIONS)
+=item $obj-E<gt>B<updateMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<writeMessages>(OPTIONS)
+=item $obj-E<gt>B<writeMessages>(%options)
-Option --Defined in--Default
messages Mail::Box <required>
@@ -502,107 +502,107 @@ See L<Mail::Box/"Internals">
=head2 Other methods
-See L<documentation in the base class|Mail::Box::Net/"Other methods">.
+Extends L<"Other methods" in Mail::Box::Net|Mail::Box::Net/"Other methods">.
=over 4
-=item $obj-E<gt>B<timespan2seconds>(TIME)
+=item $obj-E<gt>B<timespan2seconds>($time)
-=item Mail::Box::POP3-E<gt>B<timespan2seconds>(TIME)
+=item Mail::Box::POP3-E<gt>B<timespan2seconds>($time)
-See L<Mail::Box/"Other methods">
+Inherited, see L<Mail::Box/"Other methods">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Net/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Net|Mail::Box::Net/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::POP3-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::POP3-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::POP3-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::POP3-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::POP3-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::POP3-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Net/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Net|Mail::Box::Net/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box/"Cleanup">
+Inherited, see L<Mail::Box/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::Net/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::Net|Mail::Box::Net/"DETAILS">.
=head2 Different kinds of folders
-See L<documentation in the base class|Mail::Box::Net/"Different kinds of folders">.
+Extends L<"Different kinds of folders" in Mail::Box::Net|Mail::Box::Net/"Different kinds of folders">.
=head2 Available folder types
-See L<documentation in the base class|Mail::Box::Net/"Available folder types">.
+Extends L<"Available folder types" in Mail::Box::Net|Mail::Box::Net/"Available folder types">.
=head2 Folder class implementation
-See L<documentation in the base class|Mail::Box::Net/"Folder class implementation">.
+Extends L<"Folder class implementation" in Mail::Box::Net|Mail::Box::Net/"Folder class implementation">.
=head2 How POP3 folders work
@@ -734,12 +734,12 @@ implementation with writing.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::POP3s;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::POP3';
@@ -21,39 +21,39 @@ Mail::Box::POP3s - handle secure POP3 folders as client
This module mainly extends L<Mail::Box::POP3|Mail::Box::POP3>.
-See L<documentation in the base class|Mail::Box::POP3/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::POP3|Mail::Box::POP3/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Box::POP3/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Box::POP3|Mail::Box::POP3/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Box/"OVERLOADED">
+Inherited, see L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Box::POP3/"METHODS">.
+Extends L<"METHODS" in Mail::Box::POP3|Mail::Box::POP3/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::POP3/"Constructors">.
+Extends L<"Constructors" in Mail::Box::POP3|Mail::Box::POP3/"Constructors">.
=over 4
-=item Mail::Box::POP3s-E<gt>B<new>(OPTIONS)
+=item Mail::Box::POP3s-E<gt>B<new>(%options)
-Option --Defined in --Default
access Mail::Box 'r'
@@ -66,7 +66,7 @@ See L<documentation in the base class|Mail::Box::POP3/"Constructors">.
field_type Mail::Box undef
fix_headers Mail::Box <false>
folder Mail::Box <not applicable>
- folderdir Mail::Box <not used>
+ folderdir Mail::Box <network location>
head_delayed_type Mail::Box Mail::Message::Head::Delayed
head_type Mail::Box Mail::Message::Head::Complete
keep_dups Mail::Box <false>
@@ -161,335 +161,335 @@ See L<documentation in the base class|Mail::Box::POP3/"Constructors">.
=head2 The folder
-See L<documentation in the base class|Mail::Box::POP3/"The folder">.
+Extends L<"The folder" in Mail::Box::POP3|Mail::Box::POP3/"The folder">.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE)
+=item $obj-E<gt>B<addMessage>($message)
-See L<Mail::Box::POP3/"METHODS">
+Inherited, see L<Mail::Box::POP3/"METHODS">
-=item $obj-E<gt>B<addMessages>(MESSAGES)
+=item $obj-E<gt>B<addMessages>($messages)
-See L<Mail::Box::POP3/"METHODS">
+Inherited, see L<Mail::Box::POP3/"METHODS">
-=item Mail::Box::POP3s-E<gt>B<appendMessages>(OPTIONS)
+=item Mail::Box::POP3s-E<gt>B<appendMessages>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<close>(OPTIONS)
+=item $obj-E<gt>B<close>(%options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
-=item $obj-E<gt>B<delete>(OPTIONS)
+=item $obj-E<gt>B<delete>(%options)
-See L<Mail::Box::POP3/"METHODS">
+Inherited, see L<Mail::Box::POP3/"METHODS">
-=item $obj-E<gt>B<folderdir>([DIRECTORY])
+=item $obj-E<gt>B<folderdir>( [$directory] )
-See L<Mail::Box::Net/"METHODS">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<name>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<update>()
-See L<Mail::Box::POP3/"METHODS">
+Inherited, see L<Mail::Box::POP3/"METHODS">
=item $obj-E<gt>B<url>()
-See L<Mail::Box/"The folder">
+Inherited, see L<Mail::Box/"The folder">
=back
=head2 Folder flags
-See L<documentation in the base class|Mail::Box::POP3/"Folder flags">.
+Extends L<"Folder flags" in Mail::Box::POP3|Mail::Box::POP3/"Folder flags">.
=over 4
=item $obj-E<gt>B<access>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
-See L<Mail::Box/"Folder flags">
+Inherited, see L<Mail::Box/"Folder flags">
=back
=head2 The messages
-See L<documentation in the base class|Mail::Box::POP3/"The messages">.
+Extends L<"The messages" in Mail::Box::POP3|Mail::Box::POP3/"The messages">.
=over 4
-=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
+=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<find>(MESSAGE-ID)
+=item $obj-E<gt>B<find>($message_id)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
+=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
+=item $obj-E<gt>B<message>( $index, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
+=item $obj-E<gt>B<messageId>( $message_id, [$message] )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
+=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<nrMessages>(OPTIONS)
+=item $obj-E<gt>B<nrMessages>(%options)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
-=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
+=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
-See L<Mail::Box/"The messages">
+Inherited, see L<Mail::Box/"The messages">
=back
=head2 Sub-folders
-See L<documentation in the base class|Mail::Box::POP3/"Sub-folders">.
+Extends L<"Sub-folders" in Mail::Box::POP3|Mail::Box::POP3/"Sub-folders">.
=over 4
-=item $obj-E<gt>B<listSubFolders>(OPTIONS)
+=item $obj-E<gt>B<listSubFolders>(%options)
-=item Mail::Box::POP3s-E<gt>B<listSubFolders>(OPTIONS)
+=item Mail::Box::POP3s-E<gt>B<listSubFolders>(%options)
-See L<Mail::Box::POP3/"METHODS">
+Inherited, see L<Mail::Box::POP3/"METHODS">
-=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-=item Mail::Box::POP3s-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item Mail::Box::POP3s-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
+=item $obj-E<gt>B<openRelatedFolder>(%options)
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
-=item $obj-E<gt>B<openSubFolder>(OPTIONS)
+=item $obj-E<gt>B<openSubFolder>(%options)
-See L<Mail::Box::POP3/"METHODS">
+Inherited, see L<Mail::Box::POP3/"METHODS">
=item $obj-E<gt>B<topFolderWithMessages>()
=item Mail::Box::POP3s-E<gt>B<topFolderWithMessages>()
-See L<Mail::Box/"Sub-folders">
+Inherited, see L<Mail::Box/"Sub-folders">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::POP3/"Internals">.
+Extends L<"Internals" in Mail::Box::POP3|Mail::Box::POP3/"Internals">.
=over 4
-=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<coerce>($message, %options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<create>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<create>($folder, %options)
-=item Mail::Box::POP3s-E<gt>B<create>(FOLDER, OPTIONS)
+=item Mail::Box::POP3s-E<gt>B<create>($folder, %options)
-See L<Mail::Box::POP3/"METHODS">
+Inherited, see L<Mail::Box::POP3/"METHODS">
-=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
+=item $obj-E<gt>B<determineBodyType>($message, $head)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item Mail::Box::POP3s-E<gt>B<foundIn>([FOLDERNAME], OPTIONS)
+=item Mail::Box::POP3s-E<gt>B<foundIn>( [$foldername], %options )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<getHead>(MESSAGE)
+=item $obj-E<gt>B<getHead>($message)
-See L<Mail::Box::POP3/"Internals">
+Inherited, see L<Mail::Box::POP3/"Internals">
-=item $obj-E<gt>B<getHeadAndBody>(MESSAGE)
+=item $obj-E<gt>B<getHeadAndBody>($message)
-See L<Mail::Box::POP3/"Internals">
+Inherited, see L<Mail::Box::POP3/"Internals">
-=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
+=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<popClient>(OPTIONS)
+=item $obj-E<gt>B<popClient>(%options)
-See L<Mail::Box::POP3/"Internals">
+Inherited, see L<Mail::Box::POP3/"Internals">
-=item $obj-E<gt>B<read>(OPTIONS)
+=item $obj-E<gt>B<read>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<readMessages>(OPTIONS)
+=item $obj-E<gt>B<readMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<storeMessage>(MESSAGE)
+=item $obj-E<gt>B<storeMessage>($message)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($messages)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<updateMessages>(OPTIONS)
+=item $obj-E<gt>B<updateMessages>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Box/"Internals">
+Inherited, see L<Mail::Box/"Internals">
-=item $obj-E<gt>B<writeMessages>(OPTIONS)
+=item $obj-E<gt>B<writeMessages>(%options)
-See L<Mail::Box::POP3/"Internals">
+Inherited, see L<Mail::Box::POP3/"Internals">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Box::POP3/"Other methods">.
+Extends L<"Other methods" in Mail::Box::POP3|Mail::Box::POP3/"Other methods">.
=over 4
-=item $obj-E<gt>B<timespan2seconds>(TIME)
+=item $obj-E<gt>B<timespan2seconds>($time)
-=item Mail::Box::POP3s-E<gt>B<timespan2seconds>(TIME)
+=item Mail::Box::POP3s-E<gt>B<timespan2seconds>($time)
-See L<Mail::Box/"Other methods">
+Inherited, see L<Mail::Box/"Other methods">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::POP3/"Error handling">.
+Extends L<"Error handling" in Mail::Box::POP3|Mail::Box::POP3/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::POP3s-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::POP3s-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::POP3s-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::POP3s-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::POP3s-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::POP3s-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::POP3/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::POP3|Mail::Box::POP3/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Box/"Cleanup">
+Inherited, see L<Mail::Box/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Box::POP3/"DETAILS">.
+Extends L<"DETAILS" in Mail::Box::POP3|Mail::Box::POP3/"DETAILS">.
=head1 DIAGNOSTICS
@@ -597,12 +597,12 @@ implementation with writing.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Box::Parser::Perl;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Parser';
@@ -184,6 +184,9 @@ sub _read_stripped_lines(;$$)
}
unless($self->{MBPP_trusted})
{ s/\015$// for @$lines;
+ # input is read as binary stream (i.e. preserving CRLF on Windows).
+ # Code is based on this assumption. Removal of CR if not trusted
+ # conflicts with this assumption. [Markus Spann]
}
}
#warn "($bodyend, $msgend, ".@$lines, ")\n";
@@ -270,7 +273,7 @@ sub openFile($)
$self->{MBPP_file} = $fh;
$fh->binmode(':raw')
- if ref($fh) eq 'GLOB' || $fh->can('BINMODE');
+ if $fh->can('binmode') || $fh->can('BINMODE');
$self->{MBPP_separators} = [];
@@ -19,19 +19,19 @@ in Perl. This may be a little slower than the C<C> based parser
Mail::Box::Parser::C, but will also work on platforms where no C
compiler is available.
-See L<documentation in the base class|Mail::Box::Parser/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Parser|Mail::Box::Parser/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Parser/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Parser|Mail::Box::Parser/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Parser/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Parser|Mail::Box::Parser/"Constructors">.
=over 4
-=item Mail::Box::Parser::Perl-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Parser::Perl-E<gt>B<new>(%options)
-Option --Defined in --Default
file Mail::Box::Parser undef
@@ -72,19 +72,19 @@ tests. Related to L<Mail::Box::new(trusted)|Mail::Box/"Constructors">.
=head2 The parser
-See L<documentation in the base class|Mail::Box::Parser/"The parser">.
+Extends L<"The parser" in Mail::Box::Parser|Mail::Box::Parser/"The parser">.
=over 4
=item $obj-E<gt>B<fileChanged>()
-See L<Mail::Box::Parser/"The parser">
+Inherited, see L<Mail::Box::Parser/"The parser">
=item $obj-E<gt>B<filename>()
-See L<Mail::Box::Parser/"The parser">
+Inherited, see L<Mail::Box::Parser/"The parser">
-=item $obj-E<gt>B<fixHeaderErrors>([BOOLEAN])
+=item $obj-E<gt>B<fixHeaderErrors>( [BOOLEAN] )
If set to C<true>, parsing of a header will not stop on an error, but
attempt to add the erroneous this line to previous field. Without BOOLEAN,
@@ -97,161 +97,161 @@ example:
=item $obj-E<gt>B<restart>()
-See L<Mail::Box::Parser/"The parser">
+Inherited, see L<Mail::Box::Parser/"The parser">
-=item $obj-E<gt>B<start>(OPTIONS)
+=item $obj-E<gt>B<start>(%options)
-See L<Mail::Box::Parser/"The parser">
+Inherited, see L<Mail::Box::Parser/"The parser">
=item $obj-E<gt>B<stop>()
-See L<Mail::Box::Parser/"The parser">
+Inherited, see L<Mail::Box::Parser/"The parser">
=back
=head2 Parsing
-See L<documentation in the base class|Mail::Box::Parser/"Parsing">.
+Extends L<"Parsing" in Mail::Box::Parser|Mail::Box::Parser/"Parsing">.
=over 4
-=item $obj-E<gt>B<bodyAsFile>(FILEHANDLE [,CHARS [,LINES]])
+=item $obj-E<gt>B<bodyAsFile>( $fh [$chars, [$lines]] )
-See L<Mail::Box::Parser/"Parsing">
+Inherited, see L<Mail::Box::Parser/"Parsing">
-=item $obj-E<gt>B<bodyAsList>([,CHARS [,LINES]])
+=item $obj-E<gt>B<bodyAsList>( [$chars, [$lines]] )
-See L<Mail::Box::Parser/"Parsing">
+Inherited, see L<Mail::Box::Parser/"Parsing">
-=item $obj-E<gt>B<bodyAsString>([,CHARS [,LINES]])
+=item $obj-E<gt>B<bodyAsString>( [$chars, [$lines]] )
-See L<Mail::Box::Parser/"Parsing">
+Inherited, see L<Mail::Box::Parser/"Parsing">
-=item $obj-E<gt>B<bodyDelayed>([,CHARS [,LINES]])
+=item $obj-E<gt>B<bodyDelayed>( [$chars, [$lines]] )
-See L<Mail::Box::Parser/"Parsing">
+Inherited, see L<Mail::Box::Parser/"Parsing">
-=item $obj-E<gt>B<filePosition>([POSITION])
+=item $obj-E<gt>B<filePosition>( [$position] )
-See L<Mail::Box::Parser/"Parsing">
+Inherited, see L<Mail::Box::Parser/"Parsing">
=item $obj-E<gt>B<lineSeparator>()
-See L<Mail::Box::Parser/"Parsing">
+Inherited, see L<Mail::Box::Parser/"Parsing">
=item $obj-E<gt>B<popSeparator>()
-See L<Mail::Box::Parser/"Parsing">
+Inherited, see L<Mail::Box::Parser/"Parsing">
-=item $obj-E<gt>B<pushSeparator>(STRING|REGEXP)
+=item $obj-E<gt>B<pushSeparator>(STRING|Regexp)
-See L<Mail::Box::Parser/"Parsing">
+Inherited, see L<Mail::Box::Parser/"Parsing">
=item $obj-E<gt>B<readHeader>()
-=item $obj-E<gt>B<readSeparator>(OPTIONS)
+=item $obj-E<gt>B<readSeparator>(%options)
-See L<Mail::Box::Parser/"Parsing">
+Inherited, see L<Mail::Box::Parser/"Parsing">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Box::Parser/"Internals">.
+Extends L<"Internals" in Mail::Box::Parser|Mail::Box::Parser/"Internals">.
=over 4
=item $obj-E<gt>B<closeFile>()
-See L<Mail::Box::Parser/"Internals">
+Inherited, see L<Mail::Box::Parser/"Internals">
-=item $obj-E<gt>B<defaultParserType>([CLASS])
+=item $obj-E<gt>B<defaultParserType>( [$class] )
-=item Mail::Box::Parser::Perl-E<gt>B<defaultParserType>([CLASS])
+=item Mail::Box::Parser::Perl-E<gt>B<defaultParserType>( [$class] )
-See L<Mail::Box::Parser/"Internals">
+Inherited, see L<Mail::Box::Parser/"Internals">
-=item $obj-E<gt>B<openFile>(ARGS)
+=item $obj-E<gt>B<openFile>($args)
-See L<Mail::Box::Parser/"Internals">
+Inherited, see L<Mail::Box::Parser/"Internals">
=item $obj-E<gt>B<takeFileInfo>()
-See L<Mail::Box::Parser/"Internals">
+Inherited, see L<Mail::Box::Parser/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Parser/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Parser|Mail::Box::Parser/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Parser::Perl-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Parser::Perl-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Parser::Perl-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Parser::Perl-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Parser::Perl-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Parser::Perl-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Parser/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Parser|Mail::Box::Parser/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -296,12 +296,12 @@ The erroneous line will be added to the preceding field.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Box::Parser;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
use Carp;
@@ -41,19 +41,19 @@ used automatically.
=back
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Box::Parser-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Parser-E<gt>B<new>(%options)
Create a parser object which can handle one file. For
mbox-like mailboxes, this object can be used to read a whole folder. In
@@ -110,7 +110,7 @@ Returns the name of the file this parser is working on.
Restart the parser on a certain file, usually because the content has
changed.
-=item $obj-E<gt>B<start>(OPTIONS)
+=item $obj-E<gt>B<start>(%options)
Start the parser by opening a file.
@@ -137,50 +137,50 @@ folder will not be removed (is not the responsibility of the parser).
=over 4
-=item $obj-E<gt>B<bodyAsFile>(FILEHANDLE [,CHARS [,LINES]])
+=item $obj-E<gt>B<bodyAsFile>( $fh [$chars, [$lines]] )
Try to read one message-body from the file, and immediately write
it to the specified file-handle. Optionally, the predicted number
-of CHARacterS and/or LINES to be read can be supplied. These values may be
+of CHARacterS and/or $lines to be read can be supplied. These values may be
C<undef> and may be wrong.
The return is a list of three scalars: the location of the body (begin
and end) and the number of lines in the body.
-=item $obj-E<gt>B<bodyAsList>([,CHARS [,LINES]])
+=item $obj-E<gt>B<bodyAsList>( [$chars, [$lines]] )
Try to read one message-body from the file. Optionally, the predicted number
-of CHARacterS and/or LINES to be read can be supplied. These values may be
+of CHARacterS and/or $lines to be read can be supplied. These values may be
C<undef> and may be wrong.
The return is a list of scalars, each containing one line (including
line terminator), preceded by two integers representing the location
in the file where this body started and ended.
-=item $obj-E<gt>B<bodyAsString>([,CHARS [,LINES]])
+=item $obj-E<gt>B<bodyAsString>( [$chars, [$lines]] )
Try to read one message-body from the file. Optionally, the predicted number
-of CHARacterS and/or LINES to be read can be supplied. These values may be
+of CHARacterS and/or $lines to be read can be supplied. These values may be
C<undef> and may be wrong.
The return is a list of three scalars, the location in the file
where the body starts, where the body ends, and the string containing the
whole body.
-=item $obj-E<gt>B<bodyDelayed>([,CHARS [,LINES]])
+=item $obj-E<gt>B<bodyDelayed>( [$chars, [$lines]] )
Try to read one message-body from the file, but the data is skipped.
-Optionally, the predicted number of CHARacterS and/or LINES to be skipped
+Optionally, the predicted number of CHARacterS and/or $lines to be skipped
can be supplied. These values may be C<undef> and may be wrong.
The return is a list of four scalars: the location of the body (begin and
end), the size of the body, and the number of lines in the body. The
number of lines may be C<undef>.
-=item $obj-E<gt>B<filePosition>([POSITION])
+=item $obj-E<gt>B<filePosition>( [$position] )
Returns the location of the next byte to be used in the file which is
-parsed. When a POSITION is specified, the location in the file is
+parsed. When a $position is specified, the location in the file is
moved to the indicated spot first.
=item $obj-E<gt>B<lineSeparator>()
@@ -195,7 +195,7 @@ a LF. Mac uses CR.
Remove the last-pushed separator from the list which is maintained by the
parser. This will return C<undef> when there is none left.
-=item $obj-E<gt>B<pushSeparator>(STRING|REGEXP)
+=item $obj-E<gt>B<pushSeparator>(STRING|Regexp)
Add a boundary line. Separators tell the parser where to stop reading.
A famous separator is the C<From>-line, which is used in Mbox-like
@@ -203,7 +203,7 @@ folders to separate messages. But also parts (I<attachments>) is a
message are divided by separators.
The specified STRING describes the start of the separator-line. The
-REGEXP can specify a more complicated format.
+Regexp can specify a more complicated format.
=item $obj-E<gt>B<readHeader>()
@@ -217,7 +217,7 @@ example:
my ($where, @header) = $parser->readHeader;
-=item $obj-E<gt>B<readSeparator>(OPTIONS)
+=item $obj-E<gt>B<readSeparator>(%options)
Read the currently active separator (the last one which was pushed). The
line (or C<undef>) is returned. Blank-lines before the separator lines
@@ -237,23 +237,23 @@ separator. A new separator is activated using L<pushSeparator()|Mail::Box::Pars
Close the file which was being parsed.
-=item $obj-E<gt>B<defaultParserType>([CLASS])
+=item $obj-E<gt>B<defaultParserType>( [$class] )
-=item Mail::Box::Parser-E<gt>B<defaultParserType>([CLASS])
+=item Mail::Box::Parser-E<gt>B<defaultParserType>( [$class] )
Returns the parser to be used to parse all subsequent
messages, possibly first setting the parser using the optional argument.
Usually, the parser is autodetected; the C<C>-based parser will be used
when it can be, and the Perl-based parser will be used otherwise.
-The CLASS argument allows you to specify a package name to force a
+The $class argument allows you to specify a package name to force a
particular parser to be used (such as your own custom parser). You have
to C<use> or C<require> the package yourself before calling this method
with an argument. The parser must be a sub-class of C<Mail::Box::Parser>.
-=item $obj-E<gt>B<openFile>(ARGS)
+=item $obj-E<gt>B<openFile>($args)
-Open the file to be parsed. ARGS is a ref-hash of options.
+Open the file to be parsed. $args is a ref-hash of options.
-Option --Default
filename <required>
@@ -275,75 +275,75 @@ Capture some data about the file being parsed, to be compared later.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Parser-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Parser-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Parser-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Parser-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Parser-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Parser-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -381,12 +381,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::Search::Grep;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Search';
@@ -41,19 +41,19 @@ Regular Expression and Print". Although you can search using regular
expressions (the Perl way of them), you do not have to print those as
result.
-See L<documentation in the base class|Mail::Box::Search/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Search|Mail::Box::Search/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Search/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Search|Mail::Box::Search/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Search/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Search|Mail::Box::Search/"Constructors">.
=over 4
-=item Mail::Box::Search::Grep-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Search::Grep-E<gt>B<new>(%options)
Create a UNIX-grep like search filter.
@@ -155,113 +155,113 @@ both formats.
=head2 Searching
-See L<documentation in the base class|Mail::Box::Search/"Searching">.
+Extends L<"Searching" in Mail::Box::Search|Mail::Box::Search/"Searching">.
=over 4
-=item $obj-E<gt>B<inBody>(PART, BODY)
+=item $obj-E<gt>B<inBody>($part, $body)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
-=item $obj-E<gt>B<inHead>(PART, HEAD)
+=item $obj-E<gt>B<inHead>($part, $head)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
-=item $obj-E<gt>B<search>(FOLDER|THREAD|MESSAGE|ARRAY-OF-MESSAGES)
+=item $obj-E<gt>B<search>($folder|$thread|$message|ARRAY)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
-=item $obj-E<gt>B<searchPart>(PART)
+=item $obj-E<gt>B<searchPart>($part)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
=back
=head2 The Results
-See L<documentation in the base class|Mail::Box::Search/"The Results">.
+Extends L<"The Results" in Mail::Box::Search|Mail::Box::Search/"The Results">.
=over 4
-=item $obj-E<gt>B<printMatch>([FILEHANDLE], MATCH)
+=item $obj-E<gt>B<printMatch>( [$fh], $match )
-=item $obj-E<gt>B<printMatchedBody>(FILEHANDLE, MATCH)
+=item $obj-E<gt>B<printMatchedBody>($fh, $match)
-=item $obj-E<gt>B<printMatchedHead>(FILEHANDLE, MATCH)
+=item $obj-E<gt>B<printMatchedHead>($fh, $match)
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Search/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Search|Mail::Box::Search/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Search::Grep-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Search::Grep-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Search::Grep-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Search::Grep-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Search::Grep-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Search::Grep-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Search/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Search|Mail::Box::Search/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -281,12 +281,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::Search::SpamAssassin;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Search';
@@ -47,19 +47,19 @@ The spam-assassin module version 2 is not really well adapted for
L<Mail::Message|Mail::Message> objects, which will make this search even slower than
spam-detection already is.
-See L<documentation in the base class|Mail::Box::Search/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Search|Mail::Box::Search/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Search/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Search|Mail::Box::Search/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Search/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Search|Mail::Box::Search/"Constructors">.
=over 4
-=item Mail::Box::Search::SpamAssassin-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Search::SpamAssassin-E<gt>B<new>(%options)
Create a spam filter. Internally, a Mail::SpamAssassin object is
maintained.
@@ -142,7 +142,7 @@ example:
=head2 Searching
-See L<documentation in the base class|Mail::Box::Search/"Searching">.
+Extends L<"Searching" in Mail::Box::Search|Mail::Box::Search/"Searching">.
=over 4
@@ -151,107 +151,107 @@ See L<documentation in the base class|Mail::Box::Search/"Searching">.
Returns the internally maintained assassinator object. You may want
to reach this object for complex configuration.
-=item $obj-E<gt>B<inBody>(PART, BODY)
+=item $obj-E<gt>B<inBody>($part, $body)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
-=item $obj-E<gt>B<inHead>(PART, HEAD)
+=item $obj-E<gt>B<inHead>($part, $head)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
-=item $obj-E<gt>B<search>(FOLDER|THREAD|MESSAGE|ARRAY-OF-MESSAGES)
+=item $obj-E<gt>B<search>($folder|$thread|$message|ARRAY)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
-=item $obj-E<gt>B<searchPart>(PART)
+=item $obj-E<gt>B<searchPart>($part)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
=back
=head2 The Results
-See L<documentation in the base class|Mail::Box::Search/"The Results">.
+Extends L<"The Results" in Mail::Box::Search|Mail::Box::Search/"The Results">.
=over 4
-=item $obj-E<gt>B<printMatch>([FILEHANDLE], HASH)
+=item $obj-E<gt>B<printMatch>( [$fh], HASH )
-See L<Mail::Box::Search/"The Results">
+Inherited, see L<Mail::Box::Search/"The Results">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Search/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Search|Mail::Box::Search/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Search::SpamAssassin-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Search::SpamAssassin-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Search::SpamAssassin-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Search::SpamAssassin-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Search::SpamAssassin-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Search::SpamAssassin-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Search/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Search|Mail::Box::Search/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -271,12 +271,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::Search;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -50,19 +50,19 @@ UNDER CONSTRUCTION till L<Mail::Transport::IMAP4|Mail::Transport::IMAP4> is comp
=back
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Box::Search-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Search-E<gt>B<new>(%options)
Create a filter.
@@ -165,22 +165,22 @@ search will include the preamble and epilogue.
=over 4
-=item $obj-E<gt>B<inBody>(PART, BODY)
+=item $obj-E<gt>B<inBody>($part, $body)
Tests whether body contains the requesting information. See the
specific search module for its parameters.
-=item $obj-E<gt>B<inHead>(PART, HEAD)
+=item $obj-E<gt>B<inHead>($part, $head)
Tests whether header contains the requesting information. See the
specific search module for its parameters.
-=item $obj-E<gt>B<search>(FOLDER|THREAD|MESSAGE|ARRAY-OF-MESSAGES)
+=item $obj-E<gt>B<search>($folder|$thread|$message|ARRAY)
-Check which messages from the FOLDER (Mail::Box) match the
+Check which messages from the $folder (Mail::Box) match the
search parameters. The matched messages are returned as list. You
-can also specify a THREAD (a L<Mail::Box::Thread::Node|Mail::Box::Thread::Node>), one single
-MESSAGE (a L<Mail::Message|Mail::Message>), or an array of messages.
+can also specify a $thread (a L<Mail::Box::Thread::Node|Mail::Box::Thread::Node>), one single
+$message (a L<Mail::Message|Mail::Message>), or an ARRAY of messages.
Sometimes we know how only one match is needed. In this case, this
searching will stop at the first match. For instance, when C<limit> is C<-1>
@@ -201,9 +201,9 @@ example:
my $thread = $message->threadStart;
$grep->search($thread);
-=item $obj-E<gt>B<searchPart>(PART)
+=item $obj-E<gt>B<searchPart>($part)
-Search this message PART for matches.
+Search this message $part for matches.
=back
@@ -211,7 +211,7 @@ Search this message PART for matches.
=over 4
-=item $obj-E<gt>B<printMatch>([FILEHANDLE], HASH)
+=item $obj-E<gt>B<printMatch>( [$fh], HASH )
Print the information about the match (see L<new(deliver)|Mail::Box::Search/"METHODS">) in
some understandable way. If no file handle
@@ -222,75 +222,75 @@ C<perldoc -f select>).
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Search-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Search-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Search-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Search-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Search-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Search-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -329,12 +329,12 @@ The C<in> option defines only three names.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -6,7 +6,7 @@
use strict;
package Mail::Box::Thread::Manager;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -38,11 +38,8 @@ sub init($)
#-------------------------------------------
-
sub folders() { values %{shift->{MBTM_folders}} }
-#-------------------------------------------
-
sub includeFolder(@)
{ my $self = shift;
@@ -63,8 +60,6 @@ sub includeFolder(@)
$self;
}
-#-------------------------------------------
-
sub removeFolder(@)
{ my $self = shift;
@@ -89,7 +84,6 @@ sub removeFolder(@)
#-------------------------------------------
-
sub thread($)
{ my ($self, $message) = @_;
my $msgid = $message->messageId;
@@ -128,8 +122,6 @@ sub thread($)
$thread;
}
-#-------------------------------------------
-
sub threadStart($)
{ my ($self, $message) = @_;
@@ -161,8 +153,6 @@ sub threadStart($)
$thread;
}
-#-------------------------------------------
-
sub all()
{ my $self = shift;
@@ -170,8 +160,6 @@ sub all()
$self->known;
}
-#-------------------------------------------
-
sub sortedAll(@)
{ my $self = shift;
@@ -179,16 +167,12 @@ sub sortedAll(@)
$self->sortedKnown(@_);
}
-#-------------------------------------------
-
sub known()
{ my $self = shift->_process_delayed_nodes->_cleanup;
grep {!defined $_->repliedTo} values %{$self->{MBTM_ids}};
}
-#-------------------------------------------
-
sub sortedKnown(;$$)
{ my $self = shift;
@@ -197,8 +181,8 @@ sub sortedKnown(;$$)
# Special care for double keys.
my %value;
- push @{$value{$prepare->($_)}}, $_ foreach $self->known;
- map { @{$value{$_}} } sort {$compare->($a, $b)} keys %value;
+ push @{$value{$prepare->($_)}}, $_ for $self->known;
+ map @{$value{$_}}, sort {$compare->($a, $b)} keys %value;
}
# When a whole folder is removed, many threads can become existing
@@ -238,7 +222,6 @@ sub _cleanup()
#-------------------------------------------
-
sub toBeThreaded($@)
{ my ($self, $folder) = (shift, shift);
return $self unless exists $self->{MBTM_folders}{$folder->name};
@@ -246,8 +229,6 @@ sub toBeThreaded($@)
$self;
}
-#-------------------------------------------
-
sub toBeUnthreaded($@)
{ my ($self, $folder) = (shift, shift);
@@ -256,8 +237,6 @@ sub toBeUnthreaded($@)
$self;
}
-#-------------------------------------------
-
sub inThread($)
{ my ($self, $message) = @_;
@@ -38,19 +38,19 @@ and speed), it also can maintain threads from messages residing in different
opened folders. Both facilities are rare for mail-agents. The manager
creates flexible trees with L<Mail::Box::Thread::Node|Mail::Box::Thread::Node> objects.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Box::Thread::Manager-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Thread::Manager-E<gt>B<new>(%options)
A C<Mail::Box::Thread::Manager> object is usually created by a
L<Mail::Box::Manager|Mail::Box::Manager>. One manager can produce more than one of these
@@ -147,7 +147,7 @@ example:
Returns the folders as managed by this threader.
-=item $obj-E<gt>B<includeFolder>(FOLDERS)
+=item $obj-E<gt>B<includeFolder>($folders)
Add one or more folders to the list of folders whose messages are
organized in the threads maintained by this object. Duplicated
@@ -162,7 +162,7 @@ example:
$threads->includeFolder($inbox, $draft);
-=item $obj-E<gt>B<removeFolder>(FOLDERS)
+=item $obj-E<gt>B<removeFolder>($folders)
Remove one or more folders from the list of folders whose messages are
organized in the threads maintained by this object.
@@ -200,19 +200,19 @@ L<inThread()|Mail::Box::Thread::Manager/"Internals"> and L<thread()|Mail::Box::T
Be warned that, each time a message's header is read from the folder,
the return of the method can change.
-=item $obj-E<gt>B<sortedAll>([PREPARE [COMPARE]])
+=item $obj-E<gt>B<sortedAll>( [$prepare, [$compare]] )
Returns L<all()|Mail::Box::Thread::Manager/"The Threads"> the threads by default, but sorted on timestamp.
-=item $obj-E<gt>B<sortedKnown>([PREPARE [,COMPARE]])
+=item $obj-E<gt>B<sortedKnown>( [$prepare, [$compare]] )
Returns all L<known()|Mail::Box::Thread::Manager/"The Threads"> threads, in sorted order. By default, the threads
-will be sorted on timestamp, But a different COMPARE method can be
+will be sorted on timestamp, But a different $compare method can be
specified.
-=item $obj-E<gt>B<thread>(MESSAGE)
+=item $obj-E<gt>B<thread>($message)
-Returns the thread where this MESSAGE is the start of. However, there
+Returns the thread where this $message is the start of. However, there
is a possibility that this message is a reply itself.
Usually, all messages which are in reply of this message are dated later
@@ -225,7 +225,7 @@ example:
my $thread = $threads->thread($inbox->message(3));
print $thread->string;
-=item $obj-E<gt>B<threadStart>(MESSAGE)
+=item $obj-E<gt>B<threadStart>($message)
Based on a message, and facts from previously detected threads, try
to build solid knowledge about the thread where this message is in.
@@ -236,108 +236,108 @@ to build solid knowledge about the thread where this message is in.
=over 4
-=item $obj-E<gt>B<createDummy>(MESSAGE-ID)
+=item $obj-E<gt>B<createDummy>($message_id)
Get a replacement message to be used in threads. Be warned that a
dummy is not a member of any folder, so the program working with
threads must test with L<Mail::Message::isDummy()|Mail::Message/"The message"> before trying things only
available to real messages.
-=item $obj-E<gt>B<inThread>(MESSAGE)
+=item $obj-E<gt>B<inThread>($message)
Collect the thread-information of one message. The `In-Reply-To' and
`Reference' header-fields are processed. If this method is called on
a message whose header was not read yet (as usual for MH-folders,
for instance) the reading of that header will be triggered here.
-=item $obj-E<gt>B<outThread>(MESSAGE)
+=item $obj-E<gt>B<outThread>($message)
Remove the message from the thread-infrastructure. A message is
replaced by a dummy.
-=item $obj-E<gt>B<toBeThreaded>(FOLDER, MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($folder, @messages)
Include the specified messages in/from the threads managed by
this object, if this folder is maintained by this thread-manager.
-=item $obj-E<gt>B<toBeUnthreaded>(FOLDER, MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($folder, @messages)
-Remove the specified messages in/from the threads managed by
+Remove the specified @messages in/from the threads managed by
this object, if this folder is maintained by this thread-manager.
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Thread::Manager-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Thread::Manager-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Thread::Manager-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Thread::Manager-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Thread::Manager-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Thread::Manager-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -442,12 +442,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -6,7 +6,7 @@
use strict;
package Mail::Box::Thread::Node;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -64,8 +64,6 @@ sub message()
$messages[0];
}
-#-------------------------------------------
-
sub addMessage($)
{ my ($self, $message) = @_;
@@ -102,7 +100,6 @@ sub folded(;$) # compatibility <2.0
#-------------------------------------------
-
sub repliedTo()
{ my $self = shift;
@@ -111,8 +108,6 @@ sub repliedTo()
: $self->{MBTN_parent};
}
-#-------------------------------------------
-
sub follows($$)
{ my ($self, $thread, $how) = @_;
@@ -148,8 +143,6 @@ sub follows($$)
$self;
}
-#-------------------------------------------
-
sub followedBy(@)
{ my $self = shift;
@@ -157,16 +150,12 @@ sub followedBy(@)
$self;
}
-#-------------------------------------------
-
sub followUps()
{ my $self = shift;
$self->{MBTN_followUps} ? values %{$self->{MBTN_followUps}} : ();
}
-#-------------------------------------------
-
sub sortedFollowUps()
{ my $self = shift;
@@ -179,10 +168,6 @@ sub sortedFollowUps()
#-------------------------------------------
-
-#-------------------------------------------
-
-
sub threadToString(;$$$) # two undocumented parameters for layout args
{ my $self = shift;
my $code = shift || sub {shift->head->study('subject')};
@@ -220,8 +205,6 @@ sub threadToString(;$$$) # two undocumented parameters for layout args
join '', @out;
}
-#-------------------------------------------
-
sub startTimeEstimate()
{ my $self = shift;
@@ -240,8 +223,6 @@ sub startTimeEstimate()
$earliest;
}
-#-------------------------------------------
-
sub endTimeEstimate()
{ my $self = shift;
@@ -27,19 +27,19 @@ multiple folders, and merge there content, you may find the same message
in more folders. All versions of the same message (based on message-id)
are stored in the same node.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Box::Thread::Node-E<gt>B<new>(OPTIONS)
+=item Mail::Box::Thread::Node-E<gt>B<new>(%options)
You will not call this method yourself. The L<Mail::Box::Thread::Manager|Mail::Box::Thread::Manager>
object will call it to construct C<Mail::Box::Thread::Node> objects.
@@ -81,13 +81,13 @@ specify it when you don't have the message yet.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE)
+=item $obj-E<gt>B<addMessage>($message)
Add one message to the thread node. If the node contains a dummy, then
the dummy is replaced. Otherwise, the messages is added to the end of the
list.
-=item $obj-E<gt>B<expand>([BOOLEAN])
+=item $obj-E<gt>B<expand>( [BOOLEAN] )
Returns whether this (part of the) folder has to be shown expanded or not.
This is simply done by a label, which means that most folder types can
@@ -140,26 +140,26 @@ listed in this node will have the same ID.
Returns the list of follow-ups to this thread node. This list
may contain parsed, not-parsed, and dummy messages.
-=item $obj-E<gt>B<followedBy>(THREADS)
+=item $obj-E<gt>B<followedBy>($threads)
-Register that the THREADS are follow-ups to this message. These
+Register that the $threads are follow-ups to this message. These
follow-ups need not be related to each other in any way other than
sharing the same parent.
Defining the same relation more than once will not cause information to
be duplicated.
-=item $obj-E<gt>B<follows>(THREAD, QUALITY)
+=item $obj-E<gt>B<follows>($thread, $quality)
-Register that the current thread is a reply to the specified THREAD. The
-QUALITY of the relation is specified by the second argument. The method
+Register that the current thread is a reply to the specified $thread. The
+$quality of the relation is specified by the second argument. The method
returns C<undef> if the link is not accepted in order to avoid circular
references.
The relation may be specified more than once, but only the most confident
-relation is used. For example, if a reply (QUALITY equals C<REPLY>) is
+relation is used. For example, if a reply ($quality equals C<REPLY>) is
specified, later calls to the follow method will have no effect. If
-C<follows> is called with a QUALITY that matches the current quality, the
+C<follows> is called with a $quality that matches the current quality, the
new thread overrides the previous.
=item $obj-E<gt>B<repliedTo>()
@@ -209,7 +209,7 @@ example:
my ($question, $quality) = $answer->repliedTo;
if($question && $quality eq 'REPLY') { ... };
-=item $obj-E<gt>B<sortedFollowUps>([PREPARE [,COMPARE]])
+=item $obj-E<gt>B<sortedFollowUps>( [$prepare, [$compare]] )
Returns the list of L<followUps()|Mail::Box::Thread::Node/"The thread order">, but sorted. By default
sorting is based on the estimated time of the reply. See
@@ -243,7 +243,7 @@ example:
Number of messages in the thread starting at the current thread node, but
not counting the dummies.
-=item $obj-E<gt>B<recurse>(CODE-REF)
+=item $obj-E<gt>B<recurse>(CODE)
Execute a function for all sub-threads. If the subroutine returns true,
sub-threads are visited recursively. Otherwise, the current branch
@@ -270,7 +270,7 @@ example:
->threadStart
->threadMessages;
-=item $obj-E<gt>B<threadToString>([CODE])
+=item $obj-E<gt>B<threadToString>( [CODE] )
Translate a thread into a string. The string will contain at least one
line for each message which was found, but tries to fold dummies. This
@@ -315,75 +315,75 @@ Returns the sum of the size of all the messages in the thread.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box::Thread::Node-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box::Thread::Node-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box::Thread::Node-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box::Thread::Node-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box::Thread::Node-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box::Thread::Node-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -403,12 +403,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -6,7 +6,7 @@
use strict;
package Mail::Box::Tie::ARRAY;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Carp;
@@ -43,13 +43,9 @@ sub STORE($$)
$msg;
}
-#-------------------------------------------
-
sub FETCHSIZE() { scalar shift->{MBT_folder}->messages }
-#-------------------------------------------
-
sub PUSH(@)
{ my $folder = shift->{MBT_folder};
@@ -58,13 +54,8 @@ sub PUSH(@)
}
-#-------------------------------------------
-
-
sub DELETE($) { shift->{MBT_folder}->message(shift)->delete }
-#-------------------------------------------
-
sub STORESIZE($)
{ my $folder = shift->{MBT_folder};
@@ -75,7 +75,7 @@ example:
delete $inbox[5];
$inbox[5]->delete; #same
-=item $obj-E<gt>B<FETCH>(INDEX)
+=item $obj-E<gt>B<FETCH>($index)
Get the message which is at the indicated location in the list of
messages contained in this folder. Deleted messages will be returned
@@ -97,15 +97,15 @@ example:
if(@inbox > 10) # contains more than 10 messages?
my $nrmsgs = @inbox;
-=item $obj-E<gt>B<PUSH>(MESSAGES)
+=item $obj-E<gt>B<PUSH>(@messages)
-Add MESSAGES to the end of the folder.
+Add @messages to the end of the folder.
example:
push @inbox, $newmsg;
-=item $obj-E<gt>B<STORE>(INDEX, MESSAGE)
+=item $obj-E<gt>B<STORE>($index, $message)
Random message replacement is not permitted --doing so would disturb threads
etc. An error occurs if you try to do this. The only thing which is allowed
@@ -118,9 +118,9 @@ example:
$inbox[-1] = $add;
push @inbox, $add;
-=item $obj-E<gt>B<STORESIZE>(LENGTH)
+=item $obj-E<gt>B<STORESIZE>($length)
-Sets all messages behind from LENGTH to the end of folder to be deleted.
+Sets all messages behind from $length to the end of folder to be deleted.
=back
@@ -139,12 +139,12 @@ is not permitted to shrink or be mutilated.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -6,7 +6,7 @@
use strict;
package Mail::Box::Tie::HASH;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Carp;
@@ -22,11 +22,8 @@ sub TIEHASH(@)
#-------------------------------------------
-
sub FETCH($) { shift->{MBT_folder}->messageId(shift) }
-#-------------------------------------------
-
sub STORE($$)
{ my ($self, $key, $basicmsg) = @_;
@@ -37,8 +34,6 @@ sub STORE($$)
$self->{MBT_folder}->addMessages($basicmsg);
}
-#-------------------------------------------
-
sub FIRSTKEY()
{ my $self = shift;
@@ -68,8 +63,6 @@ sub NEXTKEY($)
$msg->messageId;
}
-#-------------------------------------------
-
sub EXISTS($)
{ my $folder = shift->{MBT_folder};
@@ -78,8 +71,6 @@ sub EXISTS($)
defined $msg && ! $msg->isDeleted;
}
-#-------------------------------------------
-
sub DELETE($)
{ my ($self, $msgid) = @_;
@@ -59,23 +59,23 @@ example:
%inbox = ();
%inbox = ($msg->messageId, $msg); #before adding msg
-=item $obj-E<gt>B<DELETE>(MESSAGE-ID)
+=item $obj-E<gt>B<DELETE>($message_id)
-Remove the message with the specified MESSAGE-ID.
+Remove the message with the specified $message_id.
example:
delete $inbox{$msgid};
-=item $obj-E<gt>B<EXISTS>(MESSAGE-ID)
+=item $obj-E<gt>B<EXISTS>($message_id)
-Check whether a message with a certain MESSAGE-ID exists.
+Check whether a message with a certain $message_id exists.
example:
if(exists $inbox{$msgid}) ...
-=item $obj-E<gt>B<FETCH>(MESSAGEID)
+=item $obj-E<gt>B<FETCH>($message_id)
Get the message with the specified id. The returned message may be
a dummy if message thread detection is used. Returns C<undef> when
@@ -90,7 +90,7 @@ example:
See L<NEXTKEY()|Mail::Box::Tie::HASH/"Tied Interface">.
-=item $obj-E<gt>B<NEXTKEY>(PREVIOUS)
+=item $obj-E<gt>B<NEXTKEY>($previous)
L<FIRSTKEY()|Mail::Box::Tie::HASH/"Tied Interface"> returns the first message-id/message pair from the folder,
and NEXTKEY returns the message-id/message pair for the next message,
@@ -109,7 +109,7 @@ example:
$msg->print unless $msg->isDeleted;
}
-=item $obj-E<gt>B<STORE>(undef, MESSAGE)
+=item $obj-E<gt>B<STORE>(undef, $message)
Store a message in the folder. The key must be C<undef>, because the
message-id of the specified message is taken. This is shown in the
@@ -128,12 +128,12 @@ example:
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Box::Tie;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use strict;
@@ -35,12 +35,12 @@ look simpler than programs using the more traditional method calls.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -256,12 +256,12 @@ multi-part message is produced.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -15,209 +15,209 @@ about the module.
Only the HTML version of this manual page will list the sections.
-=begin :html
+=begin html
<ol>
<li><strong><a name="general">General</a> sources of information</strong>
<ul>
- <li>MailBox distribution overview (Mail::Box-Overview)
- <li>MailBox simple recepies (Mail::Box-Cookbook)
+ <li>MailBox distribution overview (M<Mail::Box-Overview>)
+ <li>MailBox simple recepies (M<Mail::Box-Cookbook>)
</ul>
-<li><strong><a name="messages">Messages</a></strong> (L<Mail::Message|Mail::Message>)<br />
+<li><strong><a name="messages">Messages</a></strong> (M<Mail::Message>)<br />
See separate entries on header, body, fields
and construction in this index below.
<ul>
- <li>Structure of a Message
+ <li>L<Mail::Message/Structure of a Message>
<ul>
- <li>The header
- <li>The body
+ <li>L<Mail::Message/The header>
+ <li>L<Mail::Message/The body>
</ul>
<li>Coercing messages
- <li>Message object implementation
- <li>Message class implementation
+ <li>L<Mail::Message/Message object implementation>
+ <li>L<Mail::Message/Message class implementation>
</ul>
-<li><strong><a name="headers">Message headers</a></strong> (L<Mail::Message::Head|Mail::Message::Head>)
+<li><strong><a name="headers">Message headers</a></strong> (M<Mail::Message::Head>)
<ul>
- <li>Ordered header fields
- <li>Subsets of header fields
- <li>Head class implementation
+ <li>L<Mail::Message::Head/Ordered header fields>
+ <li>L<Mail::Message::Head/Subsets of header fields>
+ <li>L<Mail::Message::Head/Head class implementation>
</ul>
-<li><strong><a name="fields">Message header fields</a></strong> (L<Mail::Message::Field|Mail::Message::Field>)
+<li><strong><a name="fields">Message header fields</a></strong> (M<Mail::Message::Field>)
<ul>
- <li>Field syntax
+ <li>L<Mail::Message::Field/Field syntax>
<ul>
- <li>Folding fields
- <li>Structured fields
- <li>Comments in fields
+ <li>L<Mail::Message::Field/Folding fields>
+ <li>L<Mail::Message::Field/Structured fields>
+ <li>L<Mail::Message::Field/Comments in fields>
</ul>
- <li>Getting a field
+ <li>L<Mail::Message::Field/Getting a field>
<ul>
- <li>Using get() field
- <li>Using study() field
- <li>Using resent groups (Mail::Message::Head::ResentGroup)
- <li>Mailing list fields
- <li>Spam fighting fields
+ <li>L<Mail::Message::Field/Using get() field>
+ <li>L<Mail::Message::Field/Using study() field>
+ <li>L<Mail::Message::Field/Using resent groups> (M<Mail::Message::Head::ResentGroup>)
+ <li>L<Mail::Message::Head::ListGroup/Mailing list fields>
+ <li>L<Mail::Message::Head::SpamGroup/Spam fighting fields>
</ul>
- <li>The field's data
+ <li>L<Mail::Message::Field/The field's data>
<ul>
- <li>Access to the field
- <li>Using simplified field access
- <li>Specifying field data
+ <li>L<Mail::Message::Field/Access to the field>
+ <li>L<Mail::Message::Field/Using simplified field access>
+ <li>L<Mail::Message::Field/Specifying field data>
</ul>
- <li>Field class implementation
+ <li>L<Mail::Message::Field/Field class implementation>
</ul>
-<li><strong><a name="bodies">Message bodies</a></strong> (L<Mail::Message::Body|Mail::Message::Body>)
+<li><strong><a name="bodies">Message bodies</a></strong> (M<Mail::Message::Body>)
<ul>
- <li>Access to the body
+ <li>L<Mail::Message::Body/Access to the body>
<li>Body meta information
<ul>
- <li>Content types (MIME::Types)
- <li>Content transfer encoding (Mail::Message::TransferEnc)
+ <li>Content types (L<MIME::Types>)
+ <li>Content transfer encoding (M<Mail::Message::TransferEnc>)
</ul>
- <li>Multipart bodies (Mail::Message::Body::Multipart)
- <li>Nested (encapsulated) messages (Mail::Message::Body::Nested)
- <li>Body class implementation
+ <li>Multipart bodies (M<Mail::Message::Body::Multipart>)
+ <li>Nested (encapsulated) messages (M<Mail::Message::Body::Nested>)
+ <li>L<Mail::Message::Body/Body class implementation>
<ul>
- <li>Data collector bodies
- <li>Complex bodies
- <li>Character encoding PERL
+ <li>L<Mail::Message::Body/Data collector bodies>
+ <li>L<Mail::Message::Body/Complex bodies>
+ <li>L<Mail::Message::Body/Character encoding PERL>
</ul>
</ul>
<li><strong><a name="labels">Message labels</a></strong>
<ul>
- <li>Labels (Mail::Message)
+ <li>L<Mail::Message/Labels> (M<Mail::Message>)
<ul>
- <li>Predefined labels (Mail::Message)
+ <li>L<Mail::Message/Predefined labels> (M<Mail::Message>)
<li>Storing labels folder dependent
- <li>Flags in filename (Mail::Box::Maildir::Message)
- <li>Status and X-Status fields (MBOX and POP3)
- <li>The .mh_sequences file (Mail::Box::MH::Labels)
- <li>IMAP protocol flags (Mail::Box::IMAP4::Message)
- <li>Other labels (IMAP4)
- <li>Caching labels (IMAP4)
+ <li>L<Mail::Box::Maildir::Message/Flags in filename> (M<Mail::Box::Maildir::Message>)
+ <li>L<Mail::Message/Status and X-Status fields> (MBOX and POP3)
+ <li>L<Mail::Box::MH::Message/The .mh_sequences file> (M<Mail::Box::MH::Labels>)
+ <li>L<Mail::Box::IMAP4::Message/IMAP protocol flags> (M<Mail::Box::IMAP4::Message>)
+ <li>L<Mail::Box::IMAP4::Message/Other labels> (IMAP4)
+ <li>L<Mail::Box::IMAP4::Message/Caching labels> (IMAP4)
</ul>
</ul>
<li><strong><a name="process">Message processing</a></strong>
<ul>
- <li>Reading a message (Mail::Message::Construct::Read)
- <li>Building a message
- (Mail::Message::Construct::Build)
- <li>Reply to a message (Mail::Message::Construct::Reply)
- <li>Creating a forward
- (Mail::Message::Construct::Forward)
- <li>Bounce a message (Mail::Message::Construct::Bounce)
- <li>Rebuilding a message
- (Mail::Message::Construct::Rebuild)
+ <li>Reading a message (M<Mail::Message::Construct::Read>)
+ <li>L<Mail::Message::Construct::Build/Building a message>
+ (M<Mail::Message::Construct::Build>)
+ <li>Reply to a message (M<Mail::Message::Construct::Reply>)
+ <li>L<Mail::Message::Construct::Forward/Creating a forward>
+ (M<Mail::Message::Construct::Forward>)
+ <li>Bounce a message (M<Mail::Message::Construct::Bounce>)
+ <li>L<Mail::Message::Construct::Rebuild/Rebuilding a message>
+ (M<Mail::Message::Construct::Rebuild>)
<li>Convert messages
<ul>
- <li>To and from Mail::Internet objects (Mail::Message::Convert::MailInternet)
- <li>To and from MIME::Entity objects(Mail::Message::Convert::MimeEntity)
- <li>Into HTML (Mail::Message::Convert::Html)
+ <li>To and from M<Mail::Internet> objects (M<Mail::Message::Convert::MailInternet>)
+ <li>To and from M<MIME::Entity> objects(M<Mail::Message::Convert::MimeEntity>)
+ <li>Into HTML (M<Mail::Message::Convert::Html>)
</ul>
<li>Convert body contents
<ul>
- <li>From HTML to PostScript (Mail::Message::Convert::HtmlFormatPS)
- <li>From HTML into plain text (Mail::Message::Convert::HtmlFormatText)
- <li>Beautify text (Mail::Message::Convert::TextAutoformat)
+ <li>From HTML to PostScript (M<Mail::Message::Convert::HtmlFormatPS>)
+ <li>From HTML into plain text (M<Mail::Message::Convert::HtmlFormatText>)
+ <li>Beautify text (M<Mail::Message::Convert::TextAutoformat>)
</ul>
</ul>
-<li><strong><a name="folders">Folders</a></strong> (L<Mail::Box|Mail::Box>)
+<li><strong><a name="folders">Folders</a></strong> (M<Mail::Box>)
See separate section for type specifics below.
<ul>
<li>Folder managers
<ul>
- <li>Managing open folders (Mail::Box::Manager)
- <li>Managing a user (Mail::Box::Manage::User)
+ <li>L<Mail::Box::Manager/Managing open folders> (M<Mail::Box::Manager>)
+ <li>L<Mail::Box::Manager/Managing a user> (M<Mail::Box::Manage::User>)
</ul>
- <li>Folder types (Mail::Box)
+ <li>Folder types (M<Mail::Box>)
<ul>
- <li>Different kinds of folders
- <li>Available folder types
- <li>Folder class implementation
+ <li>L<Mail::Box/Different kinds of folders>
+ <li>L<Mail::Box/Available folder types>
+ <li>L<Mail::Box/Folder class implementation>
</ul>
- <li>Folder tied as array (Mail::Box::Tie::ARRAY)
+ <li>L<Mail::Box::Tie::ARRAY/Folder tied as array> (M<Mail::Box::Tie::ARRAY>)
<ul>
- <li>Limitations
+ <li>L<Mail::Box::Tie::ARRAY/Limitations>
</ul>
- <li>Folder tied as hash (Mail::Box::Tie::HASH)
- <li>Folder locking (Mail::Box::Locker)
- <li>Searching folders (Mail::Box::Search)
+ <li>Folder tied as hash (M<Mail::Box::Tie::HASH>)
+ <li>Folder locking (M<Mail::Box::Locker>)
+ <li>Searching folders (M<Mail::Box::Search>)
<ul>
- <li>scan header and body (Mail::Box::Search::Grep)
- <li>check for spam (Mail::Box::Search::SpamAssassin)
+ <li>scan header and body (M<Mail::Box::Search::Grep>)
+ <li>check for spam (M<Mail::Box::Search::SpamAssassin>)
</ul>
<li>Managing messages located in folders (Mail::Box::Message)
</ul>
<li><strong><a name="ftypes">Folder types</a></strong>
<ul>
- <li>DBX folders (Mail::Box::Dbx, read only)
+ <li>DBX folders (M<Mail::Box::Dbx>, read only)
<ul>
- <li>How DBX folders work
- <li>This implementation
- <li>Converting DBX folders to MBOX
+ <li>L<Mail::Box::Dbx/How DBX folders work>
+ <li>L<Mail::Box::Dbx/This implementation>
+ <li>L<Mail::Box::Dbx/Converting DBX folders to MBOX>
</ul>
- <li>IMAP4 folders (Mail::Box::IMAP4)
+ <li>IMAP4 folders (M<Mail::Box::IMAP4>)
<ul>
- <li>How IMAP4 folders work
+ <li>L<Mail::Box::IMAP4/How IMAP4 folders work>
</ul>
- <li>MAILDIR folders (Mail::Box::Maildir)
+ <li>MAILDIR folders (M<Mail::Box::Maildir>)
<ul>
- <li>How MAILDIR folders work
+ <li>L<Mail::Box::Maildir/How MAILDIR folders work>
</ul>
- <li>MBOX folders (Mail::Box::Mbox)
+ <li>MBOX folders (M<Mail::Box::Mbox>)
<ul>
- <li>How MBOX folders work
- <li>Simulation of sub-folders
+ <li>L<Mail::Box::Mbox/How MBOX folders work>
+ <li>L<Mail::Box::Mbox/Simulation of sub-folders>
</ul>
- <li>MH folders (Mail::Box::MH)
+ <li>MH folders (M<Mail::Box::MH>)
<ul>
- <li>How MH folders work
- <li>This implementation
- <li>An index-file
+ <li>L<Mail::Box::MH/How MH folders work>
+ <li>L<Mail::Box::MH/This implementation>
+ <li>L<Mail::Box::MH/An index-file>
</ul>
- <li>POP3 folders (Mail::Box::POP3)
+ <li>POP3 folders (M<Mail::Box::POP3>)
<ul>
- <li>How POP3 folders work
- <li>This implementation
+ <li>L<Mail::Box::POP3/How POP3 folders work>
+ <li>L<Mail::Box::POP3/This implementation>
</ul>
</ul>
<li><strong><a name="threads">Discussion threads</a></strong>
<ul>
- <li>The thread manager (Mail::Box::Thread::Manager)
+ <li>The thread manager (M<Mail::Box::Thread::Manager>)
<ul>
- <li>Maintaining threads
- <li>Delayed thread detection
+ <li>L<Mail::Box::Thread::Manager/Maintaining threads>
+ <li>L<Mail::Box::Thread::Manager/Delayed thread detection>
</ul>
- <li>The thread node (Mail::Box::Thread::Node)
+ <li>The thread node (M<Mail::Box::Thread::Node>)
</ul>
-<li><strong><a name="send">Transmitting messages</a></strong> (L<Mail::Transport|Mail::Transport>)
+<li><strong><a name="send">Transmitting messages</a></strong> (M<Mail::Transport>)
<ul>
- <li>Sending (Mail::Transport::Send)
+ <li>Sending (M<Mail::Transport::Send>)
<ul>
- <li>Via Exim (Mail::Transport::Exim)
- <li>Via Mailx (Mail::Transport::Mailx)
- <li>Via Qmail (Mail::Transport::Qmail)
- <li>Via Sendmail or Postfix (Mail::Transport::Sendmail)
- <li>Via raw SMTP (Mail::Transport::SMTP)
+ <li>Via Exim (M<Mail::Transport::Exim>)
+ <li>Via Mailx (M<Mail::Transport::Mailx>)
+ <li>Via Qmail (M<Mail::Transport::Qmail>)
+ <li>Via Sendmail or Postfix (M<Mail::Transport::Sendmail>)
+ <li>Via raw SMTP (M<Mail::Transport::SMTP>)
</ul>
- <li>Receiving (Mail::Transport::Receive)
+ <li>Receiving (M<Mail::Transport::Receive>)
<ul>
- <li>Via POP3 (Mail::Transport::POP3)
+ <li>Via POP3 (M<Mail::Transport::POP3>)
</ul>
<li>Bi-directional
<ul>
- <li>Via IMAP4 (Mail::Transport::IMAP4)
+ <li>Via IMAP4 (M<Mail::Transport::IMAP4>)
</ul>
</ul>
@@ -229,39 +229,39 @@ Only the HTML version of this manual page will list the sections.
<ul>
<li>Lazy extraction
<li>Picking the optimal body class
- <li>Reducing the header size
- (Mail::Message::Head::Partial)
+ <li>L<Mail::Message::Head::Partial/Reducing the header size>
+ (M<Mail::Message::Head::Partial>)
<li>
</ul>
- <li>Destructing messages (Mail::Box::Message::Destructed)
+ <li>Destructing messages (M<Mail::Box::Message::Destructed>)
</ul>
<li><strong>Additional modules</strong>
<ul>
<li>Extensions
<ul>
- <li>Mail::Box::Parser::C, a faster parser
- <li>HTML::FromMail,
+ <li>M<Mail::Box::Parser::C>, a faster parser
+ <li>L<HTML::FromMail|http://perl.overmeer.net/html-from-mail/html/>,
webmail applications builder
</ul>
<li>Helper modules
<ul>
- <li>MIME::Types
- <li>Object::Realize::Later
- <li>User::Identity
+ <li>L<MIME::Types|http://perl.overmeer.net/mimetypes/html/>
+ <li>L<Object::Realize::Later>
+ <li>L<User::Identity|http://perl.overmeer.net/userid/html/>
</ul>
</ul>
</ol>
-=end :html
+=end html
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -300,12 +300,12 @@ All classes are written to be extensible.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Box;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -226,7 +226,7 @@ ERROR
sub addMessages(@)
{ my $self = shift;
- map {$self->addMessage($_)} @_;
+ map $self->addMessage($_), @_;
}
@@ -563,7 +563,7 @@ sub scanForMessages($$$$)
{ my ($self, $startid, $msgids, $moment, $window) = @_;
# Set-up msgid-list
- my %search = map {($_ => 1)} ref $msgids ? @$msgids : $msgids;
+ my %search = map +($_ => 1), ref $msgids ? @$msgids : $msgids;
return () unless keys %search;
# do not run on empty folder
@@ -838,32 +838,6 @@ sub DESTROY
}
#-------------------------------------------
-# Instance variables
-# MB_access: new(access)
-# MB_body_type: new(body_type)
-# MB_coerce_opts: Options which have to be applied to the messages which
-# are coerced into this folder.
-# MB_current: Used by some mailbox-types to save last read message.
-# MB_field_type: new(field_type)
-# MB_folderdir: new(folderdir)
-# MB_foldername: new(folder)
-# MB_head_type: new(head_type)
-# MB_init_options: A copy of all the arguments given to the constructor
-# MB_is_closed: Whether or not the mailbox is closed
-# MB_extract: When to extract the body on the moment the header is read
-# MB_keep_dups: new(keep_dups)
-# MB_locker: A reference to the mail box locker.
-# MB_manager: new(manager)
-# MB_messages: A list of all the messages in the folder
-# MB_message_type: new(message_type)
-# MB_modified: true when the message is modified for sure
-# MB_msgid: A hash of all the messages in the mailbox, keyed on message ID
-# MB_open_time: The time at which a mail box is first opened
-# MB_organization: new(organization)
-# MB_remove_empty: new(remove_when_empty)
-# MB_save_on_exit: new(save_on_exit)
-
-#-------------------------------------------
1;
@@ -68,13 +68,13 @@ file withing the same directory.
No object in your program will be of type C<Mail::Box>: it is only used
as base class for the real folder types. C<Mail::Box> is extended by
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 OVERLOADED
=over 4
-=item overload: B<"">()
+=item overload: B<"">
(stringification)
The folder objects stringify to their name. This simplifies especially
@@ -88,7 +88,7 @@ example: use overloaded folder as string
print "$folder contains $msgcount messages\n";
}
-=item overload: B<@{}>()
+=item overload: B<@{}>
When the folder is used as if it is a reference to an array, it will
show the messages, like L<messages()|Mail::Box/"The messages"> and L<message()|Mail::Box/"The messages"> would do.
@@ -101,7 +101,7 @@ example: use overloaded folder as array
foreach my $msg (@$folder) ...
foreach my $msg ($folder->messages) ... # same
-=item overload: B<cmp>()
+=item overload: B<cmp>
(string comparison) folders are compared based on their name. The sort
rules are those of the build-in C<cmp>.
@@ -110,17 +110,17 @@ rules are those of the build-in C<cmp>.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Box-E<gt>B<new>(OPTIONS)
+=item Mail::Box-E<gt>B<new>(%options)
-Open a new folder. A list of labeled OPTIONS for the mailbox can be
+Open a new folder. A list of labeled %options for the mailbox can be
supplied. Some options pertain to Mail::Box, and others are added by
sub-classes.
@@ -422,7 +422,7 @@ binary data to the screen, which is a security risk.
=over 4
-=item $obj-E<gt>B<addMessage>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<addMessage>($message, %options)
Add a message to the folder. A message is usually a
L<Mail::Box::Message|Mail::Box::Message> object or a sub-class thereof. The message
@@ -461,16 +461,16 @@ example:
$folder->addMessage($msg);
$folder->addMessages($msg1, $msg2, ...);
-=item $obj-E<gt>B<addMessages>(MESSAGE [, MESSAGE, ...])
+=item $obj-E<gt>B<addMessages>(@messages)
-Adds a set of MESSAGE objects to the open folder at once. For some folder
+Adds a set of message objects to the open folder at once. For some folder
types this may be faster than adding them one at a time.
example:
$folder->addMessages($msg1, $msg2, ...);
-=item Mail::Box-E<gt>B<appendMessages>(OPTIONS)
+=item Mail::Box-E<gt>B<appendMessages>(%options)
Append one or more messages to an unopened folder.
Usually, this method is called by the L<Mail::Box::Manager::appendMessage()|Mail::Box::Manager/"Move messages to folders">,
@@ -478,7 +478,7 @@ in which case the correctness of the folder type is checked.
For some folder types it is required to open the folder before it can
be used for appending. This can be fast, but this can also be very
-slow (depends on the implementation). All OPTIONS passed will also be
+slow (depends on the implementation). All %options passed will also be
used to open the folder, if needed.
-Option --Default
@@ -524,7 +524,7 @@ better:
my Mail::Box::Manager $mgr;
$mgr->appendMessages($message, folder => '=xyz');
-=item $obj-E<gt>B<close>(OPTIONS)
+=item $obj-E<gt>B<close>(%options)
Close the folder, which usually implies writing the changes. This will
return C<false> when writing is required but fails. Please do check this
@@ -575,7 +575,7 @@ example:
$f->close
or die "Couldn't write $f: $!\n";
-=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
+=item $obj-E<gt>B<copyTo>($folder, %options)
Copy the folder's messages to a new folder. The new folder may be of
a different type.
@@ -625,7 +625,7 @@ example:
$imap->copyTo($mh, delete_copied => 1);
$mh->close; $imap->close;
-=item $obj-E<gt>B<delete>(OPTIONS)
+=item $obj-E<gt>B<delete>(%options)
Remove the specified folder file or folder directory (depending on
the type of folder) from disk. Of course, THIS IS DANGEROUS: you "may"
@@ -655,9 +655,9 @@ example: removing an closed folder
my $folder = Mail::Box::Mbox->new(folder => 'INBOX', access => 'd');
$folder->delete;
-=item $obj-E<gt>B<folderdir>([DIRECTORY])
+=item $obj-E<gt>B<folderdir>( [$directory] )
-Get or set the DIRECTORY which is used to store mail-folders by default.
+Get or set the $directory which is used to store mail-folders by default.
example:
@@ -691,7 +691,7 @@ same as the size when they are written.
Returns a name for the type of mail box. This can be C<mbox>, C<mh>,
C<maildir>, or C<pop3>.
-=item $obj-E<gt>B<update>(OPTIONS)
+=item $obj-E<gt>B<update>(%options)
Read new messages from the folder, which where received after opening
it. This is quite dangerous and shouldn't be possible: folders which
@@ -699,7 +699,7 @@ are open are locked. However, some applications do not use locks or the
wrong kind of locks. This method reads the changes (not always failsafe)
and incorporates them in the open folder administration.
-The OPTIONS are extra values which are passed to the
+The %options are extra values which are passed to the
L<updateMessages()|Mail::Box/"Internals"> method which is doing the actual work here.
=item $obj-E<gt>B<url>()
@@ -733,7 +733,7 @@ were added after the folder was read from file.
WARNING: this flag is not related to an external change to the folder
structure on disk. Have a look at L<update()|Mail::Box/"The folder"> for that.
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
Sets whether the folder is modified or not.
@@ -751,12 +751,12 @@ example:
=over 4
-=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
+=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
Some mail-readers keep the I<current> message, which represents the last
used message. This method returns [after setting] the current message.
-You may specify a NUMBER, to specify that that message number is to be
-selected as current, or a MESSAGE/MESSAGE-ID (as long as you are sure
+You may specify a $number, to specify that that message number is to be
+selected as current, or a $message/$message_id (as long as you are sure
that the header is already loaded, otherwise they are not recognized).
example:
@@ -764,19 +764,19 @@ example:
$folder->current(0);
$folder->current($message);
-=item $obj-E<gt>B<find>(MESSAGE-ID)
+=item $obj-E<gt>B<find>($message_id)
Like L<messageId()|Mail::Box/"The messages">, this method searches for a message with the
-MESSAGE-ID, returning the corresponding message object. However, C<find>
+$message_id, returning the corresponding message object. However, C<find>
will cause unparsed message in the folder to be parsed until the message-id
is found. The folder will be scanned back to front.
-=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
+=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
-Find the first message which has this LABEL with the correct setting. The
-BOOLEAN indicates whether any true value or any false value is to
-be found. By default, a true value is searched for. When a message
-does not have the requested label, it is taken as false.
+Find the first message which has this $label with the correct setting. The
+BOOLEAN indicates whether any true value or any false value is to be
+found in the ARRAY of $msgs. By default, a true value is searched for.
+When a message does not have the requested label, it is taken as false.
example: looking for a labeled message
@@ -787,7 +787,7 @@ example: looking for a labeled message
my $last = $folder->findFirstLabeled(seen => 0,
[ reverse $self->messages('ACTIVE') ] )
-=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
+=item $obj-E<gt>B<message>( $index, [$message] )
Get or set a message with on a certain index. Messages which are flagged
for deletion are counted. Negative indexes start at the end of the folder.
@@ -799,13 +799,13 @@ example:
$folder->message(3, $msg);
print $folder->message(-1); # last message.
-=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
+=item $obj-E<gt>B<messageId>( $message_id, [$message] )
With one argument, returns the message in the folder with the specified
-MESSAGE-ID. If a reference to a message object is passed as the optional
+$message_id. If a reference to a message object is passed as the optional
second argument, the message is first stored in the folder, replacing any
-existing message whose message ID is MESSAGE-ID. (The message ID of MESSAGE
-need not match MESSAGE-ID.)
+existing message whose message ID is $message_id. (The message ID of $message
+need not match $message_id.)
!!WARNING!!: when the message headers are delay-parsed, the message
might be in the folder but not yet parsed into memory. In this case, use
@@ -813,7 +813,7 @@ L<find()|Mail::Box/"The messages"> instead of C<messageId()> if you really need
This is especially the case for directory organized folders without
special indexi, like L<Mail::Box::MH|Mail::Box::MH>.
-The MESSAGE-ID may still be in angles, which will be stripped. In that
+The $message_id may still be in angles, which will be stripped. In that
case blanks (which origin from header line folding) are removed too. Other
info around the angles will be removed too.
@@ -838,7 +838,7 @@ example:
$folder->messageId($id)->print;
}
-=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
+=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
Returns multiple messages from the folder. The default is C<ALL>
which will return (as expected maybe) all the messages in the
@@ -847,7 +847,7 @@ deletion. This is the opposite of C<DELETED>, which returns all
messages from the folder which will be deleted when the folder is
closed.
-You may also specify a RANGE: two numbers specifying begin and end
+You may also specify a $range: two numbers specifying begin and end
index in the array of messages. Negative indexes count from the
end of the folder. When an index is out-of-range, the returned
list will be shorter without complaints.
@@ -856,7 +856,7 @@ Everything else than the predefined names is seen as labels. The messages
which have that label set will be returned. When the sequence starts
with an exclamation mark (!), the search result is reversed.
-For more complex searches, you can specify a FILTER, which is
+For more complex searches, you can specify a $filter, which is
simply a code reference. The message is passed as only argument.
example:
@@ -886,21 +886,21 @@ example:
$mgr->moveMessages($spam, $inbox->message('spam'));
$mgr->moveMessages($archive, $inbox->message('seen'));
-=item $obj-E<gt>B<nrMessages>(OPTIONS)
+=item $obj-E<gt>B<nrMessages>(%options)
Simply calls L<messages()|Mail::Box/"The messages"> in scalar context to return a count instead
of the messages itself. Some people seem to understand this better.
Note that nrMessages() will default to returning a count of
C<ALL> messages in the folder, including both C<ACTIVE> and C<DELETED>.
-The OPTIONS are passed to (and explained in) L<messages()|Mail::Box/"The messages">.
+The %options are passed to (and explained in) L<messages()|Mail::Box/"The messages">.
-=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
+=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
-You start with a MESSAGE, and are looking for a set of messages
+You start with a $message, and are looking for a set of messages
which are related to it. For instance, messages which appear in
the 'In-Reply-To' and 'Reference' header fields of that message.
-These messages are known by their MESSAGE-IDS and you want to find
+These messages are known by their $message_ids and you want to find
them in the folder.
When all message-ids are known, then looking-up messages is simple:
@@ -912,18 +912,18 @@ time and memory.
It is not smart to search for the messages from front to back in
the folder: the chances are much higher that related message
reside closely to each other. Therefore, this method starts
-scanning the folder from the specified MESSAGE, back to the front
+scanning the folder from the specified $message, back to the front
of the folder.
-The TIMESPAN can be used to terminate the search based on the time
+The $timespan can be used to terminate the search based on the time
enclosed in the message. When the constant string C<EVER> is used as
-TIMESPAN, then the search is not limited by that. When an integer
+$timespan, then the search is not limited by that. When an integer
is specified, it will be used as absolute time in time-ticks as
provided by your platform dependent C<time> function. In other cases,
it is passed to L<timespan2seconds()|Mail::Box/"Other methods"> to determine the threshold
as time relative to the message's time.
-The WINDOW is used to limit the search in number of messages to be
+The $window is used to limit the search in number of messages to be
scanned as integer or constant string C<ALL>.
Returned are the message-ids which were not found during the scan.
@@ -942,9 +942,9 @@ example: scanning through a folder for a message
=over 4
-=item $obj-E<gt>B<listSubFolders>(OPTIONS)
+=item $obj-E<gt>B<listSubFolders>(%options)
-=item Mail::Box-E<gt>B<listSubFolders>(OPTIONS)
+=item Mail::Box-E<gt>B<listSubFolders>(%options)
List the names of all sub-folders to this folder, not recursively
decending. Use these names as argument to L<openSubFolder()|Mail::Box/"Sub-folders">, to get
@@ -988,13 +988,13 @@ example:
my @subs = Mail::Box::Mbox->listSubFolders(folder => '=in/new');
my @subs = Mail::Box::Mbox->listSubFolders; # toplevel folders.
-=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
-=item Mail::Box-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
+=item Mail::Box-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
Returns the constructed name of the folder with NAME, which is a
sub-folder of this current one. You have either to call this method
-as instance method, or specify a PARENTNAME.
+as instance method, or specify a $parentname.
example: how to get the name of a subfolder
@@ -1007,14 +1007,14 @@ example: how to get the name of a subfolder
my $sub = Mail::Box::Mbox->nameOfSubfolder('xyz', undef);
print $sub; # xyz
-=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
+=item $obj-E<gt>B<openRelatedFolder>(%options)
Open a folder (usually a sub-folder) with the same options as this one.
If there is a folder manager in use, it will be informed about this new
-folder. OPTIONS overrule the options which where used for the folder
+folder. %options overrule the options which where used for the folder
this method is called upon.
-=item $obj-E<gt>B<openSubFolder>(SUBNAME, OPTIONS)
+=item $obj-E<gt>B<openSubFolder>($subname, %options)
Open (or create, if it does not exist yet) a new subfolder in an
existing folder.
@@ -1037,15 +1037,15 @@ can't.
=over 4
-=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<coerce>($message, %options)
-Coerce the MESSAGE to be of the correct type to be placed in the
+Coerce the $message to be of the correct type to be placed in the
folder. You can specify L<Mail::Internet|Mail::Internet> and MIME::Entity objects
here: they will be translated into Mail::Message messages first.
-=item $obj-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item $obj-E<gt>B<create>($foldername, %options)
-=item Mail::Box-E<gt>B<create>(FOLDERNAME, OPTIONS)
+=item Mail::Box-E<gt>B<create>($foldername, %options)
Create a folder. If the folder already exists, it will be left unchanged.
The folder is created, but not opened! If you want to open a file which
@@ -1064,21 +1064,21 @@ will be searched for the named folder.
=back
-=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
+=item $obj-E<gt>B<determineBodyType>($message, $head)
Determine which kind of body will be created for this message when
reading the folder initially.
-=item Mail::Box-E<gt>B<foundIn>([FOLDERNAME], OPTIONS)
+=item Mail::Box-E<gt>B<foundIn>( [$foldername], %options )
Determine if the specified folder is of the type handled by the
folder class. This method is extended by each folder sub-type.
-The FOLDERNAME specifies the name of the folder, as is specified by the
+The $foldername specifies the name of the folder, as is specified by the
application. You need to specified the C<folder> option when you skip
this first argument.
-OPTIONS is a list of extra information for the request. Read
+%options is a list of extra information for the request. Read
the documentation for each type of folder for type specific options, but
each folder class will at least support the C<folderdir> option:
@@ -1101,7 +1101,7 @@ example:
folderdir => "$ENV{HOME}/Mail");
Mail::Box::MH->foundIn(folder => '=markov');
-=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
+=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
Returns the character or characters used to separate lines in the folder
file, optionally after setting it to STRING, or one of the constants.
@@ -1119,9 +1119,9 @@ that may not be required.
Returns the locking object.
-=item $obj-E<gt>B<read>(OPTIONS)
+=item $obj-E<gt>B<read>(%options)
-Read messages from the folder into memory. The OPTIONS are folder
+Read messages from the folder into memory. The %options are folder
specific. Do not call C<read()> yourself: it will be called for you
when you open the folder via the manager or instantiate a folder
object directly.
@@ -1135,34 +1135,34 @@ example:
my $folder = $mgr->open('InBox'); # implies read
my $folder = Mail::Box::Mbox->new(folder => 'Inbox'); # same
-=item $obj-E<gt>B<readMessages>(OPTIONS)
+=item $obj-E<gt>B<readMessages>(%options)
Called by L<read()|Mail::Box/"Internals"> to actually read the messages from one specific
folder type. The L<read()|Mail::Box/"Internals"> organizes the general activities.
-The OPTIONS are C<trusted>, C<head_type>, C<field_type>,
+The %options are C<trusted>, C<head_type>, C<field_type>,
C<message_type>, C<body_delayed_type>, and C<head_delayed_type> as
defined by the folder at hand. The defaults are the constructor
defaults (see L<new()|Mail::Box/"Constructors">).
-=item $obj-E<gt>B<storeMessage>(MESSAGE)
+=item $obj-E<gt>B<storeMessage>($message)
Store the message in the folder without the checks as performed by
L<addMessage()|Mail::Box/"The folder">.
-=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeThreaded>($messages)
The specified message is ready to be removed from a thread.
This will be passed on to the mail-manager, which keeps an overview on
which thread-detection objects are floating around.
-=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
+=item $obj-E<gt>B<toBeUnthreaded>($messages)
The specified message is ready to be included in a thread.
This will be passed on to the mail-manager, which keeps an overview on
which thread-detection objects are floating around.
-=item $obj-E<gt>B<updateMessages>(OPTIONS)
+=item $obj-E<gt>B<updateMessages>(%options)
Called by L<update()|Mail::Box/"The folder"> to read messages which arrived in the folder
after it was opened. Sometimes, external applications dump messages
@@ -1175,7 +1175,7 @@ new messages arrive. These collisions are sparse.
The options are the same as for L<readMessages()|Mail::Box/"Internals">.
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
Write the data to disk. The folder (a C<true> value) is returned if
successful. Deleted messages are transformed into destroyed messages:
@@ -1208,7 +1208,7 @@ the folder may remove the messages for real. See L<close(save_deleted)|Mail::Bo
=back
-=item $obj-E<gt>B<writeMessages>(OPTIONS)
+=item $obj-E<gt>B<writeMessages>(%options)
Called by L<write()|Mail::Box/"Internals"> to actually write the messages from one specific
folder type. The C<write> organizes the general activities. All options
@@ -1233,11 +1233,11 @@ current folder.
=over 4
-=item $obj-E<gt>B<timespan2seconds>(TIME)
+=item $obj-E<gt>B<timespan2seconds>($time)
-=item Mail::Box-E<gt>B<timespan2seconds>(TIME)
+=item Mail::Box-E<gt>B<timespan2seconds>($time)
-TIME is a string, which starts with a float, and then one of the
+$time is a string, which starts with a float, and then one of the
words 'hour', 'hours', 'day', 'days', 'week', or 'weeks'. For instance:
'1 hour' or '4 weeks'.
@@ -1245,69 +1245,69 @@ words 'hour', 'hours', 'day', 'days', 'week', or 'weeks'. For instance:
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Box-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Box-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Box-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Box-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Box-E<gt>B<logPriority>(LEVEL)
+=item Mail::Box-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
@@ -1550,12 +1550,12 @@ were changes made.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -9,7 +9,7 @@ use warnings;
package Mail::Message::Body;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Carp;
@@ -18,9 +18,9 @@ compile this package.
=over 4
-=item $obj-E<gt>B<attach>(MESSAGES, OPTIONS)
+=item $obj-E<gt>B<attach>($messages, %options)
-Make a multipart containing this body and the specified MESSAGES. The
+Make a multipart containing this body and the specified $messages. The
options are passed to the constructor of the multi-part body. If you
need more control, create the multi-part body yourself. At least
take a look at L<Mail::Message::Body::Multipart|Mail::Message::Body::Multipart>.
@@ -43,11 +43,11 @@ example:
# Now create a new message
my $msg = Mail::Message->new(head => ..., body => $multi);
-=item $obj-E<gt>B<concatenate>(COMPONENTS)
+=item $obj-E<gt>B<concatenate>($components)
Concatenate a list of elements into one new body.
-Specify a list of text COMPONENTS. Each component can be
+Specify a list of text $components. Each component can be
a message (L<Mail::Message|Mail::Message>, the body of the message is used),
a plain body (L<Mail::Message::Body|Mail::Message::Body>),
C<undef> (which will be skipped),
@@ -83,7 +83,7 @@ example:
my $right = $content->foreachLine(
sub {(my $x=$_) =~ s/a/A/; $x} );
-=item $obj-E<gt>B<stripSignature>(OPTIONS)
+=item $obj-E<gt>B<stripSignature>(%options)
Strip the signature from the body. The body must already be decoded
otherwise the wrong lines may get stripped. Returned is the stripped
@@ -141,12 +141,12 @@ example:
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Body::Delayed;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -21,13 +21,13 @@ Message bodies of this type will be replaced by another type the moment you
access the content. In this documentation you will find the description of
how a message body gets delay loaded.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 OVERLOADED
=over 4
-=item overload: B<"">()
+=item overload: B<"">
(stringification) Returns the body as string --which will trigger
completion-- unless called to produce a string for C<Carp>. The latter
@@ -40,12 +40,12 @@ example: stringification of delayed body
my $body = $msg->body;
my $x = "$body"; # explicit by interpolation
-=item overload: B<@{}>()
+=item overload: B<@{}>
When a body object is used as being an array reference, the lines of
the body are returned. This is the same as using the C<lines> method.
-=item overload: B<bool>()
+=item overload: B<bool>
Always returns a true value, which is needed to have overloaded
objects to be used as in C<if($body)>. Otherwise, C<if(defined $body)>
@@ -55,15 +55,15 @@ would be needed to avoid a runtime error.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Message::Body::Delayed-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Body::Delayed-E<gt>B<new>(%options)
-Option --Defined in --Default
log Mail::Reporter 'WARNINGS'
@@ -114,89 +114,89 @@ The MESSAGE object which contains this delayed body.
=over 4
-=item $obj-E<gt>B<fileLocation>([BEGIN, END])
+=item $obj-E<gt>B<fileLocation>( [$begin, $end] )
=item $obj-E<gt>B<load>()
Returns the loaded version of this body.
-=item $obj-E<gt>B<moveLocation>(DISTANCE)
+=item $obj-E<gt>B<moveLocation>($distance)
-=item $obj-E<gt>B<read>(PARSER, HEAD, BODYTYPE)
+=item $obj-E<gt>B<read>($parser, $head, $bodytype)
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Body::Delayed-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Body::Delayed-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Body::Delayed-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Body::Delayed-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Body::Delayed-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Body::Delayed-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -216,12 +216,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::Body;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -219,15 +219,17 @@ sub dispositionFilename(;$)
my $field;
if($field = $self->disposition)
- { $raw = $field->attribute('filename')
- || $field->attribute('file')
- || $field->attribute('name');
+ { $field = $field->study if $field->can('study');
+ $raw = $field->attribute('filename')
+ || $field->attribute('file')
+ || $field->attribute('name');
}
if(!defined $raw && ($field = $self->type))
- { $raw = $field->attribute('filename')
- || $field->attribute('file')
- || $field->attribute('name');
+ { $field = $field->study if $field->can('study');
+ $raw = $field->attribute('filename')
+ || $field->attribute('file')
+ || $field->attribute('name');
}
my $base;
@@ -292,8 +294,6 @@ sub getTransferEncHandler($)
$transfer_encoders{$type} = $class->new;
}
-#------------------------------------------
-
sub addTransferEncHandler($$)
{ my ($this, $name, $what) = @_;
@@ -66,7 +66,7 @@ method is called upon, but also a new object, when serious changes had
to be made. If the check could not be made, because the decoder is not
defined, then C<undef> is returned.
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
Encode (translate) a L<Mail::Message::Body|Mail::Message::Body> into a different format.
See the DESCRIPTION above. Options which are not specified will not trigger
@@ -111,11 +111,11 @@ a folder file. This returns the body where this method was called
upon when everything was already prepared, or a new encoded body
otherwise. In either case, the body is checked.
-=item $obj-E<gt>B<unify>(BODY)
+=item $obj-E<gt>B<unify>($body)
-Unify the type of the given BODY objects with the type of the called
+Unify the type of the given $body objects with the type of the called
body. C<undef> is returned when unification is impossible. If the
-bodies have the same settings, the BODY object is returned unchanged.
+bodies have the same settings, the $body object is returned unchanged.
Examples:
@@ -132,11 +132,11 @@ Examples:
=over 4
-=item $obj-E<gt>B<dispositionFilename>([DIRECTORY])
+=item $obj-E<gt>B<dispositionFilename>( [$directory] )
Returns the name which can be used as filename to store the information
-in the indicated DIRECTORY. To get a filename, various fields are searched
-for C<filename> and C<name> attributes. Without DIRECTORY, the name found
+in the indicated $directory. To get a filename, various fields are searched
+for C<filename> and C<name> attributes. Without $directory, the name found
will be returned.
Only the basename of the found name will be used, for security reasons:
@@ -160,22 +160,22 @@ text.
=over 4
-=item $obj-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item $obj-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-=item Mail::Message::Body-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item Mail::Message::Body-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
Relate the NAMEd transfer encoding to an OBJECTs or object of the specified
-CLASS. In the latter case, an object of that CLASS will be created on the
+$class. In the latter case, an object of that $class will be created on the
moment that one is needed to do encoding or decoding.
-The CLASS or OBJECT must extend L<Mail::Message::TransferEnc|Mail::Message::TransferEnc>. It will
-replace existing class and object for this NAME.
+The $class or $object must extend L<Mail::Message::TransferEnc|Mail::Message::TransferEnc>. It will
+replace existing class and object for this $name.
Why aren't you contributing this class to MailBox?
-=item $obj-E<gt>B<getTransferEncHandler>(TYPE)
+=item $obj-E<gt>B<getTransferEncHandler>($type)
-Get the transfer encoder/decoder which is able to handle TYPE, or return
+Get the transfer encoder/decoder which is able to handle $type, or return
undef if there is no such handler.
=back
@@ -203,12 +203,12 @@ unknown. The decoded data is returned.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Body::File;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Body';
@@ -25,14 +25,14 @@ sub _data_from_filename(@)
local $_;
local (*IN, *OUT);
- unless(open IN, '<', $filename)
+ unless(open IN, '<:raw', $filename)
{ $self->log(ERROR =>
"Unable to read file $filename for message body file: $!");
return;
}
my $file = $self->tempFilename;
- unless(open OUT, '>', $file)
+ unless(open OUT, '>:raw', $file)
{ $self->log(ERROR => "Cannot write to temporary body file $file: $!");
return;
}
@@ -54,7 +54,7 @@ sub _data_from_filehandle(@)
local *OUT;
- unless(open OUT, '>', $file)
+ unless(open OUT, '>:raw', $file)
{ $self->log(ERROR => "Cannot write to temporary body file $file: $!");
return;
}
@@ -77,7 +77,7 @@ sub _data_from_glob(@)
local $_;
local *OUT;
- unless(open OUT, '>', $file)
+ unless(open OUT, '>:raw', $file)
{ $self->log(ERROR => "Cannot write to temporary body file $file: $!");
return;
}
@@ -98,7 +98,7 @@ sub _data_from_lines(@)
local *OUT;
- unless(open OUT, '>', $file)
+ unless(open OUT, '>:raw', $file)
{ $self->log(ERROR => "Cannot write to $file: $!");
return;
}
@@ -134,7 +134,7 @@ sub nrLines()
local $_;
local *IN;
- open IN, '<', $file
+ open IN, '<:raw', $file
or die "Cannot read from $file: $!\n";
$nrlines++ while <IN>;
@@ -166,7 +166,7 @@ sub string()
local *IN;
- open IN, '<', $file
+ open IN, '<:raw', $file
or die "Cannot read from $file: $!\n";
my $return = join '', <IN>;
@@ -181,7 +181,7 @@ sub lines()
my $file = $self->tempFilename;
local *IN;
- open IN, '<', $file
+ open IN, '<:raw', $file
or die "Cannot read from $file: $!\n";
my @r = <IN>;
@@ -192,7 +192,7 @@ sub lines()
}
sub file()
-{ open my $tmp, '<', shift->tempFilename;
+{ open my $tmp, '<:raw', shift->tempFilename;
$tmp;
}
@@ -204,7 +204,7 @@ sub print(;$)
local $_;
local *IN;
- open IN, '<', $file
+ open IN, '<:raw', $file
or croak "Cannot read from $file: $!\n";
if(ref $fh eq 'GLOB') {print $fh $_ while <IN>}
@@ -220,7 +220,7 @@ sub read($$;$@)
local *OUT;
- open OUT, '>', $file
+ open OUT, '>:raw', $file
or die "Cannot write to $file: $!.\n";
(my $begin, my $end, $self->{MMBF_nrlines}) = $parser->bodyAsFile(\*OUT,@_);
@@ -23,47 +23,47 @@ when a message is stored in a file.
Storing a whole message is a file is useful when the body is large. Although
access through a file is slower, it is saving a lot of memory.
-See L<documentation in the base class|Mail::Message::Body/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Body|Mail::Message::Body/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Body/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Body|Mail::Message::Body/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<'==' and '!='>()
+=item overload: B<'==' and '!='>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Body/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Body|Mail::Message::Body/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Body/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Body|Mail::Message::Body/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Body/"Constructors">
+Inherited, see L<Mail::Message::Body/"Constructors">
-=item Mail::Message::Body::File-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Body::File-E<gt>B<new>(%options)
-Option --Defined in --Default
based_on Mail::Message::Body undef
@@ -120,229 +120,229 @@ See L<Mail::Message::Body/"Constructors">
=head2 Constructing a body
-See L<documentation in the base class|Mail::Message::Body/"Constructing a body">.
+Extends L<"Constructing a body" in Mail::Message::Body|Mail::Message::Body/"Constructing a body">.
=over 4
-=item $obj-E<gt>B<attach>(MESSAGES, OPTIONS)
+=item $obj-E<gt>B<attach>($messages, %options)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
=item $obj-E<gt>B<check>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<concatenate>(COMPONENTS)
+=item $obj-E<gt>B<concatenate>($components)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message::Body/"Constructing a body">
+Inherited, see L<Mail::Message::Body/"Constructing a body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=item $obj-E<gt>B<encoded>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<eol>(['CR'|'LF'|'CRLF'|'NATIVE'])
+=item $obj-E<gt>B<eol>( ['CR'|'LF'|'CRLF'|'NATIVE'] )
-See L<Mail::Message::Body/"Constructing a body">
+Inherited, see L<Mail::Message::Body/"Constructing a body">
=item $obj-E<gt>B<foreachLine>(CODE)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<stripSignature>(OPTIONS)
+=item $obj-E<gt>B<stripSignature>(%options)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<unify>(BODY)
+=item $obj-E<gt>B<unify>($body)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=back
=head2 The body
-See L<documentation in the base class|Mail::Message::Body/"The body">.
+Extends L<"The body" in Mail::Message::Body|Mail::Message::Body/"The body">.
=over 4
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
-=item $obj-E<gt>B<partNumberOf>(PART)
+=item $obj-E<gt>B<partNumberOf>($part)
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=back
=head2 About the payload
-See L<documentation in the base class|Mail::Message::Body/"About the payload">.
+Extends L<"About the payload" in Mail::Message::Body|Mail::Message::Body/"About the payload">.
=over 4
=item $obj-E<gt>B<charset>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<checked>([BOOLEAN])
+=item $obj-E<gt>B<checked>( [BOOLEAN] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<contentId>([STRING|FIELD])
+=item $obj-E<gt>B<contentId>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<description>([STRING|FIELD])
+=item $obj-E<gt>B<description>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<disposition>([STRING|FIELD])
+=item $obj-E<gt>B<disposition>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<dispositionFilename>([DIRECTORY])
+=item $obj-E<gt>B<dispositionFilename>( [$directory] )
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isBinary>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isText>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<mimeType>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<transferEncoding>([STRING|FIELD])
+=item $obj-E<gt>B<transferEncoding>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<type>([STRING|FIELD])
+=item $obj-E<gt>B<type>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=back
=head2 Access to the payload
-See L<documentation in the base class|Mail::Message::Body/"Access to the payload">.
+Extends L<"Access to the payload" in Mail::Message::Body|Mail::Message::Body/"Access to the payload">.
=over 4
=item $obj-E<gt>B<endsOnNewline>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<printEscapedFrom>(FILEHANDLE)
+=item $obj-E<gt>B<printEscapedFrom>($fh)
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<stripTrailingNewline>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Body/"Internals">.
+Extends L<"Internals" in Mail::Message::Body|Mail::Message::Body/"Internals">.
=over 4
-=item $obj-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item $obj-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-=item Mail::Message::Body::File-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item Mail::Message::Body::File-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
-=item $obj-E<gt>B<contentInfoFrom>(HEAD)
+=item $obj-E<gt>B<contentInfoFrom>($head)
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<contentInfoTo>(HEAD)
+=item $obj-E<gt>B<contentInfoTo>($head)
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<fileLocation>([BEGIN,END])
+=item $obj-E<gt>B<fileLocation>( [$begin, $end] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<getTransferEncHandler>(TYPE)
+=item $obj-E<gt>B<getTransferEncHandler>($type)
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
=item $obj-E<gt>B<load>()
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<moveLocation>([DISTANCE])
+=item $obj-E<gt>B<moveLocation>( [$distance] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<read>(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])
+=item $obj-E<gt>B<read>( $parser, $head, $bodytype, [$chars, [$lines]] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<tempFilename>([FILENAME])
+=item $obj-E<gt>B<tempFilename>( [$filename] )
Returns the name of the temporary file which is used to store this body.
@@ -350,69 +350,69 @@ Returns the name of the temporary file which is used to store this body.
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Body/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Body|Mail::Message::Body/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Body/"Error handling">
+Inherited, see L<Mail::Message::Body/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Body::File-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Body::File-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Body::File-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Body::File-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Body::File-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Body::File-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Body/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Body|Mail::Message::Body/"Cleanup">.
=over 4
@@ -425,7 +425,7 @@ not required anymore.
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Body/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Body|Mail::Message::Body/"DETAILS">.
=head1 DIAGNOSTICS
@@ -471,12 +471,12 @@ no copy to a temporary file can be made.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Body::Lines;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Body';
@@ -24,47 +24,47 @@ Storing a whole message as an array of lines is useful when the data is not
encoded, and you want to process it on a line-by-line basis (a common practice
for inspecting message bodies).
-See L<documentation in the base class|Mail::Message::Body/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Body|Mail::Message::Body/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Body/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Body|Mail::Message::Body/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<'==' and '!='>()
+=item overload: B<'==' and '!='>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Body/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Body|Mail::Message::Body/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Body/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Body|Mail::Message::Body/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Body/"Constructors">
+Inherited, see L<Mail::Message::Body/"Constructors">
-=item Mail::Message::Body::Lines-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Body::Lines-E<gt>B<new>(%options)
-Option --Defined in --Default
based_on Mail::Message::Body undef
@@ -121,307 +121,307 @@ See L<Mail::Message::Body/"Constructors">
=head2 Constructing a body
-See L<documentation in the base class|Mail::Message::Body/"Constructing a body">.
+Extends L<"Constructing a body" in Mail::Message::Body|Mail::Message::Body/"Constructing a body">.
=over 4
-=item $obj-E<gt>B<attach>(MESSAGES, OPTIONS)
+=item $obj-E<gt>B<attach>($messages, %options)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
=item $obj-E<gt>B<check>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<concatenate>(COMPONENTS)
+=item $obj-E<gt>B<concatenate>($components)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message::Body/"Constructing a body">
+Inherited, see L<Mail::Message::Body/"Constructing a body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=item $obj-E<gt>B<encoded>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<eol>(['CR'|'LF'|'CRLF'|'NATIVE'])
+=item $obj-E<gt>B<eol>( ['CR'|'LF'|'CRLF'|'NATIVE'] )
-See L<Mail::Message::Body/"Constructing a body">
+Inherited, see L<Mail::Message::Body/"Constructing a body">
=item $obj-E<gt>B<foreachLine>(CODE)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<stripSignature>(OPTIONS)
+=item $obj-E<gt>B<stripSignature>(%options)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<unify>(BODY)
+=item $obj-E<gt>B<unify>($body)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=back
=head2 The body
-See L<documentation in the base class|Mail::Message::Body/"The body">.
+Extends L<"The body" in Mail::Message::Body|Mail::Message::Body/"The body">.
=over 4
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
-=item $obj-E<gt>B<partNumberOf>(PART)
+=item $obj-E<gt>B<partNumberOf>($part)
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=back
=head2 About the payload
-See L<documentation in the base class|Mail::Message::Body/"About the payload">.
+Extends L<"About the payload" in Mail::Message::Body|Mail::Message::Body/"About the payload">.
=over 4
=item $obj-E<gt>B<charset>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<checked>([BOOLEAN])
+=item $obj-E<gt>B<checked>( [BOOLEAN] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<contentId>([STRING|FIELD])
+=item $obj-E<gt>B<contentId>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<description>([STRING|FIELD])
+=item $obj-E<gt>B<description>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<disposition>([STRING|FIELD])
+=item $obj-E<gt>B<disposition>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<dispositionFilename>([DIRECTORY])
+=item $obj-E<gt>B<dispositionFilename>( [$directory] )
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isBinary>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isText>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<mimeType>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<transferEncoding>([STRING|FIELD])
+=item $obj-E<gt>B<transferEncoding>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<type>([STRING|FIELD])
+=item $obj-E<gt>B<type>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=back
=head2 Access to the payload
-See L<documentation in the base class|Mail::Message::Body/"Access to the payload">.
+Extends L<"Access to the payload" in Mail::Message::Body|Mail::Message::Body/"Access to the payload">.
=over 4
=item $obj-E<gt>B<endsOnNewline>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<printEscapedFrom>(FILEHANDLE)
+=item $obj-E<gt>B<printEscapedFrom>($fh)
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<stripTrailingNewline>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Body/"Internals">.
+Extends L<"Internals" in Mail::Message::Body|Mail::Message::Body/"Internals">.
=over 4
-=item $obj-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item $obj-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-=item Mail::Message::Body::Lines-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item Mail::Message::Body::Lines-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
-=item $obj-E<gt>B<contentInfoFrom>(HEAD)
+=item $obj-E<gt>B<contentInfoFrom>($head)
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<contentInfoTo>(HEAD)
+=item $obj-E<gt>B<contentInfoTo>($head)
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<fileLocation>([BEGIN,END])
+=item $obj-E<gt>B<fileLocation>( [$begin, $end] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<getTransferEncHandler>(TYPE)
+=item $obj-E<gt>B<getTransferEncHandler>($type)
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
=item $obj-E<gt>B<load>()
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<moveLocation>([DISTANCE])
+=item $obj-E<gt>B<moveLocation>( [$distance] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<read>(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])
+=item $obj-E<gt>B<read>( $parser, $head, $bodytype, [$chars, [$lines]] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Body/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Body|Mail::Message::Body/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Body/"Error handling">
+Inherited, see L<Mail::Message::Body/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Body::Lines-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Body::Lines-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Body::Lines-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Body::Lines-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Body::Lines-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Body::Lines-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Body/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Body|Mail::Message::Body/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Body/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Body|Mail::Message::Body/"DETAILS">.
=head1 DIAGNOSTICS
@@ -461,12 +461,12 @@ but it is impossible to read that file to retrieve the lines within.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Body::Multipart;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Body';
@@ -231,14 +231,18 @@ sub encoded()
sub read($$$$)
{ my ($self, $parser, $head, $bodytype) = @_;
- my $boundary = $self->boundary;
+ my $boundary = $self->boundary;
$parser->pushSeparator("--$boundary");
- my @msgopts = ($self->logSettings);
+ my @msgopts = ($self->logSettings);
+ my $te;
+ $te = lc $1
+ if +($head->get('Content-Transfer-Encoding') || '') =~ m/(\w+)/;
+
my @sloppyopts =
( mime_type => 'text/plain'
- , transfer_encoding => ($head->get('Content-Transfer-Encoding') || undef)
+ , transfer_encoding => $te
);
# Get preamble.
@@ -28,47 +28,47 @@ The body (content) of a message can be stored in various ways. In this
manual-page you find the description of extra functionality you have
when a message contains attachments (parts).
-See L<documentation in the base class|Mail::Message::Body/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Body|Mail::Message::Body/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Body/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Body|Mail::Message::Body/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<'==' and '!='>()
+=item overload: B<'==' and '!='>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Body/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Body|Mail::Message::Body/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Body/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Body|Mail::Message::Body/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Body/"Constructors">
+Inherited, see L<Mail::Message::Body/"Constructors">
-=item Mail::Message::Body::Multipart-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Body::Multipart-E<gt>B<new>(%options)
-Option --Defined in --Default
based_on Mail::Message::Body undef
@@ -174,41 +174,41 @@ example:
=head2 Constructing a body
-See L<documentation in the base class|Mail::Message::Body/"Constructing a body">.
+Extends L<"Constructing a body" in Mail::Message::Body|Mail::Message::Body/"Constructing a body">.
=over 4
-=item $obj-E<gt>B<attach>(MESSAGES|BODIES)
+=item $obj-E<gt>B<attach>($messages|$bodies)
-Attach a list of MESSAGES to this multipart. A new body is returned.
-When you specify BODIES, they will first be translated into
+Attach a list of $messages to this multipart. A new body is returned.
+When you specify $bodies, they will first be translated into
real messages. MIME::Entity and L<Mail::Internet|Mail::Internet> objects may be
specified too. In any case, the parts will be coerced into
L<Mail::Message::Part|Mail::Message::Part>'s.
=item $obj-E<gt>B<check>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<concatenate>(COMPONENTS)
+=item $obj-E<gt>B<concatenate>($components)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message::Body/"Constructing a body">
+Inherited, see L<Mail::Message::Body/"Constructing a body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=item $obj-E<gt>B<encoded>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<eol>(['CR'|'LF'|'CRLF'|'NATIVE'])
+=item $obj-E<gt>B<eol>( ['CR'|'LF'|'CRLF'|'NATIVE'] )
-See L<Mail::Message::Body/"Constructing a body">
+Inherited, see L<Mail::Message::Body/"Constructing a body">
=item $obj-E<gt>B<foreachComponent>(CODE)
@@ -232,11 +232,11 @@ It is NOT possible to call some code for each line of a multipart,
because that would not only inflict damage to the body of each
message part, but also to the headers and the part separators.
-=item $obj-E<gt>B<stripSignature>(OPTIONS)
+=item $obj-E<gt>B<stripSignature>(%options)
Removes all parts which contains data usually defined as being signature.
The L<MIME::Type|MIME::Type> module provides this knowledge. A new multipart is
-returned, containing the remaining parts. No OPTIONS are defined yet,
+returned, containing the remaining parts. No %options are defined yet,
although some may be specified, because this method overrules the
C<stripSignature> method for normal bodies.
@@ -255,107 +255,107 @@ C<stripSignature> method for normal bodies.
=back
-=item $obj-E<gt>B<unify>(BODY)
+=item $obj-E<gt>B<unify>($body)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=back
=head2 The body
-See L<documentation in the base class|Mail::Message::Body/"The body">.
+Extends L<"The body" in Mail::Message::Body|Mail::Message::Body/"The body">.
=over 4
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
-=item $obj-E<gt>B<partNumberOf>(PART)
+=item $obj-E<gt>B<partNumberOf>($part)
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=back
=head2 About the payload
-See L<documentation in the base class|Mail::Message::Body/"About the payload">.
+Extends L<"About the payload" in Mail::Message::Body|Mail::Message::Body/"About the payload">.
=over 4
=item $obj-E<gt>B<charset>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<checked>([BOOLEAN])
+=item $obj-E<gt>B<checked>( [BOOLEAN] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<contentId>([STRING|FIELD])
+=item $obj-E<gt>B<contentId>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<description>([STRING|FIELD])
+=item $obj-E<gt>B<description>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<disposition>([STRING|FIELD])
+=item $obj-E<gt>B<disposition>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<dispositionFilename>([DIRECTORY])
+=item $obj-E<gt>B<dispositionFilename>( [$directory] )
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isBinary>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isText>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<mimeType>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<transferEncoding>([STRING|FIELD])
+=item $obj-E<gt>B<transferEncoding>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<type>([STRING|FIELD])
+=item $obj-E<gt>B<type>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=back
=head2 Access to the payload
-See L<documentation in the base class|Mail::Message::Body/"Access to the payload">.
+Extends L<"Access to the payload" in Mail::Message::Body|Mail::Message::Body/"Access to the payload">.
=over 4
-=item $obj-E<gt>B<boundary>([STRING])
+=item $obj-E<gt>B<boundary>( [STRING] )
Returns the boundary which is used to separate the parts in this
body. If none was read from file, then one will be assigned. With
@@ -363,7 +363,7 @@ STRING you explicitly set the boundary to be used.
=item $obj-E<gt>B<endsOnNewline>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<epilogue>()
@@ -374,15 +374,15 @@ from the general multipart header.
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<part>(INDEX)
+=item $obj-E<gt>B<part>($index)
-Returns only the part with the specified INDEX. You may use a negative
+Returns only the part with the specified $index. You may use a negative
value here, which counts from the back in the list. Parts which are
flagged to be deleted are included in the count.
@@ -391,7 +391,7 @@ example:
$message->body->part(2)->print;
$body->part(1)->delete;
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
Return all parts by default, or when ALL is specified. C<ACTIVE> returns
the parts which are not flagged for deletion, as opposite to C<DELETED>.
@@ -417,155 +417,155 @@ first real attachment).
The preamble is stored in a BODY object, and its encoding is taken
from the multipart header.
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<printEscapedFrom>(FILEHANDLE)
+=item $obj-E<gt>B<printEscapedFrom>($fh)
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<stripTrailingNewline>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Body/"Internals">.
+Extends L<"Internals" in Mail::Message::Body|Mail::Message::Body/"Internals">.
=over 4
-=item $obj-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item $obj-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-=item Mail::Message::Body::Multipart-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item Mail::Message::Body::Multipart-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
-=item $obj-E<gt>B<contentInfoFrom>(HEAD)
+=item $obj-E<gt>B<contentInfoFrom>($head)
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<contentInfoTo>(HEAD)
+=item $obj-E<gt>B<contentInfoTo>($head)
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<fileLocation>([BEGIN,END])
+=item $obj-E<gt>B<fileLocation>( [$begin, $end] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<getTransferEncHandler>(TYPE)
+=item $obj-E<gt>B<getTransferEncHandler>($type)
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
=item $obj-E<gt>B<load>()
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<moveLocation>([DISTANCE])
+=item $obj-E<gt>B<moveLocation>( [$distance] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<read>(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])
+=item $obj-E<gt>B<read>( $parser, $head, $bodytype, [$chars, [$lines]] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Body/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Body|Mail::Message::Body/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Body/"Error handling">
+Inherited, see L<Mail::Message::Body/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Body::Multipart-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Body::Multipart-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Body::Multipart-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Body::Multipart-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Body::Multipart-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Body::Multipart-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Body/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Body|Mail::Message::Body/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Body/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Body|Mail::Message::Body/"DETAILS">.
=head1 DIAGNOSTICS
@@ -616,12 +616,12 @@ clearly not acceptible.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Body::Nested;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Body';
@@ -31,47 +31,47 @@ header fields defined by the RFC882, where a part of a multipart has
only a few. But because we do not keep track whether all fields are
presented, a C<Mail::Message::Part> is used anyway.
-See L<documentation in the base class|Mail::Message::Body/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Body|Mail::Message::Body/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Body/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Body|Mail::Message::Body/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<'==' and '!='>()
+=item overload: B<'==' and '!='>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Body/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Body|Mail::Message::Body/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Body/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Body|Mail::Message::Body/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Body/"Constructors">
+Inherited, see L<Mail::Message::Body/"Constructors">
-=item Mail::Message::Body::Nested-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Body::Nested-E<gt>B<new>(%options)
-Option --Defined in --Default
based_on Mail::Message::Body undef
@@ -143,154 +143,154 @@ example:
=head2 Constructing a body
-See L<documentation in the base class|Mail::Message::Body/"Constructing a body">.
+Extends L<"Constructing a body" in Mail::Message::Body|Mail::Message::Body/"Constructing a body">.
=over 4
-=item $obj-E<gt>B<attach>(MESSAGES, OPTIONS)
+=item $obj-E<gt>B<attach>($messages, %options)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
=item $obj-E<gt>B<check>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<concatenate>(COMPONENTS)
+=item $obj-E<gt>B<concatenate>($components)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message::Body/"Constructing a body">
+Inherited, see L<Mail::Message::Body/"Constructing a body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=item $obj-E<gt>B<encoded>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<eol>(['CR'|'LF'|'CRLF'|'NATIVE'])
+=item $obj-E<gt>B<eol>( ['CR'|'LF'|'CRLF'|'NATIVE'] )
-See L<Mail::Message::Body/"Constructing a body">
+Inherited, see L<Mail::Message::Body/"Constructing a body">
=item $obj-E<gt>B<foreachLine>((CODE))
It is NOT possible to call some code for each line of a nested
because that would damage the header of the encapsulated message
-=item $obj-E<gt>B<stripSignature>(OPTIONS)
+=item $obj-E<gt>B<stripSignature>(%options)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<unify>(BODY)
+=item $obj-E<gt>B<unify>($body)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=back
=head2 The body
-See L<documentation in the base class|Mail::Message::Body/"The body">.
+Extends L<"The body" in Mail::Message::Body|Mail::Message::Body/"The body">.
=over 4
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
-=item $obj-E<gt>B<partNumberOf>(PART)
+=item $obj-E<gt>B<partNumberOf>($part)
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=back
=head2 About the payload
-See L<documentation in the base class|Mail::Message::Body/"About the payload">.
+Extends L<"About the payload" in Mail::Message::Body|Mail::Message::Body/"About the payload">.
=over 4
=item $obj-E<gt>B<charset>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<checked>([BOOLEAN])
+=item $obj-E<gt>B<checked>( [BOOLEAN] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<contentId>([STRING|FIELD])
+=item $obj-E<gt>B<contentId>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<description>([STRING|FIELD])
+=item $obj-E<gt>B<description>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<disposition>([STRING|FIELD])
+=item $obj-E<gt>B<disposition>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<dispositionFilename>([DIRECTORY])
+=item $obj-E<gt>B<dispositionFilename>( [$directory] )
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isBinary>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isText>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<mimeType>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<transferEncoding>([STRING|FIELD])
+=item $obj-E<gt>B<transferEncoding>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<type>([STRING|FIELD])
+=item $obj-E<gt>B<type>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=back
=head2 Access to the payload
-See L<documentation in the base class|Mail::Message::Body/"Access to the payload">.
+Extends L<"Access to the payload" in Mail::Message::Body|Mail::Message::Body/"Access to the payload">.
=over 4
=item $obj-E<gt>B<endsOnNewline>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<forNested>(CODE)
@@ -299,162 +299,162 @@ nested body object. Returns C<undef> when the CODE returns C<undef>.
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<nested>()
Returns the L<Mail::Message::Part|Mail::Message::Part> message which is enclosed within
this body.
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<printEscapedFrom>(FILEHANDLE)
+=item $obj-E<gt>B<printEscapedFrom>($fh)
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<stripTrailingNewline>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Body/"Internals">.
+Extends L<"Internals" in Mail::Message::Body|Mail::Message::Body/"Internals">.
=over 4
-=item $obj-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item $obj-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-=item Mail::Message::Body::Nested-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item Mail::Message::Body::Nested-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
-=item $obj-E<gt>B<contentInfoFrom>(HEAD)
+=item $obj-E<gt>B<contentInfoFrom>($head)
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<contentInfoTo>(HEAD)
+=item $obj-E<gt>B<contentInfoTo>($head)
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<fileLocation>([BEGIN,END])
+=item $obj-E<gt>B<fileLocation>( [$begin, $end] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<getTransferEncHandler>(TYPE)
+=item $obj-E<gt>B<getTransferEncHandler>($type)
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
=item $obj-E<gt>B<load>()
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<moveLocation>([DISTANCE])
+=item $obj-E<gt>B<moveLocation>( [$distance] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<read>(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])
+=item $obj-E<gt>B<read>( $parser, $head, $bodytype, [$chars, [$lines]] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Body/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Body|Mail::Message::Body/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Body/"Error handling">
+Inherited, see L<Mail::Message::Body/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Body::Nested-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Body::Nested-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Body::Nested-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Body::Nested-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Body::Nested-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Body::Nested-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Body/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Body|Mail::Message::Body/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Body/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Body|Mail::Message::Body/"DETAILS">.
=head1 DIAGNOSTICS
@@ -495,12 +495,12 @@ clearly not acceptible.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Body::String;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Body';
@@ -69,15 +69,11 @@ sub _data_from_lines(@)
$self;
}
-#------------------------------------------
-
sub clone()
{ my $self = shift;
ref($self)->new(data => $self->string, based_on => $self);
}
-#------------------------------------------
-
sub nrLines()
{ my $self = shift;
return $self->{MMBS_nrlines} if defined $self->{MMBS_nrlines};
@@ -87,26 +83,16 @@ sub nrLines()
$self->{MMBS_nrlines} = $lines;
}
-#------------------------------------------
-
sub size() { length shift->{MMBS_scalar} }
-#------------------------------------------
-
sub string() { shift->{MMBS_scalar} }
-#------------------------------------------
-
sub lines()
{ my @lines = split /^/, shift->{MMBS_scalar};
wantarray ? @lines : \@lines;
}
-#------------------------------------------
-
-sub file() { Mail::Box::FastScalar->new(shift->{MMBS_scalar}) }
-
-#------------------------------------------
+sub file() { Mail::Box::FastScalar->new(\shift->{MMBS_scalar}) }
sub print(;$)
{ my $self = shift;
@@ -116,8 +102,6 @@ sub print(;$)
$self;
}
-#------------------------------------------
-
sub read($$;$@)
{ my ($self, $parser, $head, $bodytype) = splice @_, 0, 4;
delete $self->{MMBS_nrlines};
@@ -128,10 +112,6 @@ sub read($$;$@)
$self;
}
-#------------------------------------------
-
sub endsOnNewline() { shift->{MMBS_scalar} =~ m/\A\z|\n\z/ }
-#------------------------------------------
-
1;
@@ -25,47 +25,47 @@ is small or encoded. Even when stored as a scalar, you can still treat the
body as if the data is stored in lines or an external file, but this will be
slower.
-See L<documentation in the base class|Mail::Message::Body/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Body|Mail::Message::Body/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Body/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Body|Mail::Message::Body/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<'==' and '!='>()
+=item overload: B<'==' and '!='>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Body/"OVERLOADED">
+Inherited, see L<Mail::Message::Body/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Body/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Body|Mail::Message::Body/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Body/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Body|Mail::Message::Body/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Body/"Constructors">
+Inherited, see L<Mail::Message::Body/"Constructors">
-=item Mail::Message::Body::String-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Body::String-E<gt>B<new>(%options)
-Option --Defined in --Default
based_on Mail::Message::Body undef
@@ -122,307 +122,307 @@ See L<Mail::Message::Body/"Constructors">
=head2 Constructing a body
-See L<documentation in the base class|Mail::Message::Body/"Constructing a body">.
+Extends L<"Constructing a body" in Mail::Message::Body|Mail::Message::Body/"Constructing a body">.
=over 4
-=item $obj-E<gt>B<attach>(MESSAGES, OPTIONS)
+=item $obj-E<gt>B<attach>($messages, %options)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
=item $obj-E<gt>B<check>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<concatenate>(COMPONENTS)
+=item $obj-E<gt>B<concatenate>($components)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message::Body/"Constructing a body">
+Inherited, see L<Mail::Message::Body/"Constructing a body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=item $obj-E<gt>B<encoded>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<eol>(['CR'|'LF'|'CRLF'|'NATIVE'])
+=item $obj-E<gt>B<eol>( ['CR'|'LF'|'CRLF'|'NATIVE'] )
-See L<Mail::Message::Body/"Constructing a body">
+Inherited, see L<Mail::Message::Body/"Constructing a body">
=item $obj-E<gt>B<foreachLine>(CODE)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<stripSignature>(OPTIONS)
+=item $obj-E<gt>B<stripSignature>(%options)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<unify>(BODY)
+=item $obj-E<gt>B<unify>($body)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=back
=head2 The body
-See L<documentation in the base class|Mail::Message::Body/"The body">.
+Extends L<"The body" in Mail::Message::Body|Mail::Message::Body/"The body">.
=over 4
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
-=item $obj-E<gt>B<partNumberOf>(PART)
+=item $obj-E<gt>B<partNumberOf>($part)
-See L<Mail::Message::Body/"The body">
+Inherited, see L<Mail::Message::Body/"The body">
=back
=head2 About the payload
-See L<documentation in the base class|Mail::Message::Body/"About the payload">.
+Extends L<"About the payload" in Mail::Message::Body|Mail::Message::Body/"About the payload">.
=over 4
=item $obj-E<gt>B<charset>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<checked>([BOOLEAN])
+=item $obj-E<gt>B<checked>( [BOOLEAN] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<contentId>([STRING|FIELD])
+=item $obj-E<gt>B<contentId>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<description>([STRING|FIELD])
+=item $obj-E<gt>B<description>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<disposition>([STRING|FIELD])
+=item $obj-E<gt>B<disposition>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<dispositionFilename>([DIRECTORY])
+=item $obj-E<gt>B<dispositionFilename>( [$directory] )
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isBinary>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isText>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<mimeType>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<transferEncoding>([STRING|FIELD])
+=item $obj-E<gt>B<transferEncoding>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
-=item $obj-E<gt>B<type>([STRING|FIELD])
+=item $obj-E<gt>B<type>( [STRING|$field] )
-See L<Mail::Message::Body/"About the payload">
+Inherited, see L<Mail::Message::Body/"About the payload">
=back
=head2 Access to the payload
-See L<documentation in the base class|Mail::Message::Body/"Access to the payload">.
+Extends L<"Access to the payload" in Mail::Message::Body|Mail::Message::Body/"Access to the payload">.
=over 4
=item $obj-E<gt>B<endsOnNewline>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<printEscapedFrom>(FILEHANDLE)
+=item $obj-E<gt>B<printEscapedFrom>($fh)
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=item $obj-E<gt>B<stripTrailingNewline>()
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
-See L<Mail::Message::Body/"Access to the payload">
+Inherited, see L<Mail::Message::Body/"Access to the payload">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Body/"Internals">.
+Extends L<"Internals" in Mail::Message::Body|Mail::Message::Body/"Internals">.
=over 4
-=item $obj-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item $obj-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-=item Mail::Message::Body::String-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item Mail::Message::Body::String-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
-=item $obj-E<gt>B<contentInfoFrom>(HEAD)
+=item $obj-E<gt>B<contentInfoFrom>($head)
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<contentInfoTo>(HEAD)
+=item $obj-E<gt>B<contentInfoTo>($head)
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<fileLocation>([BEGIN,END])
+=item $obj-E<gt>B<fileLocation>( [$begin, $end] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<getTransferEncHandler>(TYPE)
+=item $obj-E<gt>B<getTransferEncHandler>($type)
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
=item $obj-E<gt>B<load>()
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<moveLocation>([DISTANCE])
+=item $obj-E<gt>B<moveLocation>( [$distance] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
-=item $obj-E<gt>B<read>(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])
+=item $obj-E<gt>B<read>( $parser, $head, $bodytype, [$chars, [$lines]] )
-See L<Mail::Message::Body/"Internals">
+Inherited, see L<Mail::Message::Body/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Body/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Body|Mail::Message::Body/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Body/"Error handling">
+Inherited, see L<Mail::Message::Body/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Body::String-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Body::String-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Body::String-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Body::String-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Body::String-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Body::String-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Body/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Body|Mail::Message::Body/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Body/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Body|Mail::Message::Body/"DETAILS">.
=head1 DIAGNOSTICS
@@ -462,12 +462,12 @@ file, but it is impossible to read that file to retrieve the lines within.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Body;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -202,8 +202,9 @@ sub eol(;$)
sub message(;$)
{ my $self = shift;
if(@_)
- { $self->{MMB_message} = shift;
- weaken($self->{MMB_message});
+ { if($self->{MMB_message} = shift)
+ { weaken $self->{MMB_message};
+ }
}
$self->{MMB_message};
}
@@ -378,10 +379,17 @@ sub contentInfoFrom($)
{ my ($self, $head) = @_;
$self->type($head->get('Content-Type', 0));
- $self->transferEncoding($head->get('Content-Transfer-Encoding'));
- $self->disposition($head->get('Content-Disposition'));
- $self->description($head->get('Content-Description'));
- $self->contentId($head->get('Content-ID'));
+
+ my ($te, $disp, $desc, $cid)
+ = map { my $x = $head->get("Content-$_") || '';
+ s/^\s+//,s/\s+$// for $x;
+ length $x ? $x : undef
+ } qw/Transfer-Encoding Disposition Description ID/;
+
+ $self->transferEncoding($te);
+ $self->disposition($disp);
+ $self->description($desc);
+ $self->contentId($cid);
delete $self->{MMB_mime};
$self;
@@ -51,13 +51,13 @@ many body types. The functionality of each body type is equivalent, but there
are performance differences. Each body type has its own documentation
with details about its implementation.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 OVERLOADED
=over 4
-=item overload: B<"">()
+=item overload: B<"">
(stringification) Returns the body as string --which will trigger
completion-- unless called to produce a string for C<Carp>. The latter
@@ -70,7 +70,7 @@ example: stringification of body
my $body = $msg->body;
my $x = "$body"; # explicit by interpolation
-=item overload: B<'==' and '!='>()
+=item overload: B<'==' and '!='>
(numeric comparison) compares if two references point to the
same message. This only produces correct results is both arguments
@@ -84,7 +84,7 @@ example: use of numeric comparison on a body
$msg->send;
}
-=item overload: B<@{}>()
+=item overload: B<@{}>
When a body object is used as being an array reference, the lines of
the body are returned. This is the same as using L<lines()|Mail::Message::Body/"Access to the payload">.
@@ -97,7 +97,7 @@ example: using a body as array
my @lines = $body->lines;
my @lines = @$body; # same
-=item overload: B<bool>()
+=item overload: B<bool>
Always returns a true value, which is needed to have overloaded
objects to be used as in C<if($body)>. Otherwise, C<if(defined $body)>
@@ -107,11 +107,11 @@ would be needed to avoid a runtime error.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
@@ -120,7 +120,7 @@ See L<documentation in the base class|Mail::Reporter/"Constructors">.
Return a copy of this body, usually to be included in a cloned
message. Use L<Mail::Message::clone()|Mail::Message/"Constructors"> for a whole message.
-=item Mail::Message::Body-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Body-E<gt>B<new>(%options)
BE WARNED that, what you specify here are encodings and such which are
already in place. The options will not trigger conversions. When you
@@ -292,19 +292,19 @@ example:
=over 4
-=item $obj-E<gt>B<attach>(MESSAGES, OPTIONS)
+=item $obj-E<gt>B<attach>($messages, %options)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
=item $obj-E<gt>B<check>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<concatenate>(COMPONENTS)
+=item $obj-E<gt>B<concatenate>($components)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
Returns a body, an object which is (a sub-)class of a L<Mail::Message::Body|Mail::Message::Body>,
which contains a simplified representation of textual data. The returned
@@ -333,15 +333,15 @@ what is produced. This C<$dec> body is B<not related to a header>.
=back
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=item $obj-E<gt>B<encoded>()
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
-=item $obj-E<gt>B<eol>(['CR'|'LF'|'CRLF'|'NATIVE'])
+=item $obj-E<gt>B<eol>( ['CR'|'LF'|'CRLF'|'NATIVE'] )
Returns the character (or characters) which are used to separate lines
within this body. When a kind of separator is specified, the body is
@@ -354,15 +354,15 @@ example:
=item $obj-E<gt>B<foreachLine>(CODE)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<stripSignature>(OPTIONS)
+=item $obj-E<gt>B<stripSignature>(%options)
-See L<Mail::Message::Body::Construct/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Construct/"Constructing a body">
-=item $obj-E<gt>B<unify>(BODY)
+=item $obj-E<gt>B<unify>($body)
-See L<Mail::Message::Body::Encode/"Constructing a body">
+Inherited, see L<Mail::Message::Body::Encode/"Constructing a body">
=back
@@ -386,13 +386,13 @@ by themselves.
Only true for a message body which contains exactly one sub-message:
the C<Mail::Message::Body::Nested> body type.
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
Returns the message (or message part) where this body belongs to,
-optionally setting it to a new MESSAGE first. If C<undef> is passed,
+optionally setting it to a new $message first. If C<undef> is passed,
the body will be disconnected from the message.
-=item $obj-E<gt>B<partNumberOf>(PART)
+=item $obj-E<gt>B<partNumberOf>($part)
Returns a string for multiparts and nested, otherwise an error. It is
used in L<Mail::Message::partNumber()|Mail::Message/"The message">.
@@ -408,12 +408,12 @@ used in L<Mail::Message::partNumber()|Mail::Message/"The message">.
Returns the character set which is used in the text body as string. This
is part of the result of what the C<type> method returns.
-=item $obj-E<gt>B<checked>([BOOLEAN])
+=item $obj-E<gt>B<checked>( [BOOLEAN] )
Returns whether the body encoding has been checked or not (optionally
after setting the flag to a new value).
-=item $obj-E<gt>B<contentId>([STRING|FIELD])
+=item $obj-E<gt>B<contentId>( [STRING|$field] )
Returns (optionally after setting) the id (unique reference) of a
message part. The related header field is C<Content-ID>.
@@ -422,9 +422,9 @@ the field content). The field content will be C<none> if no disposition
was specified.
The argument can be a STRING (which is converted into a field), or a
-fully prepared header FIELD.
+fully prepared header $field.
-=item $obj-E<gt>B<description>([STRING|FIELD])
+=item $obj-E<gt>B<description>( [STRING|$field] )
Returns (optionally after setting) the informal description of the body
content. The related header field is C<Content-Description>.
@@ -435,7 +435,7 @@ was specified.
The argument can be a STRING (which is converted into a field), or a
fully prepared header field.
-=item $obj-E<gt>B<disposition>([STRING|FIELD])
+=item $obj-E<gt>B<disposition>( [STRING|$field] )
Returns (optionally after setting) how the message can be disposed
(unpacked). The related header field is C<Content-Disposition>.
@@ -446,17 +446,17 @@ was specified.
The argument can be a STRING (which is converted into a field), or a
fully prepared header field.
-=item $obj-E<gt>B<dispositionFilename>([DIRECTORY])
+=item $obj-E<gt>B<dispositionFilename>( [$directory] )
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isBinary>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<isText>()
-See L<Mail::Message::Body::Encode/"About the payload">
+Inherited, see L<Mail::Message::Body::Encode/"About the payload">
=item $obj-E<gt>B<mimeType>()
@@ -480,14 +480,14 @@ is computed in the shape it is in. For example, if this is a base64
encoded message, the size of the encoded data is returned; you may
want to call L<Mail::Message::decoded()|Mail::Message/"The body"> first.
-=item $obj-E<gt>B<transferEncoding>([STRING|FIELD])
+=item $obj-E<gt>B<transferEncoding>( [STRING|$field] )
Returns the transfer-encoding of the data within this body as
L<Mail::Message::Field|Mail::Message::Field> (which stringifies to its content). If it
needs to be changed, call the L<encode()|Mail::Message::Body::Encode/"Constructing a body"> or L<decoded()|Mail::Message::Body/"Constructing a body"> method.
When no encoding is present, the field contains the text C<none>.
-The optional STRING or FIELD enforces a new encoding to be set, without the
+The optional STRING or $field enforces a new encoding to be set, without the
actual required translations.
example:
@@ -498,7 +498,7 @@ example:
if($msg->body->transferEncoding eq 'none') {...}
-=item $obj-E<gt>B<type>([STRING|FIELD])
+=item $obj-E<gt>B<type>( [STRING|$field] )
Returns the type of information the body contains as
L<Mail::Message::Field|Mail::Message::Field> object. The type is taken from the header
@@ -575,15 +575,15 @@ example:
print $body->[0]; # by overloading
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-Print the body to the specified FILEHANDLE (defaults to the selected handle).
+Print the body to the specified $fh (defaults to the selected handle).
The handle may be a GLOB, an IO::File object, or... any object with a
C<print()> method will do. Nothing useful is returned.
-=item $obj-E<gt>B<printEscapedFrom>(FILEHANDLE)
+=item $obj-E<gt>B<printEscapedFrom>($fh)
-Print the body to the specified FILEHANDLE but all lines which start
+Print the body to the specified $fh but all lines which start
with 'From ' (optionally already preceded by E<gt>'s) will habe an E<gt>
added in front. Nothing useful is returned.
@@ -602,7 +602,7 @@ example:
Remove the newline from the last line, or the last line if it does not
contain anything else than a newline.
-=item $obj-E<gt>B<write>(OPTIONS)
+=item $obj-E<gt>B<write>(%options)
Write the content of the body to a file. Be warned that you may want to
decode the body before writing it!
@@ -637,31 +637,31 @@ example: using the content-disposition information to write
=over 4
-=item $obj-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item $obj-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-=item Mail::Message::Body-E<gt>B<addTransferEncHandler>(NAME, CLASS|OBJECT)
+=item Mail::Message::Body-E<gt>B<addTransferEncHandler>( $name, <$class|$object> )
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
-=item $obj-E<gt>B<contentInfoFrom>(HEAD)
+=item $obj-E<gt>B<contentInfoFrom>($head)
Transfer the body related info from the header into this body.
-=item $obj-E<gt>B<contentInfoTo>(HEAD)
+=item $obj-E<gt>B<contentInfoTo>($head)
Copy the content information (the C<Content-*> fields) into the specified
-HEAD. The body was created from raw data without the required information,
+$head. The body was created from raw data without the required information,
which must be added. See also L<contentInfoFrom()|Mail::Message::Body/"Internals">.
-=item $obj-E<gt>B<fileLocation>([BEGIN,END])
+=item $obj-E<gt>B<fileLocation>( [$begin, $end] )
The location of the body in the file. Returned a list containing begin and
end. The begin is the offsets of the first byte if the folder used for
this body. The end is the offset of the first byte of the next message.
-=item $obj-E<gt>B<getTransferEncHandler>(TYPE)
+=item $obj-E<gt>B<getTransferEncHandler>($type)
-See L<Mail::Message::Body::Encode/"Internals">
+Inherited, see L<Mail::Message::Body::Encode/"Internals">
=item $obj-E<gt>B<isModified>()
@@ -671,7 +671,7 @@ Returns whether the body has changed.
Be sure that the body is loaded. This returns the loaded body.
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
Change the body modification flag. This will force a re-write of the body
to a folder file when it is closed. It is quite dangerous to change the
@@ -683,25 +683,25 @@ change the body of the message: no two messages should have the same id.
Without value, the current setting is returned, although you can better use
L<isModified()|Mail::Message::Body/"Internals">.
-=item $obj-E<gt>B<moveLocation>([DISTANCE])
+=item $obj-E<gt>B<moveLocation>( [$distance] )
-Move the registration of the message to a new location over DISTANCE. This
+Move the registration of the message to a new location over $distance. This
is called when the message is written to a new version of the same
folder-file.
-=item $obj-E<gt>B<read>(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])
+=item $obj-E<gt>B<read>( $parser, $head, $bodytype, [$chars, [$lines]] )
-Read the body with the PARSER from file. The implementation of this method
-will differ between types of bodies. The BODYTYPE argument is a class name
+Read the body with the $parser from file. The implementation of this method
+will differ between types of bodies. The $bodytype argument is a class name
or a code reference of a routine which can produce a class name, and is
used in multipart bodies to determine the type of the body for each part.
-The CHARS argument is the estimated number of bytes in the body, or
+The $chars argument is the estimated number of bytes in the body, or
C<undef> when this is not known. This data can sometimes be derived from
the header (the C<Content-Length> line) or file-size.
-The second argument is the estimated number of LINES of the body. It is less
-useful than the CHARS but may be of help determining whether the message
+The second argument is the estimated number of $lines of the body. It is less
+useful than the $chars but may be of help determining whether the message
separator is trustworthy. This value may be found in the C<Lines> field
of the header.
@@ -709,7 +709,7 @@ of the header.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
@@ -721,67 +721,67 @@ implemented in separate files, and only demand-loaded. If this
delayed compilation of additional modules does not help, an error
will be produced.
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Body-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Body-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Body-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Body-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Body-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Body-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -929,12 +929,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Mail::Message::Head::Complete;
@@ -20,14 +20,14 @@ functionality related to bouncing messages off to other destinations.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=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
+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.
@@ -70,12 +70,12 @@ L<forward()|Mail::Message::Construct::Forward/"Constructing a message">.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Mail::Message::Head::Complete ();
@@ -95,7 +95,7 @@ sub build(@)
: Mail::Message::Body::Multipart->new(parts => \@parts);
# Setting the type explicitly, only after the body object is finalized
- $body->type($type) if defined $type;
+ $body->type($type) if defined $type;
$body->disposition($dispose) if defined $dispose;
$body->description($descr) if defined $descr;
$body->contentId($cid) if defined $cid;
@@ -6,16 +6,25 @@ Mail::Message::Construct::Build - building a Mail::Message from components
=head1 SYNOPSIS
- my $msg3 = Mail::Message->build
- (From => 'me', data => "only two\nlines\n");
+ my $msg1 = Mail::Message->build
+ ( From => 'me', data => "only two\nlines\n");
- my $msg4 = Mail::Message->buildFromBody($body);
+ my $msg2 = Mail::Message->buildFromBody($body);
+
+ Mail::Message->build
+ ( From => 'me@myhost.com'
+ , To => 'you@yourhost.com'
+ , Subject => "Read our folder!"
+
+ , data => \@lines
+ , file => 'folder.pdf'
+ )->send(via => 'postfix');
=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 building of messages from various components.
+building of messages from various simpler components.
=head1 METHODS
@@ -23,14 +32,14 @@ functionality related to building of messages from various components.
=over 4
-=item Mail::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Message-E<gt>B<build>( [$message|$part|$body], $content )
-Simplified message object builder. In case a MESSAGE or message PART is
+Simplified message object builder. In case a $message or message $part is
specified, a new message is created with the same body to start with, but
-new headers. A BODY may be specified as well. However, there are more
+new headers. A $body may be specified as well. However, there are more
ways to add data simply.
-The CONTENT is a list of key-value pairs and header field objects.
+The $content is a list of key-value pairs and header field objects.
The keys which start with a capital are used as header-lines. Lower-cased
fields are used for other purposes as listed below. Each field may be used
more than once. Pairs where the value is C<undef> are ignored.
@@ -57,9 +66,9 @@ been constructed. Together, they produce your message.
=item attach => BODY|PART|MESSAGE|ARRAY
-One attachment to the message. Each attachment can be full MESSAGE, a
-PART, or a BODY.
-Any MESSAGE will get encapsulated into a C<message/rfc822> body.
+One attachment to the message. Each attachment can be full $message, a
+$part, or a $body.
+Any $message will get encapsulated into a C<message/rfc822> body.
You can specify many items (may be of different types) at once.
attach => $folder->message(3)->decoded # body
@@ -123,13 +132,13 @@ example:
, data => "<html></html>"
);
-=item Mail::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Message-E<gt>B<buildFromBody>($body, [$head], $headers)
-Shape a message around a BODY. Bodies have information about their
+Shape a message around a $body. Bodies have information about their
content in them, which is used to construct a header for the message.
-You may specify a HEAD object which is pre-initialized, or one is
-created for you (also when HEAD is C<undef>).
-Next to that, more HEADERS can be specified which are stored in that
+You may specify a $head object which is pre-initialized, or one is
+created for you (also when $head is C<undef>).
+Next to that, more $headers can be specified which are stored in that
header.
Header fields are added in order, and before the header lines as
@@ -300,12 +309,12 @@ into the right message type, adding storage information and the like.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Mail::Message::Body::Multipart;
@@ -21,7 +21,7 @@ functionality related to creating forwarded messages.
=over 4
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
Forward the content of this message. The body of the message to be forwarded
is encapsulated in some accompanying text (if you have no wish for that, than
@@ -124,7 +124,7 @@ before it, and added behind the epilogue.
=back
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
Forward the message as I<flat> attachment to the specified C<preamble>. You
can specify all options available to C<forward()>, although a C<preamble>
@@ -140,7 +140,7 @@ is ignored.
=back
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
Like L<forwardAttach()|Mail::Message::Construct::Forward/"Constructing a message">, but in this case the original message is first
encapsulated as nested message in a L<Mail::Message::Body::Nested|Mail::Message::Body::Nested>, and
@@ -159,7 +159,7 @@ is ignored. Signatures are not stripped. Signatures are not stripped.
=back
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
This method is equivalent in behavior to L<forward()|Mail::Message::Construct::Forward/"Constructing a message"> with the
option C<include> set to C<'INLINE'>. You can specify most of
@@ -221,13 +221,13 @@ before quoting.
=back
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
Construct a forward, where the whole body of the message is already
constructed. That complex body is usually produced in L<forwardInline()|Mail::Message::Construct::Forward/"Constructing a message">,
L<forwardAttach()|Mail::Message::Construct::Forward/"Constructing a message">, or L<forwardEncapsulate()|Mail::Message::Construct::Forward/"Constructing a message">.
-The OPTIONS are the same as for C<forward()> except that C<body> is
+The %options are the same as for C<forward()> except that C<body> is
required. Some other options, like C<preamble>, are ignored.
-Option--Default
@@ -398,12 +398,12 @@ If a forward message is created, a destination address must be specified.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Mail::Box::FastScalar;
@@ -21,11 +21,11 @@ handle.
=over 4
-=item Mail::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-Read a message from a FILEHANDLE, SCALAR, a reference to a SCALAR, or
-a reference to an array of LINES. Most OPTIONS are passed to the L<new()|Mail::Message/"Constructors">
-of the message which is created, but a few extra are defined.
+Read a message from a $fh, STRING, SCALAR, or a reference to an
+ARRAY of lines. Most %options are passed to the L<new()|Mail::Message/"Constructors"> of the message
+which is created, but a few extra are defined.
Please have a look at L<build()|Mail::Message::Construct::Build/"Constructing a message"> and L<buildFromBody()|Mail::Message::Construct::Build/"Constructing a message"> before thinking about
this C<read> method. Use this C<read> only when you have a file-handle
@@ -88,12 +88,12 @@ example:
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Mail::Message::Head::Complete;
@@ -82,11 +82,12 @@ sub removeEmptyMultiparts($@)
sub flattenEmptyMultiparts($@)
{ my ($self, $part) = @_;
- return $part unless $part->isMultipart && $part->parts('ACTIVE')==0;
+
+ $part->isMultipart && $part->parts('ACTIVE')==0
+ or return $part;
my $body = $part->body;
- my $preamble = $body->preamble
- || Mail::Message::Body::Lines->new(data => '');
+ my $preamble = $body->preamble || Mail::Message::Body::Lines->new(data=>'');
my $epilogue = $body->epilogue;
my $newbody = $preamble->concatenate($preamble, <<NO_PARTS, $epilogue);
* PLEASE NOTE:
@@ -96,9 +97,9 @@ sub flattenEmptyMultiparts($@)
NO_PARTS
my $rebuild = Mail::Message::Part->new
- ( head => $part->head->clone
- , container => undef
- );
+ ( head => $part->head->clone
+ , container => undef
+ );
$rebuild->body($newbody);
$rebuild;
}
@@ -123,7 +124,7 @@ sub descendMultiparts($@)
else { push @newparts, $new; $changed++ }
}
- $changed or return $part;
+ $changed or return $part;
my $newbody = ref($body)->new
( based_on => $body
@@ -167,17 +168,17 @@ sub removeDeletedParts($@)
sub replaceDeletedParts($@)
{ my ($self, $part) = @_;
- return $part
- unless ($part->isNested && $part->body->nested->isDeleted)
- || $part->isDeleted;
+ ($part->isNested && $part->body->nested->isDeleted) || $part->isDeleted
+ or return $part;
my $structure = '';
my $output = Mail::Box::FastScalar->new(\$structure, ' ');
$part->printStructure($output);
+ my $dispfn = $part->body->dispositionFilename || '';
Mail::Message::Part->build
- ( data => "Removed content:\n\n$structure"
- );
+ ( data => "Removed content:\n\n$structure\n$dispfn"
+ );
}
#------------------------------------------
@@ -185,7 +186,8 @@ sub replaceDeletedParts($@)
sub removeHtmlAlternativeToText($@)
{ my ($self, $part, %args) = @_;
- return $part unless $part->body->mimeType eq 'text/html';
+ $part->body->mimeType eq 'text/html'
+ or return $part;
my $container = $part->container;
@@ -193,6 +195,7 @@ sub removeHtmlAlternativeToText($@)
unless defined $container
&& $container->mimeType eq 'multipart/alternative';
+ # The HTML $part will be nulled when a plain text part is found
foreach my $subpart ($container->parts)
{ return undef if $subpart->body->mimeType eq 'text/plain';
}
@@ -200,8 +203,19 @@ sub removeHtmlAlternativeToText($@)
$part;
}
-my $has_hft;
+sub removeExtraAlternativeText($@)
+{ my ($self, $part, %args) = @_;
+
+ my $container = $part->container;
+ $container && $container->mimeType eq 'multipart/alternative'
+ or return $part;
+ # The last part is the preferred part (as per RFC2046)
+ my $last = ($container->parts)[-1];
+ $last && $part==$last ? $part : undef;
+}
+
+my $has_hft;
sub textAlternativeForHtml($@)
{ my ($self, $part, %args) = @_;
@@ -262,11 +276,7 @@ sub recursiveRebuildPart($@)
RULES:
foreach my $rule (@{$args{rules}})
- { my $rebuild
- = ref $rule ? $rule->($self, $part, %args)
- : $self->$rule($part, %args);
-
- defined $rebuild
+ { my $rebuild = $self->$rule($part, %args)
or return undef;
if($part != $rebuild)
@@ -21,7 +21,7 @@ tries to simplify this task and add some standard features.
=over 4
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
Reconstruct an existing message into something new. Returned is a new
message when there were modifications made, C<undef> if the message has
@@ -100,7 +100,7 @@ example:
=over 4
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-Option--Default
rules <required>
@@ -224,9 +224,8 @@ content. Please contribute with ideas and implementations.
=item * removeHtmlAlternativeToText
When a multipart alternative is encountered, which contains both a
-plain text and an html part, then the html part is flagged for
-deletion. Especially useful in combination with the C<removeDeletedParts>
-and C<flattenMultiparts> rules.
+plain text and an html part, then the html part is deleted.
+Especially useful in combination with the C<flattenMultiparts> rule.
=item * textAlternativeForHtml
@@ -236,6 +235,14 @@ L<Mail::Message::Convert::HtmlFormatText|Mail::Message::Convert::HtmlFormatText>
HTML::TreeBuilder and HTML::FormatText must be installed on
your system.
+=item * removeExtraAlternativeText
+
+[2.110] When a multipart alternative is encountered, deletes all its parts
+except for the last part (the preferred part in accordance
+with RFC2046). In practice, this normally results in the alternative
+plain text part being deleted of an html message. Useful in combination
+with the C<flattenMultiparts> rule.
+
=back
=head3 Adding your own rules
@@ -272,12 +279,12 @@ When you have your own routine, you simply call:
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Mail::Message::Body::Multipart;
@@ -21,7 +21,7 @@ functionality related to creating message replies.
=over 4
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
Start a reply to this message. Some of the header-lines of the original
message will be taken. A message-id will be assigned. Some header lines
@@ -35,7 +35,7 @@ or you may do that later with C<set> on the header.
ADDRESSES may be specified as string, or
a L<Mail::Address|Mail::Address> object, or as array of L<Mail::Address|Mail::Address> objects.
-All OPTIONS which are not listed below AND start with a capital, will
+All %options which are not listed below AND start with a capital, will
be added as additional headers to the reply message.
-Option --Default
@@ -182,12 +182,12 @@ example:
, 'X-Extra' => 'additional header'
);
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
Produces a list of lines (usually only one), which will preceded the
quoted body of the message. STRING must comply to the RFC822 email
address specification, and is usually the content of a C<To> or C<From>
-header line. If a FIELD is specified, the field's body must be
+header line. If a $field is specified, the field's body must be
compliant. Without argument -or when the argument is C<undef>- a
slightly different line is produced.
@@ -227,12 +227,12 @@ choices are C<NO>, C<INLINE>, and C<ATTACH>.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use IO::Lines;
@@ -39,17 +39,17 @@ Returns the whole message as set of lines. In LIST context, copies of the
lines are returned. In SCALAR context, a reference to an array of lines
is returned.
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-Print the structure of a message to the specified FILEHANDLE or the
+Print the structure of a message to the specified $fh or the
selected filehandle. When explicitly C<undef> is specified as handle,
then the output will be returned as string.
The message's subject and the types of all composing parts are
displayed.
-INDENT specifies the initial indentation string: it is added in front
-of each line. The INDENT must contain at least one white-space.
+$indent specifies the initial indentation string: it is added in front
+of each line. The $indent must contain at least one white-space.
example:
@@ -78,12 +78,12 @@ Returns the whole message as string.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Mail::Message::Head::Complete;
@@ -30,12 +30,12 @@ the requested method.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Convert::EmailSimple;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Convert';
@@ -38,34 +38,34 @@ The internals of this class are far from optimal. The conversion
does work (thanks to Ricardo Signes), but is expensive in time
and memory usage. It could easily be optimized.
-See L<documentation in the base class|Mail::Message::Convert/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Convert|Mail::Message::Convert/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Convert/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Convert|Mail::Message::Convert/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Convert/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Convert|Mail::Message::Convert/"Constructors">.
=over 4
-=item Mail::Message::Convert::EmailSimple-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Convert::EmailSimple-E<gt>B<new>(%options)
-See L<Mail::Message::Convert/"METHODS">
+Inherited, see L<Mail::Message::Convert/"METHODS">
=back
=head2 Converting
-See L<documentation in the base class|Mail::Message::Convert/"Converting">.
+Extends L<"Converting" in Mail::Message::Convert|Mail::Message::Convert/"Converting">.
=over 4
-=item $obj-E<gt>B<export>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<export>($message, %options)
Returns a new Email::Simple object based on the information from
-a L<Mail::Message|Mail::Message> object. The MESSAGE specified is an
+a L<Mail::Message|Mail::Message> object. The $message specified is an
instance of a Mail::Message.
example:
@@ -74,7 +74,7 @@ example:
my Mail::Message $msg = Mail::Message->new;
my Mail::Internet $copy = $convert->export($msg);
-=item $obj-E<gt>B<from>(OBJECT, OPTIONS)
+=item $obj-E<gt>B<from>($object, %options)
Returns a new L<Mail::Message|Mail::Message> object based on the information from
an Email::Simple.
@@ -85,83 +85,83 @@ example:
my Mail::Internet $msg = Mail::Internet->new;
my Mail::Message $copy = $convert->from($msg);
-=item $obj-E<gt>B<selectedFields>(HEAD)
+=item $obj-E<gt>B<selectedFields>($head)
-See L<Mail::Message::Convert/"Converting">
+Inherited, see L<Mail::Message::Convert/"Converting">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Convert/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Convert|Mail::Message::Convert/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Convert::EmailSimple-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Convert::EmailSimple-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Convert::EmailSimple-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Convert::EmailSimple-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Convert::EmailSimple-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Convert::EmailSimple-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Convert/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Convert|Mail::Message::Convert/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -181,12 +181,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Convert::Html;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Convert';
@@ -26,19 +26,19 @@ The package contains various translators which handle HTML or XHTML
without the help of external modules. There are more HTML related modules,
which do require extra packages to be installed.
-See L<documentation in the base class|Mail::Message::Convert/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Convert|Mail::Message::Convert/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Convert/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Convert|Mail::Message::Convert/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Convert/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Convert|Mail::Message::Convert/"Constructors">.
=over 4
-=item Mail::Message::Convert::Html-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Convert::Html-E<gt>B<new>(%options)
-Option --Defined in --Default
fields Mail::Message::Convert <see description>
@@ -70,24 +70,24 @@ html browsers will usually accept the XHTML data.
=head2 Converting
-See L<documentation in the base class|Mail::Message::Convert/"Converting">.
+Extends L<"Converting" in Mail::Message::Convert|Mail::Message::Convert/"Converting">.
=over 4
-=item $obj-E<gt>B<fieldContentsToHtml>(FIELD, [SUBJECT])
+=item $obj-E<gt>B<fieldContentsToHtml>( $field, [$subject] )
Format one field from the header to HTML. When the header line usually
contains e-mail addresses, the line is scanned and valid addresses
-are linked with an C<mailto:> anchor. The SUBJECT can be specified to
+are linked with an C<mailto:> anchor. The $subject can be specified to
be included in that link.
-=item $obj-E<gt>B<fieldToHtml>(FIELD, [SUBJECT])
+=item $obj-E<gt>B<fieldToHtml>( $field, [$subject] )
-Reformat one header line field to HTML. The FIELD's name
+Reformat one header line field to HTML. The $field's name
is printed in bold, followed by the formatted field content,
which is produced by L<fieldContentsToHtml()|Mail::Message::Convert::Html/"Converting">.
-=item $obj-E<gt>B<headToHtmlHead>(HEAD, META)
+=item $obj-E<gt>B<headToHtmlHead>($head, $meta)
Translate the selected header lines (fields) to an html page header. Each
selected field will get its own meta line with the same name as the line.
@@ -113,10 +113,10 @@ example:
splice @head, -1, 0, '<meta http-equiv=...>';
print @head;
-=item $obj-E<gt>B<headToHtmlTable>(HEAD, [TABLE-PARAMS])
+=item $obj-E<gt>B<headToHtmlTable>( $head, [$table_params] )
Produce a display of the L<selectedFields()|Mail::Message::Convert/"Converting"> of the header in a
-table shape. The optional TABLE-PARAMS are added as parameters to the
+table shape. The optional $table_params are added as parameters to the
produced TABLE tag. In list context, the separate lines are returned.
In scalar context, everything is returned as one.
@@ -124,13 +124,13 @@ example:
print $html->headToHtmlTable($head, 'width="50%"');
-=item $obj-E<gt>B<selectedFields>(HEAD)
+=item $obj-E<gt>B<selectedFields>($head)
-See L<Mail::Message::Convert/"Converting">
+Inherited, see L<Mail::Message::Convert/"Converting">
-=item $obj-E<gt>B<textToHtml>(LINES)
+=item $obj-E<gt>B<textToHtml>($lines)
-Translate one or more LINES from text into HTML. Each line is taken one
+Translate one or more $lines from text into HTML. Each line is taken one
after the other, and only simple things are translated. C<textToHtml>
is able to convert large plain texts in a descent fashion. In scalar
context, the resulting lines are returned as one.
@@ -139,75 +139,75 @@ context, the resulting lines are returned as one.
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Convert/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Convert|Mail::Message::Convert/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Convert::Html-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Convert::Html-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Convert::Html-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Convert::Html-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Convert::Html-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Convert::Html-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Convert/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Convert|Mail::Message::Convert/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -227,12 +227,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Convert::HtmlFormatPS;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Convert';
@@ -22,21 +22,21 @@ Mail::Message::Convert::HtmlFormatPS - Convert HTML into PostScript
Translate an HTML/XHTML message body into a postscript body
using HTML::FormatPS.
-See L<documentation in the base class|Mail::Message::Convert/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Convert|Mail::Message::Convert/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Convert/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Convert|Mail::Message::Convert/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Convert/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Convert|Mail::Message::Convert/"Constructors">.
=over 4
-=item Mail::Message::Convert::HtmlFormatPS-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Convert::HtmlFormatPS-E<gt>B<new>(%options)
-OPTIONS which start with capitals are blindly passed to HTML::FormatPS.
+%options which start with capitals are blindly passed to HTML::FormatPS.
As of this writing, that package
defines BottomMargin, FontFamily, FontScale, HorizontalMargin, Leading,
LeftMargin, PageNo, PaperHeight, PaperSize, PaperWidth, RightMargin,
@@ -61,92 +61,92 @@ TopMargin, and VerticalMargin.
=head2 Converting
-See L<documentation in the base class|Mail::Message::Convert/"Converting">.
+Extends L<"Converting" in Mail::Message::Convert|Mail::Message::Convert/"Converting">.
=over 4
-=item $obj-E<gt>B<format>(BODY)
+=item $obj-E<gt>B<format>($body)
Pass an html/xhtml encoded body, and a plain text body is returned.
Characters are translated into Latin1.
-=item $obj-E<gt>B<selectedFields>(HEAD)
+=item $obj-E<gt>B<selectedFields>($head)
-See L<Mail::Message::Convert/"Converting">
+Inherited, see L<Mail::Message::Convert/"Converting">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Convert/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Convert|Mail::Message::Convert/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Convert::HtmlFormatPS-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Convert::HtmlFormatPS-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Convert::HtmlFormatPS-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Convert::HtmlFormatPS-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Convert::HtmlFormatPS-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Convert::HtmlFormatPS-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Convert/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Convert|Mail::Message::Convert/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -166,12 +166,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Convert::HtmlFormatText;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Convert';
@@ -25,19 +25,19 @@ HTML::FormatText which are not installed by default together with
Mail::Box. See also L<Mail::Message::rebuild()|Mail::Message::Construct::Rebuild/"Constructing a message"> with rule
C<text_alternative_for_html>.
-See L<documentation in the base class|Mail::Message::Convert/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Convert|Mail::Message::Convert/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Convert/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Convert|Mail::Message::Convert/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Convert/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Convert|Mail::Message::Convert/"Constructors">.
=over 4
-=item Mail::Message::Convert::HtmlFormatText-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Convert::HtmlFormatText-E<gt>B<new>(%options)
-Option --Defined in --Default
fields Mail::Message::Convert <see description>
@@ -68,92 +68,92 @@ The column of the right margin, passed to the formatter.
=head2 Converting
-See L<documentation in the base class|Mail::Message::Convert/"Converting">.
+Extends L<"Converting" in Mail::Message::Convert|Mail::Message::Convert/"Converting">.
=over 4
-=item $obj-E<gt>B<format>(BODY)
+=item $obj-E<gt>B<format>($body)
Pass an html/xhtml encoded body, and a plain text body is returned.
Characters are translated into Latin1.
-=item $obj-E<gt>B<selectedFields>(HEAD)
+=item $obj-E<gt>B<selectedFields>($head)
-See L<Mail::Message::Convert/"Converting">
+Inherited, see L<Mail::Message::Convert/"Converting">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Convert/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Convert|Mail::Message::Convert/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Convert::HtmlFormatText-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Convert::HtmlFormatText-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Convert::HtmlFormatText-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Convert::HtmlFormatText-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Convert::HtmlFormatText-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Convert::HtmlFormatText-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Convert/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Convert|Mail::Message::Convert/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -173,12 +173,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::Convert::MailInternet;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Convert';
@@ -34,34 +34,34 @@ format was developed when e-mail messages where still small and
attachments where rare; Mail::Message is much more flexible in
this respect.
-See L<documentation in the base class|Mail::Message::Convert/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Convert|Mail::Message::Convert/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Convert/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Convert|Mail::Message::Convert/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Convert/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Convert|Mail::Message::Convert/"Constructors">.
=over 4
-=item Mail::Message::Convert::MailInternet-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Convert::MailInternet-E<gt>B<new>(%options)
-See L<Mail::Message::Convert/"METHODS">
+Inherited, see L<Mail::Message::Convert/"METHODS">
=back
=head2 Converting
-See L<documentation in the base class|Mail::Message::Convert/"Converting">.
+Extends L<"Converting" in Mail::Message::Convert|Mail::Message::Convert/"Converting">.
=over 4
-=item $obj-E<gt>B<export>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<export>($message, %options)
Returns a new message object based on the information from
-a L<Mail::Message|Mail::Message> object. The MESSAGE specified is an
+a L<Mail::Message|Mail::Message> object. The $message specified is an
instance of a Mail::Message.
example:
@@ -70,7 +70,7 @@ example:
my Mail::Message $msg = Mail::Message->new;
my Mail::Internet $copy = $convert->export($msg);
-=item $obj-E<gt>B<from>(OBJECT, OPTIONS)
+=item $obj-E<gt>B<from>($object, %options)
Returns a new L<Mail::Message|Mail::Message> object based on the information
from a L<Mail::Internet|Mail::Internet> object.
@@ -81,83 +81,83 @@ example:
my Mail::Internet $msg = Mail::Internet->new;
my Mail::Message $copy = $convert->from($msg);
-=item $obj-E<gt>B<selectedFields>(HEAD)
+=item $obj-E<gt>B<selectedFields>($head)
-See L<Mail::Message::Convert/"Converting">
+Inherited, see L<Mail::Message::Convert/"Converting">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Convert/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Convert|Mail::Message::Convert/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Convert::MailInternet-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Convert::MailInternet-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Convert::MailInternet-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Convert::MailInternet-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Convert::MailInternet-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Convert::MailInternet-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Convert/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Convert|Mail::Message::Convert/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -177,12 +177,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::Convert::MimeEntity;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Convert';
@@ -30,8 +30,6 @@ sub export($$;$)
$parser->parse($message->file);
}
-#------------------------------------------
-
sub from($)
{ my ($self, $mime_ent) = @_;
@@ -44,6 +42,4 @@ sub from($)
Mail::Message->read($mime_ent->as_string);
}
-#------------------------------------------
-
1;
@@ -33,40 +33,40 @@ and more methods. The L<Mail::Message|Mail::Message> objects are more flexible
in how the message parts are stored, and uses separate header and body
objects.
-See L<documentation in the base class|Mail::Message::Convert/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Convert|Mail::Message::Convert/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Convert/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Convert|Mail::Message::Convert/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Convert/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Convert|Mail::Message::Convert/"Constructors">.
=over 4
-=item Mail::Message::Convert::MimeEntity-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Convert::MimeEntity-E<gt>B<new>(%options)
-See L<Mail::Message::Convert/"METHODS">
+Inherited, see L<Mail::Message::Convert/"METHODS">
=back
=head2 Converting
-See L<documentation in the base class|Mail::Message::Convert/"Converting">.
+Extends L<"Converting" in Mail::Message::Convert|Mail::Message::Convert/"Converting">.
=over 4
-=item $obj-E<gt>B<export>(MESSAGE, [PARSER])
+=item $obj-E<gt>B<export>( $message, [$parser] )
Returns a new L<MIME::Entity> message object based on the
-information from the MESSAGE, which is a L<Mail::Message|Mail::Message> object.
+information from the $message, which is a L<Mail::Message|Mail::Message> object.
-You may want to supply your own PARSER, which is a MIME::Parser
-object, to change the parser flags. Without a PARSER object, one
+You may want to supply your own $parser, which is a MIME::Parser
+object, to change the parser flags. Without a $parser object, one
is created for you, with all the default settings.
-If C<undef> is passed, in place of a MESSAGE, then an empty list is
+If C<undef> is passed, in place of a $message, then an empty list is
returned. When the parsing failes, then L<MIME::Parser> throws an
exception.
@@ -76,7 +76,7 @@ example:
my Mail::Message $msg = Mail::Message->new;
my manual MIME::Entity $copy = $convert->export($msg);
-=item $obj-E<gt>B<from>(MIME-OBJECT)
+=item $obj-E<gt>B<from>($mime_object)
Returns a new L<Mail::Message|Mail::Message> object based on the information from
the specified L<MIME::Entity>. If the conversion fails, the C<undef>
@@ -89,83 +89,83 @@ example:
my MIME::Entity $msg = MIME::Entity->new;
my Mail::Message $copy = $convert->from($msg);
-=item $obj-E<gt>B<selectedFields>(HEAD)
+=item $obj-E<gt>B<selectedFields>($head)
-See L<Mail::Message::Convert/"Converting">
+Inherited, see L<Mail::Message::Convert/"Converting">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Convert/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Convert|Mail::Message::Convert/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Convert::MimeEntity-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Convert::MimeEntity-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Convert::MimeEntity-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Convert::MimeEntity-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Convert::MimeEntity-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Convert::MimeEntity-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Convert/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Convert|Mail::Message::Convert/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -187,12 +187,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Convert::TextAutoformat;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Convert';
@@ -22,19 +22,19 @@ Mail::Message::Convert::TextAutoformat - Reformat plain text messages
Play trics with plain text, for instance bodies with type C<text/plain>
using Damian Conway's Text::Autoformat.
-See L<documentation in the base class|Mail::Message::Convert/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Convert|Mail::Message::Convert/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Convert/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Convert|Mail::Message::Convert/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Convert/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Convert|Mail::Message::Convert/"Constructors">.
=over 4
-=item Mail::Message::Convert::TextAutoformat-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Convert::TextAutoformat-E<gt>B<new>(%options)
-Option --Defined in --Default
fields Mail::Message::Convert <see description>
@@ -61,93 +61,93 @@ is called.
=head2 Converting
-See L<documentation in the base class|Mail::Message::Convert/"Converting">.
+Extends L<"Converting" in Mail::Message::Convert|Mail::Message::Convert/"Converting">.
=over 4
-=item $obj-E<gt>B<autoformatBody>(BODY)
+=item $obj-E<gt>B<autoformatBody>($body)
Formats a single message body (a L<Mail::Message::Body|Mail::Message::Body> object)
into a new body object using Text::Autoformat. If the
Text::Autoformat is not installed, C<undef> is returned.
-=item $obj-E<gt>B<selectedFields>(HEAD)
+=item $obj-E<gt>B<selectedFields>($head)
-See L<Mail::Message::Convert/"Converting">
+Inherited, see L<Mail::Message::Convert/"Converting">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Convert/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Convert|Mail::Message::Convert/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Convert::TextAutoformat-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Convert::TextAutoformat-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Convert::TextAutoformat-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Convert::TextAutoformat-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Convert::TextAutoformat-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Convert::TextAutoformat-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Convert/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Convert|Mail::Message::Convert/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -167,12 +167,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::Convert;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -26,7 +26,7 @@ Available methods are very converter-specific.
This class is the base for various message (and message parts) converters.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head2 Converters between message objects
@@ -78,15 +78,15 @@ Converts a text message into text using Text::Autoformat.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Message::Convert-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Convert-E<gt>B<new>(%options)
-Option--Defined in --Default
fields <see description>
@@ -117,7 +117,7 @@ fields.
=over 4
-=item $obj-E<gt>B<selectedFields>(HEAD)
+=item $obj-E<gt>B<selectedFields>($head)
Returns a list of fields to be included in the format. The list is
an ordered selection of the fields in the actual header, and filtered
@@ -127,75 +127,75 @@ through the information as specified with L<new(fields)|Mail::Message::Convert/"
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Convert-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Convert-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Convert-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Convert-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Convert-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Convert-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -215,12 +215,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message::Dummy;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message';
@@ -30,21 +30,15 @@ sub init($)
sub isDummy() { 1 }
-#-------------------------------------------
-
sub head()
{ shift->log(ERROR => "You cannot take the head of a dummy message");
();
}
-#-------------------------------------------
-
sub body()
{ shift->log(ERROR => "You cannot take the body of a dummy message");
();
}
-#-------------------------------------------
-
1;
@@ -25,26 +25,26 @@ Be careful when using modules which may create dummies. Before trying to
access the header or body use L<isDummy()|Mail::Message/"The message"> to check if the message is a
dummy message.
-See L<documentation in the base class|Mail::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message|Mail::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Message|Mail::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Message|Mail::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Message::Dummy-E<gt>B<new>(MESSAGE-ID, OPTIONS)
+=item Mail::Message::Dummy-E<gt>B<new>($message_id, %options)
Create a new dummy message to occupy the space for
-a real message with the specified MESSAGE-ID.
+a real message with the specified $message_id.
-Option --Defined in --Default
body Mail::Message <not used>
@@ -97,427 +97,427 @@ example:
=head2 Constructing a message
-See L<documentation in the base class|Mail::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Message|Mail::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Message::Dummy-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Message::Dummy-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Message::Dummy-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Message::Dummy-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Message::Dummy-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Message::Dummy-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Message::Dummy-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Message/"The message">.
+Extends L<"The message" in Mail::Message|Mail::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<size>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=back
=head2 The header
-See L<documentation in the base class|Mail::Message/"The header">.
+Extends L<"The header" in Mail::Message|Mail::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<head>(...)
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Message/"The body">.
+Extends L<"The body" in Mail::Message|Mail::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Message/"Flags">.
+Extends L<"Flags" in Mail::Message|Mail::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Message|Mail::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message/"Internals">.
+Extends L<"Internals" in Mail::Message|Mail::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Message::Dummy-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item Mail::Message::Dummy-E<gt>B<coerce>($message, %options)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Message|Mail::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Dummy-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Dummy-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Dummy-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Dummy-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Dummy-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Dummy-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Message::Dummy-E<gt>B<shortSize>([VALUE])
+=item Mail::Message::Dummy-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message|Mail::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Message/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message|Mail::Message/"DETAILS">.
=head1 DIAGNOSTICS
@@ -594,12 +594,12 @@ node returned a dummy or not.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Field::AddrGroup;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'User::Identity::Collection::Emails';
@@ -20,7 +20,7 @@ use overload '""' => 'string';
sub string()
{ my $self = shift;
my $name = $self->name;
- my @addr = sort map {$_->string} $self->addresses;
+ my @addr = sort map $_->string, $self->addresses;
local $" = ', ';
@@ -26,19 +26,19 @@ Mail::Message::Field::AddrGroup - A group of Mail::Message::Field::Address objec
An address group collects a set of e-mail addresses (in this case they
are L<Mail::Message::Field::Address|Mail::Message::Field::Address> objects).
-See L<documentation in the base class|User::Identity::Collection::Emails/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|User::Identity::Collection::Emails/"OVERLOADED">.
+Extends L<"OVERLOADED" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"OVERLOADED">.
=over 4
-=item overload: B<@{}>()
+=item overload: B<@{}>
-See L<User::Identity::Collection/"OVERLOADED">
+Inherited, see L<User::Identity::Collection/"OVERLOADED">
-=item overload: B<stringification>()
+=item overload: B<stringification>
Returns the L<string()|Mail::Message::Field::AddrGroup/"METHODS"> value.
@@ -46,7 +46,7 @@ Returns the L<string()|Mail::Message::Field::AddrGroup/"METHODS"> value.
=head1 METHODS
-See L<documentation in the base class|User::Identity::Collection::Emails/"METHODS">.
+Extends L<"METHODS" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"METHODS">.
=over 4
@@ -61,117 +61,117 @@ where included and there is no name, then C<undef> is returned.
=head2 Constructors
-See L<documentation in the base class|User::Identity::Collection::Emails/"Constructors">.
+Extends L<"Constructors" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"Constructors">.
=over 4
-=item $obj-E<gt>B<coerce>(OBJECT)
+=item $obj-E<gt>B<coerce>($object)
-Coerce an OBJECT into a L<Mail::Message::Field::AddrGroup|Mail::Message::Field::AddrGroup>. Currently,
+Coerce an $object into a L<Mail::Message::Field::AddrGroup|Mail::Message::Field::AddrGroup>. Currently,
you can only coerce L<User::Identity::Collection::Emails|User::Identity::Collection::Emails> (which is
the base class for this one) into this one.
-=item Mail::Message::Field::AddrGroup-E<gt>B<new>([NAME], OPTIONS)
+=item Mail::Message::Field::AddrGroup-E<gt>B<new>( [NAME], OPTIONS )
-See L<User::Identity::Collection::Emails/"Constructors">
+Inherited, see L<User::Identity::Collection::Emails/"Constructors">
=back
=head2 Attributes
-See L<documentation in the base class|User::Identity::Collection::Emails/"Attributes">.
+Extends L<"Attributes" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"Attributes">.
=over 4
=item $obj-E<gt>B<description>()
-See L<User::Identity::Item/"Attributes">
+Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<itemType>()
-See L<User::Identity::Collection/"Attributes">
+Inherited, see L<User::Identity::Collection/"Attributes">
-=item $obj-E<gt>B<name>([NEWNAME])
+=item $obj-E<gt>B<name>( [NEWNAME] )
-See L<User::Identity::Item/"Attributes">
+Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<roles>()
-See L<User::Identity::Collection/"Attributes">
+Inherited, see L<User::Identity::Collection/"Attributes">
=back
=head2 Collections
-See L<documentation in the base class|User::Identity::Collection::Emails/"Collections">.
+Extends L<"Collections" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"Collections">.
=over 4
=item $obj-E<gt>B<add>(COLLECTION, ROLE)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<addCollection>(OBJECT | ([TYPE], OPTIONS))
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<collection>(NAME)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
-=item $obj-E<gt>B<parent>([PARENT])
+=item $obj-E<gt>B<parent>( [PARENT] )
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<removeCollection>(OBJECT|NAME)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<type>()
=item Mail::Message::Field::AddrGroup-E<gt>B<type>()
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<user>()
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=back
=head2 Maintaining roles
-See L<documentation in the base class|User::Identity::Collection::Emails/"Maintaining roles">.
+Extends L<"Maintaining roles" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"Maintaining roles">.
=over 4
-=item $obj-E<gt>B<addRole>(ROLE| ( [NAME],OPTIONS ) | ARRAY-OF-OPTIONS)
+=item $obj-E<gt>B<addRole>(ROLE| ([NAME],OPTIONS) | ARRAY)
-See L<User::Identity::Collection/"Maintaining roles">
+Inherited, see L<User::Identity::Collection/"Maintaining roles">
=item $obj-E<gt>B<removeRole>(ROLE|NAME)
-See L<User::Identity::Collection/"Maintaining roles">
+Inherited, see L<User::Identity::Collection/"Maintaining roles">
-=item $obj-E<gt>B<renameRole>(ROLE|OLDNAME, NEWNAME)
+=item $obj-E<gt>B<renameRole>( <ROLE|OLDNAME>, NEWNAME )
-See L<User::Identity::Collection/"Maintaining roles">
+Inherited, see L<User::Identity::Collection/"Maintaining roles">
=item $obj-E<gt>B<sorted>()
-See L<User::Identity::Collection/"Maintaining roles">
+Inherited, see L<User::Identity::Collection/"Maintaining roles">
=back
=head2 Searching
-See L<documentation in the base class|User::Identity::Collection::Emails/"Searching">.
+Extends L<"Searching" in User::Identity::Collection::Emails|User::Identity::Collection::Emails/"Searching">.
=over 4
=item $obj-E<gt>B<find>(NAME|CODE|undef)
-See L<User::Identity::Collection/"Searching">
+Inherited, see L<User::Identity::Collection/"Searching">
=back
@@ -179,11 +179,11 @@ See L<User::Identity::Collection/"Searching">
=over 4
-=item $obj-E<gt>B<addAddress>(STRING|ADDRESS|OPTIONS)
+=item $obj-E<gt>B<addAddress>(STRING|$address|%options)
Add one e-mail address to the list which is maintained in the group. This
is a wrapper around L<addRole()|User::Identity::Collection/"Maintaining roles"> adding flexibility on how addresses
-are specified. An ADDRESS can be anything which is acceptable for
+are specified. An $address can be anything which is acceptable for
L<Mail::Message::Field::Address::coerce()|Mail::Message::Field::Address/"Constructors"> or a list of options which
will create such an object.
@@ -264,12 +264,12 @@ cannot add objects of a different $type.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Field::Address;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Identity';
@@ -30,22 +30,22 @@ Many header fields can contain e-mail addresses. Each e-mail address
can be represented by an object of this class. These objects will
handle interpretation and character set encoding and decoding for you.
-See L<documentation in the base class|Mail::Identity/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Identity|Mail::Identity/"DESCRIPTION">.
=head1 OVERLOADED
=over 4
-=item overload: B<boolean>()
+=item overload: B<boolean>
The object used as boolean will always return C<true>
-=item overload: B<string comparison>()
+=item overload: B<string $comparison>
Two address objects are the same when their email addresses are the
same.
-=item overload: B<stringification>()
+=item overload: B<stringification>
When the object is used in string context, it will return the encoded
representation of the e-mail address, just like L<string()|Mail::Message::Field::Address/"Access to the content"> does.
@@ -54,31 +54,31 @@ representation of the e-mail address, just like L<string()|Mail::Message::Field:
=head1 METHODS
-See L<documentation in the base class|Mail::Identity/"METHODS">.
+Extends L<"METHODS" in Mail::Identity|Mail::Identity/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Identity/"Constructors">.
+Extends L<"Constructors" in Mail::Identity|Mail::Identity/"Constructors">.
=over 4
-=item $obj-E<gt>B<coerce>(STRING|OBJECT, OPTIONS)
+=item $obj-E<gt>B<coerce>( <STRING|$object>, %options )
-Try to coerce the OBJECT into a C<Mail::Message::Field::Address>.
+Try to coerce the $object into a C<Mail::Message::Field::Address>.
In case of a STRING, it is interpreted as an email address.
-The OPTIONS are passed to the object creation, and overrule the values
-found in the OBJECT. The result may be C<undef> or a newly created
-object. If the OBJECT is already of the correct type, it is returned
+The %options are passed to the object creation, and overrule the values
+found in the $object. The result may be C<undef> or a newly created
+object. If the $object is already of the correct type, it is returned
unmodified.
-The OBJECT may currently be a L<Mail::Address|Mail::Address>, a L<Mail::Identity|Mail::Identity>, or
+The $object may currently be a L<Mail::Address|Mail::Address>, a L<Mail::Identity|Mail::Identity>, or
a L<User::Identity|User::Identity>. In case of the latter, one of the user's addresses
is chosen at random.
-=item Mail::Message::Field::Address-E<gt>B<new>([NAME], OPTIONS)
+=item Mail::Message::Field::Address-E<gt>B<new>( [NAME], OPTIONS )
-See L<Mail::Identity/"Constructors">
+Inherited, see L<Mail::Identity/"Constructors">
=item $obj-E<gt>B<parse>(STRING)
@@ -91,95 +91,95 @@ one is taken at random.
=head2 Attributes
-See L<documentation in the base class|Mail::Identity/"Attributes">.
+Extends L<"Attributes" in Mail::Identity|Mail::Identity/"Attributes">.
=over 4
=item $obj-E<gt>B<address>()
-See L<Mail::Identity/"Attributes">
+Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<charset>()
-See L<Mail::Identity/"Attributes">
+Inherited, see L<Mail::Identity/"Attributes">
-=item $obj-E<gt>B<comment>([STRING])
+=item $obj-E<gt>B<comment>( [STRING] )
-See L<Mail::Identity/"Attributes">
+Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<description>()
-See L<User::Identity::Item/"Attributes">
+Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<domain>()
-See L<Mail::Identity/"Attributes">
+Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<language>()
-See L<Mail::Identity/"Attributes">
+Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<location>()
-See L<Mail::Identity/"Attributes">
+Inherited, see L<Mail::Identity/"Attributes">
-=item $obj-E<gt>B<name>([NEWNAME])
+=item $obj-E<gt>B<name>( [NEWNAME] )
-See L<User::Identity::Item/"Attributes">
+Inherited, see L<User::Identity::Item/"Attributes">
=item $obj-E<gt>B<organization>()
-See L<Mail::Identity/"Attributes">
+Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<phrase>()
-See L<Mail::Identity/"Attributes">
+Inherited, see L<Mail::Identity/"Attributes">
=item $obj-E<gt>B<username>()
-See L<Mail::Identity/"Attributes">
+Inherited, see L<Mail::Identity/"Attributes">
=back
=head2 Collections
-See L<documentation in the base class|Mail::Identity/"Collections">.
+Extends L<"Collections" in Mail::Identity|Mail::Identity/"Collections">.
=over 4
=item $obj-E<gt>B<add>(COLLECTION, ROLE)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<addCollection>(OBJECT | ([TYPE], OPTIONS))
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<collection>(NAME)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<find>(COLLECTION, ROLE)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
-=item $obj-E<gt>B<parent>([PARENT])
+=item $obj-E<gt>B<parent>( [PARENT] )
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<removeCollection>(OBJECT|NAME)
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<type>()
=item Mail::Message::Field::Address-E<gt>B<type>()
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=item $obj-E<gt>B<user>()
-See L<User::Identity::Item/"Collections">
+Inherited, see L<User::Identity::Item/"Collections">
=back
@@ -253,12 +253,12 @@ The collection with $name does not exist and can not be created.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Field::Addresses;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Field::Structured';
@@ -47,57 +47,57 @@ messages.
When you try to create constructs which are not allowed for a certain
kind of field, you will be warned.
-See L<documentation in the base class|Mail::Message::Field::Structured/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Field::Structured/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<0+>()
+=item overload: B<0+>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<<=>>()
+=item overload: B<<=>>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<stringification>()
+=item overload: B<stringification>
-See L<Mail::Message::Field::Full/"OVERLOADED">
+Inherited, see L<Mail::Message::Field::Full/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Field::Structured/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Field::Structured/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Field/"Constructors">
+Inherited, see L<Mail::Message::Field/"Constructors">
-=item Mail::Message::Field::Addresses-E<gt>B<from>(FIELD, OPTIONS)
+=item Mail::Message::Field::Addresses-E<gt>B<from>($field, %options)
-See L<Mail::Message::Field::Full/"Constructors">
+Inherited, see L<Mail::Message::Field::Full/"Constructors">
=item Mail::Message::Field::Addresses-E<gt>B<new>()
@@ -135,7 +135,7 @@ See L<Mail::Message::Field::Full/"Constructors">
=head2 The field
-See L<documentation in the base class|Mail::Message::Field::Structured/"The field">.
+Extends L<"The field" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"The field">.
=over 4
@@ -143,100 +143,100 @@ See L<documentation in the base class|Mail::Message::Field::Structured/"The fiel
=item Mail::Message::Field::Addresses-E<gt>B<isStructured>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<length>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<string>([WRAP])
+=item $obj-E<gt>B<string>( [$wrap] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<toDisclose>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=back
=head2 Access to the name
-See L<documentation in the base class|Mail::Message::Field::Structured/"Access to the name">.
+Extends L<"Access to the name" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Access to the name">.
=over 4
=item $obj-E<gt>B<Name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=item $obj-E<gt>B<name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
-=item $obj-E<gt>B<wellformedName>([STRING])
+=item $obj-E<gt>B<wellformedName>( [STRING] )
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=back
=head2 Access to the body
-See L<documentation in the base class|Mail::Message::Field::Structured/"Access to the body">.
+Extends L<"Access to the body" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Access to the body">.
=over 4
=item $obj-E<gt>B<body>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<decodedBody>(OPTIONS)
+=item $obj-E<gt>B<decodedBody>(%options)
-See L<Mail::Message::Field::Full/"Access to the body">
+Inherited, see L<Mail::Message::Field::Full/"Access to the body">
=item $obj-E<gt>B<folded>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<foldedBody>([BODY])
+=item $obj-E<gt>B<foldedBody>( [$body] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<stripCFWS>([STRING])
+=item $obj-E<gt>B<stripCFWS>( [STRING] )
-=item Mail::Message::Field::Addresses-E<gt>B<stripCFWS>([STRING])
+=item Mail::Message::Field::Addresses-E<gt>B<stripCFWS>( [STRING] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<unfoldedBody>([BODY, [WRAP]])
+=item $obj-E<gt>B<unfoldedBody>( [$body, [$wrap]] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
=back
=head2 Access to the content
-See L<documentation in the base class|Mail::Message::Field::Structured/"Access to the content">.
+Extends L<"Access to the content" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Access to the content">.
=over 4
-=item $obj-E<gt>B<addAddress>([ADDRESS], OPTIONS)
+=item $obj-E<gt>B<addAddress>( [$address], %options )
-Add an ADDRESS to the field. The addresses are organized in groups. If no
+Add an $address to the field. The addresses are organized in groups. If no
group is specified, the default group is taken to store the address in. If
-no ADDRESS is specified, the option must be sufficient to create a
-L<Mail::Message::Field::Address|Mail::Message::Field::Address> from. See the OPTIONS of
+no $address is specified, the option must be sufficient to create a
+L<Mail::Message::Field::Address|Mail::Message::Field::Address> from. See the %options of
L<Mail::Message::Field::Address::new()|Mail::Identity/"Constructors">.
-Option--Default
@@ -252,11 +252,11 @@ L<Mail::Message::Field::Address::new()|Mail::Identity/"Constructors">.
Attributes are not supported for address fields.
-=item $obj-E<gt>B<addGroup>(GROUP|OPTIONS)
+=item $obj-E<gt>B<addGroup>($group|%options)
-Add a group of addresses to this field. A GROUP can be specified, which
+Add a group of addresses to this field. A $group can be specified, which
is a L<Mail::Message::Field::AddrGroup|Mail::Message::Field::AddrGroup> object, or one is created for you
-using the OPTIONS. The group is returned.
+using the %options. The group is returned.
-Option--Default
name ''
@@ -279,40 +279,40 @@ example:
=item $obj-E<gt>B<attrPairs>()
-See L<Mail::Message::Field::Structured/"Access to the content">
+Inherited, see L<Mail::Message::Field::Structured/"Access to the content">
-=item $obj-E<gt>B<attribute>(OBJECT|(STRING, OPTIONS)|(NAME,VALUE,OPTIONS))
+=item $obj-E<gt>B<attribute>( $object|<STRING, %options>|<$name,$value,%options> )
-See L<Mail::Message::Field::Structured/"Access to the content">
+Inherited, see L<Mail::Message::Field::Structured/"Access to the content">
=item $obj-E<gt>B<attributes>()
-See L<Mail::Message::Field::Structured/"Access to the content">
+Inherited, see L<Mail::Message::Field::Structured/"Access to the content">
=item $obj-E<gt>B<beautify>()
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
-=item $obj-E<gt>B<comment>([STRING])
+=item $obj-E<gt>B<comment>( [STRING] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<createComment>(STRING, OPTIONS)
+=item $obj-E<gt>B<createComment>(STRING, %options)
-=item Mail::Message::Field::Addresses-E<gt>B<createComment>(STRING, OPTIONS)
+=item Mail::Message::Field::Addresses-E<gt>B<createComment>(STRING, %options)
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
-=item $obj-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item $obj-E<gt>B<createPhrase>(STRING, %options)
-=item Mail::Message::Field::Addresses-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item Mail::Message::Field::Addresses-E<gt>B<createPhrase>(STRING, %options)
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
-=item $obj-E<gt>B<group>(NAME)
+=item $obj-E<gt>B<group>($name)
-Returns the group of addresses with the specified NAME, or C<undef>
-if it does not exist. If NAME is C<undef>, then the default groep
+Returns the group of addresses with the specified $name, or C<undef>
+if it does not exist. If $name is C<undef>, then the default groep
is returned.
=item $obj-E<gt>B<groupNames>()
@@ -326,23 +326,23 @@ element is a L<Mail::Message::Field::AddrGroup|Mail::Message::Field::AddrGroup>
=item $obj-E<gt>B<study>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<toDate>([TIME])
+=item $obj-E<gt>B<toDate>( [$time] )
-=item Mail::Message::Field::Addresses-E<gt>B<toDate>([TIME])
+=item Mail::Message::Field::Addresses-E<gt>B<toDate>( [$time] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<toInt>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Message::Field::Structured/"Other methods">.
+Extends L<"Other methods" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Other methods">.
=over 4
@@ -350,61 +350,61 @@ See L<documentation in the base class|Mail::Message::Field::Structured/"Other me
=item Mail::Message::Field::Addresses-E<gt>B<dateToTimestamp>(STRING)
-See L<Mail::Message::Field/"Other methods">
+Inherited, see L<Mail::Message::Field/"Other methods">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Field::Structured/"Internals">.
+Extends L<"Internals" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Internals">.
=over 4
-=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))
+=item $obj-E<gt>B<consume>( $line | <$name,<$body|$objects>> )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<decode>(STRING, OPTIONS)
+=item $obj-E<gt>B<decode>(STRING, %options)
-=item Mail::Message::Field::Addresses-E<gt>B<decode>(STRING, OPTIONS)
+=item Mail::Message::Field::Addresses-E<gt>B<decode>(STRING, %options)
-See L<Mail::Message::Field::Full/"Internals">
+Inherited, see L<Mail::Message::Field::Full/"Internals">
-=item $obj-E<gt>B<defaultWrapLength>([LENGTH])
+=item $obj-E<gt>B<defaultWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<encode>(STRING, OPTIONS)
+=item $obj-E<gt>B<encode>(STRING, %options)
-See L<Mail::Message::Field::Full/"Internals">
+Inherited, see L<Mail::Message::Field::Full/"Internals">
-=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item $obj-E<gt>B<fold>( $name, $body, [$maxchars] )
-=item Mail::Message::Field::Addresses-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item Mail::Message::Field::Addresses-E<gt>B<fold>( $name, $body, [$maxchars] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<setWrapLength>([LENGTH])
+=item $obj-E<gt>B<setWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|OBJECTS)
+=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|$objects)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=item $obj-E<gt>B<unfold>(STRING)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=back
=head2 Parsing
-See L<documentation in the base class|Mail::Message::Field::Structured/"Parsing">.
+Extends L<"Parsing" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Parsing">.
=over 4
-=item $obj-E<gt>B<consumeAddress>(STRING, OPTIONS)
+=item $obj-E<gt>B<consumeAddress>(STRING, %options)
Try to destilate address information from the STRING. Returned are
an address B<object> and the left-over string. If no address was found,
@@ -414,7 +414,7 @@ the first returned value is C<undef>.
=item Mail::Message::Field::Addresses-E<gt>B<consumeComment>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumeDomain>(STRING)
@@ -423,105 +423,105 @@ domain string as found (or C<undef>) and the rest of the string.
=item $obj-E<gt>B<consumeDotAtom>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumePhrase>(STRING)
=item Mail::Message::Field::Addresses-E<gt>B<consumePhrase>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
-=item $obj-E<gt>B<datum>([VALUE])
+=item $obj-E<gt>B<datum>( [$value] )
-See L<Mail::Message::Field::Structured/"Parsing">
+Inherited, see L<Mail::Message::Field::Structured/"Parsing">
=item $obj-E<gt>B<parse>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<produceBody>()
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Field::Structured/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Field::Addresses-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Field::Addresses-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Field::Addresses-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Field::Addresses-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Field::Addresses-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Field::Addresses-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Field::Structured/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Field::Structured/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"DETAILS">.
=head1 DIAGNOSTICS
@@ -573,12 +573,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Field::Attribute;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
use 5.007003;
@@ -40,7 +40,7 @@ sub init($$)
my ($attr, $value, $cont) = @$args{ qw/attr value use_continuations/ };
- my $name = ($attr =~ m/^(.*?)(?:\*\d+)?\*?\=/ ? $1 : $attr);
+ my $name = ($attr =~ m/^(.*?)(?:\*\d+)?\*?\s*\=\s*/ ? $1 : $attr);
$self->log(WARNING => "Illegal character in parameter name '$name'.")
if $name !~ m/^[!#-'*+\-.0-9A-Z^-~]+$/;
@@ -175,10 +175,10 @@ sub decode()
my $value = '';
foreach my $cont ( @{$self->{MMFF_cont}} )
- { unless(defined $cont)
- { $value .= "[continuation missing]";
- next;
- }
+ { unless(defined $cont)
+ { $value .= "[continuation missing]";
+ next;
+ }
(my $name, local $_) = split /\=/, $cont, 2;
@@ -33,18 +33,18 @@ becomes more and more in demand.
A C<Mail::Message::Field::Attribute> can be found in any structured
L<Mail::Message::Field::Full|Mail::Message::Field::Full> header field.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 OVERLOADED
=over 4
-=item overload: B<comparison>()
+=item overload: B<comparison>
When the second argument is a field, then both attribute name (case-sensitive)
and the decoded value must be the same. Otherwise, the value is compared.
-=item overload: B<stringification>()
+=item overload: B<stringification>
Returns the decoded content of the attribute.
@@ -52,24 +52,24 @@ Returns the decoded content of the attribute.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Message::Field::Attribute-E<gt>B<new>((NAME, [VALUE] | STRING), OPTIONS)
+=item Mail::Message::Field::Attribute-E<gt>B<new>( <$name, [$value] | STRING>, %options )
-Create a new attribute NAME with the optional VALUE. If no VALUE is specified,
+Create a new attribute $name with the optional $value. If no $value is specified,
the first argument of this method is inspected for an equals sign C<'='>.
If that character is present, the argument is taken as STRING, containing
a preformatted attribute which is processed. Otherwise, the argument is
-taken as name without VALUE: set the value later with value().
+taken as name without $value: set the value later with value().
-Whether encoding takes place depends on the OPTIONS and the existence
-of non-ascii characters in the VALUE. The NAME can only contain ascii
+Whether encoding takes place depends on the %options and the existence
+of non-ascii characters in the $value. The $name can only contain ascii
characters, hence is never encoded.
To speed things up, attributes are not derived from the L<Mail::Reporter|Mail::Reporter>
@@ -86,7 +86,7 @@ base-class.
=item charset => STRING
-The VALUE is translated from utf-8 (Perl internal) to this character set,
+The $value is translated from utf-8 (Perl internal) to this character set,
and the resulting string is encoded if required. C<us-ascii> is the normal
encoding for e-mail. Valid character sets can be found with
Encode::encodings(':all').
@@ -117,10 +117,10 @@ example:
my $fattr = 'Mail::Message::Field::Attribute'; # abbrev
my $fn = $fattr->new
- ( filename => "Re\xC7u"
- , charset => 'iso-8859-15'
- , language => 'nl-BE'
- );
+ ( filename => "Re\xC7u"
+ , charset => 'iso-8859-15'
+ , language => 'nl-BE'
+ );
print $fn;
# --> filename*=iso-8859-15'nl-BE'Re%C7u
@@ -128,75 +128,75 @@ example:
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Field::Attribute-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Field::Attribute-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Field::Attribute-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Field::Attribute-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Field::Attribute-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Field::Attribute-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -238,7 +238,7 @@ Returns the parameter as reference to an array of lines. When only one line
is returned, it may be short enough to fit on the same line with other
components of the header field.
-=item $obj-E<gt>B<value>([STRING])
+=item $obj-E<gt>B<value>( [STRING] )
Returns the value of this parameter, optionally after setting it first.
@@ -261,7 +261,7 @@ returned and may be utf-8 encoded or a plain string.
=over 4
-=item $obj-E<gt>B<mergeComponent>(ATTRIBUTE)
+=item $obj-E<gt>B<mergeComponent>($attribute)
Merge the components from the specified attribute into this attribute. This
is needed when components of the same attribute are created separately.
@@ -293,12 +293,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,11 +7,11 @@ use strict;
package Mail::Message::Field::Date;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Field::Structured';
-use POSIX qw/mktime/;
+use POSIX qw/mktime tzset/;
my $dayname = qr/Mon|Tue|Wed|Thu|Fri|Sat|Sun/;
@@ -27,18 +27,19 @@ sub parse($)
my ($dn, $d, $mon, $y, $h, $min, $s, $z) = $string =~
m/ ^ \s*
(?: ($dayname) \s* \, \s* )?
- ( 0?[1-9] | [12][0-9] | 3[01] ) \s* # day
- \s+ ( [A-Z][a-z][a-z] ) \s+ # month
- ( 19[0-9][0-9] | 2[0-9]{3} ) \s+ # year
- ( [0-1]?[0-9] | 2[0-3] ) \s* # hour
- [:.] ( [0-5][0-9] ) \s* # minute
- (?: [:.] ( [0-5][0-9] ) )? \s+ # second
- ( [+-][0-9]{4} | [A-Z]+ )? # zone
+ ( 0?[1-9] | [12][0-9] | 3[01] ) \s* # day
+ \s+ ( [A-Z][a-z][a-z]|[0-9][0-9] ) \s+ # month
+ ( 19[0-9][0-9] | 2[0-9]{3} ) \s+ # year
+ ( [0-1]?[0-9] | 2[0-3] ) \s* # hour
+ [:.] ( [0-5][0-9] ) \s* # minute
+ (?: [:.] ( [0-5][0-9] ) )? \s+ # second
+ ( [+-][0-9]{4} | [A-Z]+ )? # zone
\s* /x
or return undef;
defined $dn or $dn = '';
$dn =~ s/\s+//g;
+ $mon = $months[$mon-1] if $mon =~ /[0-9]+/; # Broken mail clients
$y += 2000 if $y < 50;
$y += 1900 if $y < 100;
@@ -71,9 +72,15 @@ sub time()
my ($d, $mon, $y, $h, $min, $s, $z)
= $date =~ m/^ (?:\w\w\w\,\s+)? (\d\d)\s+(\w+)\s+(\d\d\d\d)
\s+ (\d\d)\:(\d\d)\:(\d\d) \s+ ([+-]\d\d\d\d)? \s*$ /x;
- my $timestamp = mktime $s, $min, $h, $d, $monthnr{$mon}-1, $y-1900
- , 0, 0, -1;
- $timestamp += ($1 eq '-' ? -1 : 1) * ($2*3600 + $3*60)
+
+ my $oldtz = $ENV{TZ};
+ $ENV{TZ} = 'UTC';
+ tzset;
+ my $timestamp = mktime $s, $min, $h, $d, $monthnr{$mon}-1, $y-1900;
+ if(defined $oldtz) { $ENV{TZ} = $oldtz } else { delete $ENV{TZ} }
+ tzset;
+
+ $timestamp += ($1 eq '-' ? 1 : -1) * ($2*3600 + $3*60)
if $z =~ m/^([+-])(\d\d)(\d\d)$/;
$timestamp;
}
@@ -25,59 +25,59 @@ a small subset of timezone abbreviations are permitted.
The studied date field will reformat the content into a standard
form.
-See L<documentation in the base class|Mail::Message::Field::Structured/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Field::Structured/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<0+>()
+=item overload: B<0+>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<<=>>()
+=item overload: B<<=>>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<stringification>()
+=item overload: B<stringification>
-See L<Mail::Message::Field::Full/"OVERLOADED">
+Inherited, see L<Mail::Message::Field::Full/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Field::Structured/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Field::Structured/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Field/"Constructors">
+Inherited, see L<Mail::Message::Field/"Constructors">
-=item Mail::Message::Field::Date-E<gt>B<from>(FIELD, OPTIONS)
+=item Mail::Message::Field::Date-E<gt>B<from>($field, %options)
-See L<Mail::Message::Field::Full/"Constructors">
+Inherited, see L<Mail::Message::Field::Full/"Constructors">
-=item Mail::Message::Field::Date-E<gt>B<new>(DATA)
+=item Mail::Message::Field::Date-E<gt>B<new>($data)
-Option --Defined in --Default
attributes Mail::Message::Field::Structured <ignored>
@@ -118,7 +118,7 @@ example:
=head2 The field
-See L<documentation in the base class|Mail::Message::Field::Structured/"The field">.
+Extends L<"The field" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"The field">.
=over 4
@@ -126,91 +126,91 @@ See L<documentation in the base class|Mail::Message::Field::Structured/"The fiel
=item Mail::Message::Field::Date-E<gt>B<isStructured>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<length>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<string>([WRAP])
+=item $obj-E<gt>B<string>( [$wrap] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<toDisclose>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=back
=head2 Access to the name
-See L<documentation in the base class|Mail::Message::Field::Structured/"Access to the name">.
+Extends L<"Access to the name" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Access to the name">.
=over 4
=item $obj-E<gt>B<Name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=item $obj-E<gt>B<name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
-=item $obj-E<gt>B<wellformedName>([STRING])
+=item $obj-E<gt>B<wellformedName>( [STRING] )
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=back
=head2 Access to the body
-See L<documentation in the base class|Mail::Message::Field::Structured/"Access to the body">.
+Extends L<"Access to the body" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Access to the body">.
=over 4
=item $obj-E<gt>B<body>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<decodedBody>(OPTIONS)
+=item $obj-E<gt>B<decodedBody>(%options)
-See L<Mail::Message::Field::Full/"Access to the body">
+Inherited, see L<Mail::Message::Field::Full/"Access to the body">
=item $obj-E<gt>B<folded>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<foldedBody>([BODY])
+=item $obj-E<gt>B<foldedBody>( [$body] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<stripCFWS>([STRING])
+=item $obj-E<gt>B<stripCFWS>( [STRING] )
-=item Mail::Message::Field::Date-E<gt>B<stripCFWS>([STRING])
+=item Mail::Message::Field::Date-E<gt>B<stripCFWS>( [STRING] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<unfoldedBody>([BODY, [WRAP]])
+=item $obj-E<gt>B<unfoldedBody>( [$body, [$wrap]] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
=back
=head2 Access to the content
-See L<documentation in the base class|Mail::Message::Field::Structured/"Access to the content">.
+Extends L<"Access to the content" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Access to the content">.
=over 4
@@ -220,63 +220,63 @@ Attributes are not supported for date fields.
=item $obj-E<gt>B<addresses>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<attrPairs>()
-See L<Mail::Message::Field::Structured/"Access to the content">
+Inherited, see L<Mail::Message::Field::Structured/"Access to the content">
-=item $obj-E<gt>B<attribute>(OBJECT|(STRING, OPTIONS)|(NAME,VALUE,OPTIONS))
+=item $obj-E<gt>B<attribute>( $object|<STRING, %options>|<$name,$value,%options> )
-See L<Mail::Message::Field::Structured/"Access to the content">
+Inherited, see L<Mail::Message::Field::Structured/"Access to the content">
=item $obj-E<gt>B<attributes>()
-See L<Mail::Message::Field::Structured/"Access to the content">
+Inherited, see L<Mail::Message::Field::Structured/"Access to the content">
=item $obj-E<gt>B<beautify>()
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
-=item $obj-E<gt>B<comment>([STRING])
+=item $obj-E<gt>B<comment>( [STRING] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<createComment>(STRING, OPTIONS)
+=item $obj-E<gt>B<createComment>(STRING, %options)
-=item Mail::Message::Field::Date-E<gt>B<createComment>(STRING, OPTIONS)
+=item Mail::Message::Field::Date-E<gt>B<createComment>(STRING, %options)
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
-=item $obj-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item $obj-E<gt>B<createPhrase>(STRING, %options)
-=item Mail::Message::Field::Date-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item Mail::Message::Field::Date-E<gt>B<createPhrase>(STRING, %options)
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
=item $obj-E<gt>B<study>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<time>()
Convert date into a timestamp, as produced with POSIX::time().
-=item $obj-E<gt>B<toDate>([TIME])
+=item $obj-E<gt>B<toDate>( [$time] )
-=item Mail::Message::Field::Date-E<gt>B<toDate>([TIME])
+=item Mail::Message::Field::Date-E<gt>B<toDate>( [$time] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<toInt>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Message::Field::Structured/"Other methods">.
+Extends L<"Other methods" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Other methods">.
=over 4
@@ -284,57 +284,57 @@ See L<documentation in the base class|Mail::Message::Field::Structured/"Other me
=item Mail::Message::Field::Date-E<gt>B<dateToTimestamp>(STRING)
-See L<Mail::Message::Field/"Other methods">
+Inherited, see L<Mail::Message::Field/"Other methods">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Field::Structured/"Internals">.
+Extends L<"Internals" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Internals">.
=over 4
-=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))
+=item $obj-E<gt>B<consume>( $line | <$name,<$body|$objects>> )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<decode>(STRING, OPTIONS)
+=item $obj-E<gt>B<decode>(STRING, %options)
-=item Mail::Message::Field::Date-E<gt>B<decode>(STRING, OPTIONS)
+=item Mail::Message::Field::Date-E<gt>B<decode>(STRING, %options)
-See L<Mail::Message::Field::Full/"Internals">
+Inherited, see L<Mail::Message::Field::Full/"Internals">
-=item $obj-E<gt>B<defaultWrapLength>([LENGTH])
+=item $obj-E<gt>B<defaultWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<encode>(STRING, OPTIONS)
+=item $obj-E<gt>B<encode>(STRING, %options)
-See L<Mail::Message::Field::Full/"Internals">
+Inherited, see L<Mail::Message::Field::Full/"Internals">
-=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item $obj-E<gt>B<fold>( $name, $body, [$maxchars] )
-=item Mail::Message::Field::Date-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item Mail::Message::Field::Date-E<gt>B<fold>( $name, $body, [$maxchars] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<setWrapLength>([LENGTH])
+=item $obj-E<gt>B<setWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|OBJECTS)
+=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|$objects)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=item $obj-E<gt>B<unfold>(STRING)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=back
=head2 Parsing
-See L<documentation in the base class|Mail::Message::Field::Structured/"Parsing">.
+Extends L<"Parsing" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Parsing">.
=over 4
@@ -342,109 +342,109 @@ See L<documentation in the base class|Mail::Message::Field::Structured/"Parsing"
=item Mail::Message::Field::Date-E<gt>B<consumeComment>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumeDotAtom>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumePhrase>(STRING)
=item Mail::Message::Field::Date-E<gt>B<consumePhrase>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
-=item $obj-E<gt>B<datum>([VALUE])
+=item $obj-E<gt>B<datum>( [$value] )
-See L<Mail::Message::Field::Structured/"Parsing">
+Inherited, see L<Mail::Message::Field::Structured/"Parsing">
=item $obj-E<gt>B<parse>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<produceBody>()
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Field::Structured/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Field::Date-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Field::Date-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Field::Date-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Field::Date-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Field::Date-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Field::Date-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Field::Structured/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Field::Structured/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"DETAILS">.
=head1 DIAGNOSTICS
@@ -496,12 +496,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Field::Fast;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Field';
@@ -21,51 +21,51 @@ The data is stored in an array, and some hacks are made to speeds
things up. Be gentle with me, and consider that each message contains
many of these lines, so speed is very important here.
-See L<documentation in the base class|Mail::Message::Field/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Field|Mail::Message::Field/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Field/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Field|Mail::Message::Field/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<0+>()
+=item overload: B<0+>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<<=>>()
+=item overload: B<<=>>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Field/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Field|Mail::Message::Field/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Field/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Field|Mail::Message::Field/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Field/"Constructors">
+Inherited, see L<Mail::Message::Field/"Constructors">
-=item Mail::Message::Field::Fast-E<gt>B<new>(DATA)
+=item Mail::Message::Field::Fast-E<gt>B<new>($data)
The constructor of this object does not follow the usual practise within
the Mail::Box suite: it does not use the constructor
@@ -152,7 +152,7 @@ C<new> accepts.
=head2 The field
-See L<documentation in the base class|Mail::Message::Field/"The field">.
+Extends L<"The field" in Mail::Message::Field|Mail::Message::Field/"The field">.
=over 4
@@ -160,125 +160,125 @@ See L<documentation in the base class|Mail::Message::Field/"The field">.
=item Mail::Message::Field::Fast-E<gt>B<isStructured>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<length>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<string>([WRAP])
+=item $obj-E<gt>B<string>( [$wrap] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<toDisclose>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=back
=head2 Access to the name
-See L<documentation in the base class|Mail::Message::Field/"Access to the name">.
+Extends L<"Access to the name" in Mail::Message::Field|Mail::Message::Field/"Access to the name">.
=over 4
=item $obj-E<gt>B<Name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=item $obj-E<gt>B<name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
-=item $obj-E<gt>B<wellformedName>([STRING])
+=item $obj-E<gt>B<wellformedName>( [STRING] )
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=back
=head2 Access to the body
-See L<documentation in the base class|Mail::Message::Field/"Access to the body">.
+Extends L<"Access to the body" in Mail::Message::Field|Mail::Message::Field/"Access to the body">.
=over 4
=item $obj-E<gt>B<body>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
=item $obj-E<gt>B<folded>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<foldedBody>([BODY])
+=item $obj-E<gt>B<foldedBody>( [$body] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<stripCFWS>([STRING])
+=item $obj-E<gt>B<stripCFWS>( [STRING] )
-=item Mail::Message::Field::Fast-E<gt>B<stripCFWS>([STRING])
+=item Mail::Message::Field::Fast-E<gt>B<stripCFWS>( [STRING] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<unfoldedBody>([BODY, [WRAP]])
+=item $obj-E<gt>B<unfoldedBody>( [$body, [$wrap]] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
=back
=head2 Access to the content
-See L<documentation in the base class|Mail::Message::Field/"Access to the content">.
+Extends L<"Access to the content" in Mail::Message::Field|Mail::Message::Field/"Access to the content">.
=over 4
=item $obj-E<gt>B<addresses>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<attribute>(NAME [, VALUE])
+=item $obj-E<gt>B<attribute>( $name, [$value] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<attributes>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<comment>([STRING])
+=item $obj-E<gt>B<comment>( [STRING] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<study>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<toDate>([TIME])
+=item $obj-E<gt>B<toDate>( [$time] )
-=item Mail::Message::Field::Fast-E<gt>B<toDate>([TIME])
+=item Mail::Message::Field::Fast-E<gt>B<toDate>( [$time] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<toInt>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Message::Field/"Other methods">.
+Extends L<"Other methods" in Mail::Message::Field|Mail::Message::Field/"Other methods">.
=over 4
@@ -286,121 +286,121 @@ See L<documentation in the base class|Mail::Message::Field/"Other methods">.
=item Mail::Message::Field::Fast-E<gt>B<dateToTimestamp>(STRING)
-See L<Mail::Message::Field/"Other methods">
+Inherited, see L<Mail::Message::Field/"Other methods">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Field/"Internals">.
+Extends L<"Internals" in Mail::Message::Field|Mail::Message::Field/"Internals">.
=over 4
-=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))
+=item $obj-E<gt>B<consume>( $line | <$name,<$body|$objects>> )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<defaultWrapLength>([LENGTH])
+=item $obj-E<gt>B<defaultWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item $obj-E<gt>B<fold>( $name, $body, [$maxchars] )
-=item Mail::Message::Field::Fast-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item Mail::Message::Field::Fast-E<gt>B<fold>( $name, $body, [$maxchars] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<setWrapLength>([LENGTH])
+=item $obj-E<gt>B<setWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|OBJECTS)
+=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|$objects)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=item $obj-E<gt>B<unfold>(STRING)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Field/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Field|Mail::Message::Field/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Field::Fast-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Field::Fast-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Field::Fast-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Field::Fast-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Field::Fast-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Field::Fast-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Field/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Field|Mail::Message::Field/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Field/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Field|Mail::Message::Field/"DETAILS">.
=head1 DIAGNOSTICS
@@ -430,12 +430,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Field::Flex;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Field';
@@ -20,51 +20,51 @@ extended because it stores its data in a hash and the constructor
price in performance. L<Mail::Message::Field::Fast|Mail::Message::Field::Fast> is faster (as the
name predicts).
-See L<documentation in the base class|Mail::Message::Field/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Field|Mail::Message::Field/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Field/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Field|Mail::Message::Field/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<0+>()
+=item overload: B<0+>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<<=>>()
+=item overload: B<<=>>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Field/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Field|Mail::Message::Field/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Field/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Field|Mail::Message::Field/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Field/"Constructors">
+Inherited, see L<Mail::Message::Field/"Constructors">
-=item Mail::Message::Field::Flex-E<gt>B<new>(DATA)
+=item Mail::Message::Field::Flex-E<gt>B<new>($data)
If you stick to this flexible class of header fields, you have a bit
more facilities than with L<Mail::Message::Field::Fast|Mail::Message::Field::Fast>. Amongst it, you
@@ -117,7 +117,7 @@ A pre-formatted list of attributes.
=head2 The field
-See L<documentation in the base class|Mail::Message::Field/"The field">.
+Extends L<"The field" in Mail::Message::Field|Mail::Message::Field/"The field">.
=over 4
@@ -125,125 +125,125 @@ See L<documentation in the base class|Mail::Message::Field/"The field">.
=item Mail::Message::Field::Flex-E<gt>B<isStructured>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<length>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<string>([WRAP])
+=item $obj-E<gt>B<string>( [$wrap] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<toDisclose>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=back
=head2 Access to the name
-See L<documentation in the base class|Mail::Message::Field/"Access to the name">.
+Extends L<"Access to the name" in Mail::Message::Field|Mail::Message::Field/"Access to the name">.
=over 4
=item $obj-E<gt>B<Name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=item $obj-E<gt>B<name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
-=item $obj-E<gt>B<wellformedName>([STRING])
+=item $obj-E<gt>B<wellformedName>( [STRING] )
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=back
=head2 Access to the body
-See L<documentation in the base class|Mail::Message::Field/"Access to the body">.
+Extends L<"Access to the body" in Mail::Message::Field|Mail::Message::Field/"Access to the body">.
=over 4
=item $obj-E<gt>B<body>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
=item $obj-E<gt>B<folded>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<foldedBody>([BODY])
+=item $obj-E<gt>B<foldedBody>( [$body] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<stripCFWS>([STRING])
+=item $obj-E<gt>B<stripCFWS>( [STRING] )
-=item Mail::Message::Field::Flex-E<gt>B<stripCFWS>([STRING])
+=item Mail::Message::Field::Flex-E<gt>B<stripCFWS>( [STRING] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<unfoldedBody>([BODY, [WRAP]])
+=item $obj-E<gt>B<unfoldedBody>( [$body, [$wrap]] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
=back
=head2 Access to the content
-See L<documentation in the base class|Mail::Message::Field/"Access to the content">.
+Extends L<"Access to the content" in Mail::Message::Field|Mail::Message::Field/"Access to the content">.
=over 4
=item $obj-E<gt>B<addresses>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<attribute>(NAME [, VALUE])
+=item $obj-E<gt>B<attribute>( $name, [$value] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<attributes>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<comment>([STRING])
+=item $obj-E<gt>B<comment>( [STRING] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<study>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<toDate>([TIME])
+=item $obj-E<gt>B<toDate>( [$time] )
-=item Mail::Message::Field::Flex-E<gt>B<toDate>([TIME])
+=item Mail::Message::Field::Flex-E<gt>B<toDate>( [$time] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<toInt>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Message::Field/"Other methods">.
+Extends L<"Other methods" in Mail::Message::Field|Mail::Message::Field/"Other methods">.
=over 4
@@ -251,121 +251,121 @@ See L<documentation in the base class|Mail::Message::Field/"Other methods">.
=item Mail::Message::Field::Flex-E<gt>B<dateToTimestamp>(STRING)
-See L<Mail::Message::Field/"Other methods">
+Inherited, see L<Mail::Message::Field/"Other methods">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Field/"Internals">.
+Extends L<"Internals" in Mail::Message::Field|Mail::Message::Field/"Internals">.
=over 4
-=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))
+=item $obj-E<gt>B<consume>( $line | <$name,<$body|$objects>> )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<defaultWrapLength>([LENGTH])
+=item $obj-E<gt>B<defaultWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item $obj-E<gt>B<fold>( $name, $body, [$maxchars] )
-=item Mail::Message::Field::Flex-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item Mail::Message::Field::Flex-E<gt>B<fold>( $name, $body, [$maxchars] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<setWrapLength>([LENGTH])
+=item $obj-E<gt>B<setWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|OBJECTS)
+=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|$objects)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=item $obj-E<gt>B<unfold>(STRING)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Field/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Field|Mail::Message::Field/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Field::Flex-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Field::Flex-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Field::Flex-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Field::Flex-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Field::Flex-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Field::Flex-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Field/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Field|Mail::Message::Field/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Field/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Field|Mail::Message::Field/"DETAILS">.
=head1 DIAGNOSTICS
@@ -395,12 +395,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Field::Full;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Field';
@@ -50,35 +50,35 @@ wrapping from RFC2231. If you do not need the latter two, then the
L<Mail::Message::Field::Fast|Mail::Message::Field::Fast> and L<Mail::Message::Field::Flex|Mail::Message::Field::Flex>
are enough for your application.
-See L<documentation in the base class|Mail::Message::Field/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Field|Mail::Message::Field/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Field/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Field|Mail::Message::Field/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<0+>()
+=item overload: B<0+>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<<=>>()
+=item overload: B<<=>>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<stringification>()
+=item overload: B<stringification>
In string context, the decoded body is returned, as if L<decodedBody()|Mail::Message::Field::Full/"Access to the body">
would have been called.
@@ -87,28 +87,28 @@ would have been called.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Field/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Field|Mail::Message::Field/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Field/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Field|Mail::Message::Field/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Field/"Constructors">
+Inherited, see L<Mail::Message::Field/"Constructors">
-=item Mail::Message::Field::Full-E<gt>B<from>(FIELD, OPTIONS)
+=item Mail::Message::Field::Full-E<gt>B<from>($field, %options)
-Convert any FIELD (a L<Mail::Message::Field|Mail::Message::Field> object) into a new
+Convert any $field (a L<Mail::Message::Field|Mail::Message::Field> object) into a new
L<Mail::Message::Field::Full|Mail::Message::Field::Full> object. This conversion is done the hard
way: the string which is produced by the original object is parsed
again. Usually, the string which is parsed is exactly the line (or lines)
as found in the original input source, which is a good thing because Full
fields are much more carefull with the actual content.
-OPTIONS are passed to the constructor (see L<new()|Mail::Message::Field::Full/"METHODS">). In any case, some
+%options are passed to the constructor (see L<new()|Mail::Message::Field::Full/"METHODS">). In any case, some
extensions of this Full field class is returned. It depends on which
field is created what kind of class we get.
@@ -121,7 +121,7 @@ example:
my $full = $msg->head->study('subject'); # same
my $full = $msg->get('subject'); # same
-=item Mail::Message::Field::Full-E<gt>B<new>(DATA)
+=item Mail::Message::Field::Full-E<gt>B<new>($data)
Creating a new field object the correct way is a lot of work, because
there is so much freedom in the RFCs, but at the same time so many
@@ -201,7 +201,7 @@ example:
=head2 The field
-See L<documentation in the base class|Mail::Message::Field/"The field">.
+Extends L<"The field" in Mail::Message::Field|Mail::Message::Field/"The field">.
=over 4
@@ -209,68 +209,68 @@ See L<documentation in the base class|Mail::Message::Field/"The field">.
=item Mail::Message::Field::Full-E<gt>B<isStructured>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<length>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<string>([WRAP])
+=item $obj-E<gt>B<string>( [$wrap] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<toDisclose>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=back
=head2 Access to the name
-See L<documentation in the base class|Mail::Message::Field/"Access to the name">.
+Extends L<"Access to the name" in Mail::Message::Field|Mail::Message::Field/"Access to the name">.
=over 4
=item $obj-E<gt>B<Name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=item $obj-E<gt>B<name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
-=item $obj-E<gt>B<wellformedName>([STRING])
+=item $obj-E<gt>B<wellformedName>( [STRING] )
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=back
=head2 Access to the body
-See L<documentation in the base class|Mail::Message::Field/"Access to the body">.
+Extends L<"Access to the body" in Mail::Message::Field|Mail::Message::Field/"Access to the body">.
=over 4
=item $obj-E<gt>B<body>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<decodedBody>(OPTIONS)
+=item $obj-E<gt>B<decodedBody>(%options)
Returns the unfolded body of the field, where encodings are resolved. The
-returned line will still contain comments and such. The OPTIONS are passed
+returned line will still contain comments and such. The %options are passed
to the decoder, see L<decode()|Mail::Message::Field::Full/"Internals">.
BE WARNED: if the field is a structured field, the content may change syntax,
@@ -280,41 +280,41 @@ as text, which results in a small difference within comments as well
=item $obj-E<gt>B<folded>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<foldedBody>([BODY])
+=item $obj-E<gt>B<foldedBody>( [$body] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<stripCFWS>([STRING])
+=item $obj-E<gt>B<stripCFWS>( [STRING] )
-=item Mail::Message::Field::Full-E<gt>B<stripCFWS>([STRING])
+=item Mail::Message::Field::Full-E<gt>B<stripCFWS>( [STRING] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<unfoldedBody>([BODY, [WRAP]])
+=item $obj-E<gt>B<unfoldedBody>( [$body, [$wrap]] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
=back
=head2 Access to the content
-See L<documentation in the base class|Mail::Message::Field/"Access to the content">.
+Extends L<"Access to the content" in Mail::Message::Field|Mail::Message::Field/"Access to the content">.
=over 4
=item $obj-E<gt>B<addresses>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<attribute>(NAME [, VALUE])
+=item $obj-E<gt>B<attribute>( $name, [$value] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<attributes>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<beautify>()
@@ -323,13 +323,13 @@ field's body (the format as it was offered to L<parse()|Mail::Message::Field::Fu
next request for the field will have to re-produce the read data clean
and nice. For unstructured bodies, this method doesn't do a thing.
-=item $obj-E<gt>B<comment>([STRING])
+=item $obj-E<gt>B<comment>( [STRING] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<createComment>(STRING, OPTIONS)
+=item $obj-E<gt>B<createComment>(STRING, %options)
-=item Mail::Message::Field::Full-E<gt>B<createComment>(STRING, OPTIONS)
+=item Mail::Message::Field::Full-E<gt>B<createComment>(STRING, %options)
Create a comment to become part in a field. Comments are automatically
included within parenthesis. Matching pairs of parenthesis are
@@ -338,39 +338,39 @@ it is only permitted with an escape (a backslash) in front of them.
These backslashes will be added automatically if needed (don't worry!).
Backslashes will stay, except at the end, where it will be doubled.
-The OPTIONS are C<charset>, C<language>, and C<encoding> as always.
+The %options are C<charset>, C<language>, and C<encoding> as always.
The created comment is returned.
-=item $obj-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item $obj-E<gt>B<createPhrase>(STRING, %options)
-=item Mail::Message::Field::Full-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item Mail::Message::Field::Full-E<gt>B<createPhrase>(STRING, %options)
A phrase is a text which plays a well defined role. This is the main
difference with comments, which have do specified meaning. Some special
characters in the phrase will cause it to be surrounded with double
quotes: do not specify them yourself.
-The OPTIONS are C<charset>, C<language>, and C<encoding>, as always.
+The %options are C<charset>, C<language>, and C<encoding>, as always.
=item $obj-E<gt>B<study>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<toDate>([TIME])
+=item $obj-E<gt>B<toDate>( [$time] )
-=item Mail::Message::Field::Full-E<gt>B<toDate>([TIME])
+=item Mail::Message::Field::Full-E<gt>B<toDate>( [$time] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<toInt>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Message::Field/"Other methods">.
+Extends L<"Other methods" in Mail::Message::Field|Mail::Message::Field/"Other methods">.
=over 4
@@ -378,23 +378,23 @@ See L<documentation in the base class|Mail::Message::Field/"Other methods">.
=item Mail::Message::Field::Full-E<gt>B<dateToTimestamp>(STRING)
-See L<Mail::Message::Field/"Other methods">
+Inherited, see L<Mail::Message::Field/"Other methods">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Field/"Internals">.
+Extends L<"Internals" in Mail::Message::Field|Mail::Message::Field/"Internals">.
=over 4
-=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))
+=item $obj-E<gt>B<consume>( $line | <$name,<$body|$objects>> )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<decode>(STRING, OPTIONS)
+=item $obj-E<gt>B<decode>(STRING, %options)
-=item Mail::Message::Field::Full-E<gt>B<decode>(STRING, OPTIONS)
+=item Mail::Message::Field::Full-E<gt>B<decode>(STRING, %options)
Decode field encoded STRING to an utf8 string. The input STRING is part of
a header field, and as such, may contain encoded words in C<=?...?.?...?=>
@@ -430,11 +430,11 @@ example:
print Mail::Message::Field::Full->decode('=?iso-8859-1?Q?J=F8rgen?=');
# prints JE<0slash>rgen
-=item $obj-E<gt>B<defaultWrapLength>([LENGTH])
+=item $obj-E<gt>B<defaultWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<encode>(STRING, OPTIONS)
+=item $obj-E<gt>B<encode>(STRING, %options)
Encode the (possibly utf8 encoded) STRING to a string which is acceptable
to the RFC2047 definition of a header: only containing us-ascii characters.
@@ -471,23 +471,23 @@ STRING is a strandard iso language name.
=back
-=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item $obj-E<gt>B<fold>( $name, $body, [$maxchars] )
-=item Mail::Message::Field::Full-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item Mail::Message::Field::Full-E<gt>B<fold>( $name, $body, [$maxchars] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<setWrapLength>([LENGTH])
+=item $obj-E<gt>B<setWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|OBJECTS)
+=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|$objects)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=item $obj-E<gt>B<unfold>(STRING)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=back
@@ -546,81 +546,81 @@ a call to this method when the field is needed later.
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Field/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Field|Mail::Message::Field/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Field::Full-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Field::Full-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Field::Full-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Field::Full-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Field::Full-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Field::Full-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Field/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Field|Mail::Message::Field/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Field/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Field|Mail::Message::Field/"DETAILS">.
=head1 DIAGNOSTICS
@@ -667,12 +667,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Field::Structured;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Field::Full';
@@ -78,8 +78,14 @@ sub parse($)
{ my $len = length $string;
if($string =~ s/^\s*\;\s*// && length $found)
- { my $attr = Mail::Message::Field::Attribute->new($found);
- $self->attribute($attr);
+ { my ($name) = $found =~ m/^([^*]+)\*/;
+ if($name && (my $cont = $self->attribute($name)))
+ { $cont->addComponent($found); # continuation
+ }
+ else
+ { my $attr = Mail::Message::Field::Attribute->new($found);
+ $self->attribute($attr);
+ }
$found = '';
}
@@ -95,8 +101,14 @@ sub parse($)
}
if(length $found)
- { my $attr = Mail::Message::Field::Attribute->new($found);
- $self->attribute($attr);
+ { my ($name) = $found =~ m/^([^*]+)\*/;
+ if($name && (my $cont = $self->attribute($name)))
+ { $cont->addComponent($found); # continuation
+ }
+ else
+ { my $attr = Mail::Message::Field::Attribute->new($found);
+ $self->attribute($attr);
+ }
}
1;
@@ -30,59 +30,59 @@ Mail::Message::Field::Structured - one line of a structured message header
=head1 DESCRIPTION
-See L<documentation in the base class|Mail::Message::Field::Full/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Field::Full|Mail::Message::Field::Full/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Field::Full/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Field::Full|Mail::Message::Field::Full/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<0+>()
+=item overload: B<0+>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<<=>>()
+=item overload: B<<=>>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<stringification>()
+=item overload: B<stringification>
-See L<Mail::Message::Field::Full/"OVERLOADED">
+Inherited, see L<Mail::Message::Field::Full/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Field::Full/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Field::Full|Mail::Message::Field::Full/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Field::Full/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Field/"Constructors">
+Inherited, see L<Mail::Message::Field/"Constructors">
-=item Mail::Message::Field::Structured-E<gt>B<from>(FIELD, OPTIONS)
+=item Mail::Message::Field::Structured-E<gt>B<from>($field, %options)
-See L<Mail::Message::Field::Full/"Constructors">
+Inherited, see L<Mail::Message::Field::Full/"Constructors">
-=item Mail::Message::Field::Structured-E<gt>B<new>(DATA)
+=item Mail::Message::Field::Structured-E<gt>B<new>($data)
=over 4
@@ -158,7 +158,7 @@ example: of a structured field
=head2 The field
-See L<documentation in the base class|Mail::Message::Field::Full/"The field">.
+Extends L<"The field" in Mail::Message::Field::Full|Mail::Message::Field::Full/"The field">.
=over 4
@@ -166,118 +166,118 @@ See L<documentation in the base class|Mail::Message::Field::Full/"The field">.
=item Mail::Message::Field::Structured-E<gt>B<isStructured>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<length>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<string>([WRAP])
+=item $obj-E<gt>B<string>( [$wrap] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<toDisclose>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=back
=head2 Access to the name
-See L<documentation in the base class|Mail::Message::Field::Full/"Access to the name">.
+Extends L<"Access to the name" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Access to the name">.
=over 4
=item $obj-E<gt>B<Name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=item $obj-E<gt>B<name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
-=item $obj-E<gt>B<wellformedName>([STRING])
+=item $obj-E<gt>B<wellformedName>( [STRING] )
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=back
=head2 Access to the body
-See L<documentation in the base class|Mail::Message::Field::Full/"Access to the body">.
+Extends L<"Access to the body" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Access to the body">.
=over 4
=item $obj-E<gt>B<body>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<decodedBody>(OPTIONS)
+=item $obj-E<gt>B<decodedBody>(%options)
-See L<Mail::Message::Field::Full/"Access to the body">
+Inherited, see L<Mail::Message::Field::Full/"Access to the body">
=item $obj-E<gt>B<folded>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<foldedBody>([BODY])
+=item $obj-E<gt>B<foldedBody>( [$body] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<stripCFWS>([STRING])
+=item $obj-E<gt>B<stripCFWS>( [STRING] )
-=item Mail::Message::Field::Structured-E<gt>B<stripCFWS>([STRING])
+=item Mail::Message::Field::Structured-E<gt>B<stripCFWS>( [STRING] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<unfoldedBody>([BODY, [WRAP]])
+=item $obj-E<gt>B<unfoldedBody>( [$body, [$wrap]] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
=back
=head2 Access to the content
-See L<documentation in the base class|Mail::Message::Field::Full/"Access to the content">.
+Extends L<"Access to the content" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Access to the content">.
=over 4
=item $obj-E<gt>B<addresses>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<attrPairs>()
Returns a list with attribute name and value pairs.
-=item $obj-E<gt>B<attribute>(OBJECT|(STRING, OPTIONS)|(NAME,VALUE,OPTIONS))
+=item $obj-E<gt>B<attribute>( $object|<STRING, %options>|<$name,$value,%options> )
Add an attribute to the field. The attributes are added left-to-right into
the string representation of the field, although the order of the attributes
is un-important, according to the RFCs.
-You may pass a fully prepared L<Mail::Message::Field::Attribute|Mail::Message::Field::Attribute> OBJECT,
+You may pass a fully prepared L<Mail::Message::Field::Attribute|Mail::Message::Field::Attribute> $object,
if you like to do all preparations for correct representation of the
data yourself. You may also pass one STRING, which is a fully prepared
attribute. This STRING will not be changed, so be careful about quoting
and encodings.
-As third possibility, you can specify an attribute NAME and its VALUE.
+As third possibility, you can specify an attribute $name and its $value.
An attribute object will be created for you implicitly in both
-cases where such object is not supplied, passing the OPTIONS. See
-L<Mail::Message::Field::Attribute::new()|Mail::Message::Field::Attribute/"Constructors"> about the available OPTIONS.
+cases where such object is not supplied, passing the %options. See
+L<Mail::Message::Field::Attribute::new()|Mail::Message::Field::Attribute/"Constructors"> about the available %options.
The attribute object is returned, however, when continuations are used this
may be an object you already know about. C<undef> is returned when
@@ -300,43 +300,43 @@ continuations are folded into one.
=item $obj-E<gt>B<beautify>()
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
-=item $obj-E<gt>B<comment>([STRING])
+=item $obj-E<gt>B<comment>( [STRING] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<createComment>(STRING, OPTIONS)
+=item $obj-E<gt>B<createComment>(STRING, %options)
-=item Mail::Message::Field::Structured-E<gt>B<createComment>(STRING, OPTIONS)
+=item Mail::Message::Field::Structured-E<gt>B<createComment>(STRING, %options)
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
-=item $obj-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item $obj-E<gt>B<createPhrase>(STRING, %options)
-=item Mail::Message::Field::Structured-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item Mail::Message::Field::Structured-E<gt>B<createPhrase>(STRING, %options)
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
=item $obj-E<gt>B<study>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<toDate>([TIME])
+=item $obj-E<gt>B<toDate>( [$time] )
-=item Mail::Message::Field::Structured-E<gt>B<toDate>([TIME])
+=item Mail::Message::Field::Structured-E<gt>B<toDate>( [$time] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<toInt>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Message::Field::Full/"Other methods">.
+Extends L<"Other methods" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Other methods">.
=over 4
@@ -344,57 +344,57 @@ See L<documentation in the base class|Mail::Message::Field::Full/"Other methods"
=item Mail::Message::Field::Structured-E<gt>B<dateToTimestamp>(STRING)
-See L<Mail::Message::Field/"Other methods">
+Inherited, see L<Mail::Message::Field/"Other methods">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Field::Full/"Internals">.
+Extends L<"Internals" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Internals">.
=over 4
-=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))
+=item $obj-E<gt>B<consume>( $line | <$name,<$body|$objects>> )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<decode>(STRING, OPTIONS)
+=item $obj-E<gt>B<decode>(STRING, %options)
-=item Mail::Message::Field::Structured-E<gt>B<decode>(STRING, OPTIONS)
+=item Mail::Message::Field::Structured-E<gt>B<decode>(STRING, %options)
-See L<Mail::Message::Field::Full/"Internals">
+Inherited, see L<Mail::Message::Field::Full/"Internals">
-=item $obj-E<gt>B<defaultWrapLength>([LENGTH])
+=item $obj-E<gt>B<defaultWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<encode>(STRING, OPTIONS)
+=item $obj-E<gt>B<encode>(STRING, %options)
-See L<Mail::Message::Field::Full/"Internals">
+Inherited, see L<Mail::Message::Field::Full/"Internals">
-=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item $obj-E<gt>B<fold>( $name, $body, [$maxchars] )
-=item Mail::Message::Field::Structured-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item Mail::Message::Field::Structured-E<gt>B<fold>( $name, $body, [$maxchars] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<setWrapLength>([LENGTH])
+=item $obj-E<gt>B<setWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|OBJECTS)
+=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|$objects)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=item $obj-E<gt>B<unfold>(STRING)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=back
=head2 Parsing
-See L<documentation in the base class|Mail::Message::Field::Full/"Parsing">.
+Extends L<"Parsing" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Parsing">.
=over 4
@@ -402,109 +402,109 @@ See L<documentation in the base class|Mail::Message::Field::Full/"Parsing">.
=item Mail::Message::Field::Structured-E<gt>B<consumeComment>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumeDotAtom>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumePhrase>(STRING)
=item Mail::Message::Field::Structured-E<gt>B<consumePhrase>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
-=item $obj-E<gt>B<datum>([VALUE])
+=item $obj-E<gt>B<datum>( [$value] )
The part of the field before the semi-colon (C<;>).
=item $obj-E<gt>B<parse>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<produceBody>()
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Field::Full/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Field::Structured-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Field::Structured-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Field::Structured-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Field::Structured-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Field::Structured-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Field::Structured-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Field::Full/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Field::Full/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Field::Full|Mail::Message::Field::Full/"DETAILS">.
=head1 DIAGNOSTICS
@@ -551,12 +551,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message::Field::URIs;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Field::Structured';
@@ -30,59 +30,59 @@ More recent RFCs prefer uri field notation over the various differentiated
syntaxes. Especially the mailing-list RFCs use these fields all the
time. This class can maintain these fields.
-See L<documentation in the base class|Mail::Message::Field::Structured/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Field::Structured/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<0+>()
+=item overload: B<0+>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<<=>>()
+=item overload: B<<=>>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<stringification>()
+=item overload: B<stringification>
-See L<Mail::Message::Field::Full/"OVERLOADED">
+Inherited, see L<Mail::Message::Field::Full/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Field::Structured/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Field::Structured/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Field/"Constructors">
+Inherited, see L<Mail::Message::Field/"Constructors">
-=item Mail::Message::Field::URIs-E<gt>B<from>(FIELD, OPTIONS)
+=item Mail::Message::Field::URIs-E<gt>B<from>($field, %options)
-See L<Mail::Message::Field::Full/"Constructors">
+Inherited, see L<Mail::Message::Field::Full/"Constructors">
-=item Mail::Message::Field::URIs-E<gt>B<new>(DATA)
+=item Mail::Message::Field::URIs-E<gt>B<new>($data)
-Option --Defined in --Default
attributes Mail::Message::Field::Structured <ignored>
@@ -126,7 +126,7 @@ example:
=head2 The field
-See L<documentation in the base class|Mail::Message::Field::Structured/"The field">.
+Extends L<"The field" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"The field">.
=over 4
@@ -134,91 +134,91 @@ See L<documentation in the base class|Mail::Message::Field::Structured/"The fiel
=item Mail::Message::Field::URIs-E<gt>B<isStructured>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<length>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<string>([WRAP])
+=item $obj-E<gt>B<string>( [$wrap] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<toDisclose>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=back
=head2 Access to the name
-See L<documentation in the base class|Mail::Message::Field::Structured/"Access to the name">.
+Extends L<"Access to the name" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Access to the name">.
=over 4
=item $obj-E<gt>B<Name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=item $obj-E<gt>B<name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
-=item $obj-E<gt>B<wellformedName>([STRING])
+=item $obj-E<gt>B<wellformedName>( [STRING] )
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=back
=head2 Access to the body
-See L<documentation in the base class|Mail::Message::Field::Structured/"Access to the body">.
+Extends L<"Access to the body" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Access to the body">.
=over 4
=item $obj-E<gt>B<body>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<decodedBody>(OPTIONS)
+=item $obj-E<gt>B<decodedBody>(%options)
-See L<Mail::Message::Field::Full/"Access to the body">
+Inherited, see L<Mail::Message::Field::Full/"Access to the body">
=item $obj-E<gt>B<folded>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<foldedBody>([BODY])
+=item $obj-E<gt>B<foldedBody>( [$body] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<stripCFWS>([STRING])
+=item $obj-E<gt>B<stripCFWS>( [STRING] )
-=item Mail::Message::Field::URIs-E<gt>B<stripCFWS>([STRING])
+=item Mail::Message::Field::URIs-E<gt>B<stripCFWS>( [STRING] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<unfoldedBody>([BODY, [WRAP]])
+=item $obj-E<gt>B<unfoldedBody>( [$body, [$wrap]] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
=back
=head2 Access to the content
-See L<documentation in the base class|Mail::Message::Field::Structured/"Access to the content">.
+Extends L<"Access to the content" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Access to the content">.
=over 4
@@ -235,11 +235,11 @@ example:
Attributes are not supported for URI fields.
-=item $obj-E<gt>B<addURI>(URI)
+=item $obj-E<gt>B<addURI>($uri)
-Add an URI to the field. The URI can be specified as URI object
-or as string which will be turned into an URI object. The added
-URI is returned.
+Add an $uri to the field. The $uri can be specified as URI object
+or as string which will be turned into an $uri object. The added
+$uri is returned.
example: adding an URI to an URI field
@@ -253,59 +253,59 @@ example: adding an URI to an URI field
=item $obj-E<gt>B<addresses>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<attrPairs>()
-See L<Mail::Message::Field::Structured/"Access to the content">
+Inherited, see L<Mail::Message::Field::Structured/"Access to the content">
-=item $obj-E<gt>B<attribute>(OBJECT|(STRING, OPTIONS)|(NAME,VALUE,OPTIONS))
+=item $obj-E<gt>B<attribute>( $object|<STRING, %options>|<$name,$value,%options> )
-See L<Mail::Message::Field::Structured/"Access to the content">
+Inherited, see L<Mail::Message::Field::Structured/"Access to the content">
=item $obj-E<gt>B<attributes>()
-See L<Mail::Message::Field::Structured/"Access to the content">
+Inherited, see L<Mail::Message::Field::Structured/"Access to the content">
=item $obj-E<gt>B<beautify>()
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
-=item $obj-E<gt>B<comment>([STRING])
+=item $obj-E<gt>B<comment>( [STRING] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<createComment>(STRING, OPTIONS)
+=item $obj-E<gt>B<createComment>(STRING, %options)
-=item Mail::Message::Field::URIs-E<gt>B<createComment>(STRING, OPTIONS)
+=item Mail::Message::Field::URIs-E<gt>B<createComment>(STRING, %options)
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
-=item $obj-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item $obj-E<gt>B<createPhrase>(STRING, %options)
-=item Mail::Message::Field::URIs-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item Mail::Message::Field::URIs-E<gt>B<createPhrase>(STRING, %options)
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
=item $obj-E<gt>B<study>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<toDate>([TIME])
+=item $obj-E<gt>B<toDate>( [$time] )
-=item Mail::Message::Field::URIs-E<gt>B<toDate>([TIME])
+=item Mail::Message::Field::URIs-E<gt>B<toDate>( [$time] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<toInt>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Message::Field::Structured/"Other methods">.
+Extends L<"Other methods" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Other methods">.
=over 4
@@ -313,57 +313,57 @@ See L<documentation in the base class|Mail::Message::Field::Structured/"Other me
=item Mail::Message::Field::URIs-E<gt>B<dateToTimestamp>(STRING)
-See L<Mail::Message::Field/"Other methods">
+Inherited, see L<Mail::Message::Field/"Other methods">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Field::Structured/"Internals">.
+Extends L<"Internals" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Internals">.
=over 4
-=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))
+=item $obj-E<gt>B<consume>( $line | <$name,<$body|$objects>> )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<decode>(STRING, OPTIONS)
+=item $obj-E<gt>B<decode>(STRING, %options)
-=item Mail::Message::Field::URIs-E<gt>B<decode>(STRING, OPTIONS)
+=item Mail::Message::Field::URIs-E<gt>B<decode>(STRING, %options)
-See L<Mail::Message::Field::Full/"Internals">
+Inherited, see L<Mail::Message::Field::Full/"Internals">
-=item $obj-E<gt>B<defaultWrapLength>([LENGTH])
+=item $obj-E<gt>B<defaultWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<encode>(STRING, OPTIONS)
+=item $obj-E<gt>B<encode>(STRING, %options)
-See L<Mail::Message::Field::Full/"Internals">
+Inherited, see L<Mail::Message::Field::Full/"Internals">
-=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item $obj-E<gt>B<fold>( $name, $body, [$maxchars] )
-=item Mail::Message::Field::URIs-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item Mail::Message::Field::URIs-E<gt>B<fold>( $name, $body, [$maxchars] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<setWrapLength>([LENGTH])
+=item $obj-E<gt>B<setWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|OBJECTS)
+=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|$objects)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=item $obj-E<gt>B<unfold>(STRING)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=back
=head2 Parsing
-See L<documentation in the base class|Mail::Message::Field::Structured/"Parsing">.
+Extends L<"Parsing" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Parsing">.
=over 4
@@ -371,109 +371,109 @@ See L<documentation in the base class|Mail::Message::Field::Structured/"Parsing"
=item Mail::Message::Field::URIs-E<gt>B<consumeComment>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumeDotAtom>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumePhrase>(STRING)
=item Mail::Message::Field::URIs-E<gt>B<consumePhrase>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
-=item $obj-E<gt>B<datum>([VALUE])
+=item $obj-E<gt>B<datum>( [$value] )
-See L<Mail::Message::Field::Structured/"Parsing">
+Inherited, see L<Mail::Message::Field::Structured/"Parsing">
=item $obj-E<gt>B<parse>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<produceBody>()
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Field::Structured/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Field::URIs-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Field::URIs-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Field::URIs-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Field::URIs-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Field::URIs-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Field::URIs-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Field::Structured/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Field::Structured/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Field::Structured|Mail::Message::Field::Structured/"DETAILS">.
=head1 DIAGNOSTICS
@@ -525,12 +525,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Field::Unstructured;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Field::Full';
@@ -22,61 +22,61 @@ any way. RFC2822 defines some unstructured fields, but by default all
unknown fields are unstructured as well. Things like attributes and
comments have no meaning for unstructured fields, but encoding does.
-See L<documentation in the base class|Mail::Message::Field::Full/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Field::Full|Mail::Message::Field::Full/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Field::Full/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Field::Full|Mail::Message::Field::Full/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<0+>()
+=item overload: B<0+>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<<=>>()
+=item overload: B<<=>>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<cmp>()
+=item overload: B<cmp>
-See L<Mail::Message::Field/"OVERLOADED">
+Inherited, see L<Mail::Message::Field/"OVERLOADED">
-=item overload: B<stringification>()
+=item overload: B<stringification>
-See L<Mail::Message::Field::Full/"OVERLOADED">
+Inherited, see L<Mail::Message::Field::Full/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Field::Full/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Field::Full|Mail::Message::Field::Full/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Field::Full/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Field/"Constructors">
+Inherited, see L<Mail::Message::Field/"Constructors">
-=item Mail::Message::Field::Unstructured-E<gt>B<from>(FIELD, OPTIONS)
+=item Mail::Message::Field::Unstructured-E<gt>B<from>($field, %options)
-See L<Mail::Message::Field::Full/"Constructors">
+Inherited, see L<Mail::Message::Field::Full/"Constructors">
-=item Mail::Message::Field::Unstructured-E<gt>B<new>(DATA)
+=item Mail::Message::Field::Unstructured-E<gt>B<new>($data)
-When the DATA is specified as single line, the content part is considered to
+When the $data is specified as single line, the content part is considered to
be correcly (character) encoded and escaped. Typically, it is a line as
read from file. The folding of the line is kept as is.
@@ -125,7 +125,7 @@ example:
=head2 The field
-See L<documentation in the base class|Mail::Message::Field::Full/"The field">.
+Extends L<"The field" in Mail::Message::Field::Full|Mail::Message::Field::Full/"The field">.
=over 4
@@ -133,145 +133,145 @@ See L<documentation in the base class|Mail::Message::Field::Full/"The field">.
=item Mail::Message::Field::Unstructured-E<gt>B<isStructured>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<length>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
-=item $obj-E<gt>B<string>([WRAP])
+=item $obj-E<gt>B<string>( [$wrap] )
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=item $obj-E<gt>B<toDisclose>()
-See L<Mail::Message::Field/"The field">
+Inherited, see L<Mail::Message::Field/"The field">
=back
=head2 Access to the name
-See L<documentation in the base class|Mail::Message::Field::Full/"Access to the name">.
+Extends L<"Access to the name" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Access to the name">.
=over 4
=item $obj-E<gt>B<Name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=item $obj-E<gt>B<name>()
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
-=item $obj-E<gt>B<wellformedName>([STRING])
+=item $obj-E<gt>B<wellformedName>( [STRING] )
-See L<Mail::Message::Field/"Access to the name">
+Inherited, see L<Mail::Message::Field/"Access to the name">
=back
=head2 Access to the body
-See L<documentation in the base class|Mail::Message::Field::Full/"Access to the body">.
+Extends L<"Access to the body" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Access to the body">.
=over 4
=item $obj-E<gt>B<body>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<decodedBody>(OPTIONS)
+=item $obj-E<gt>B<decodedBody>(%options)
-See L<Mail::Message::Field::Full/"Access to the body">
+Inherited, see L<Mail::Message::Field::Full/"Access to the body">
=item $obj-E<gt>B<folded>()
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<foldedBody>([BODY])
+=item $obj-E<gt>B<foldedBody>( [$body] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<stripCFWS>([STRING])
+=item $obj-E<gt>B<stripCFWS>( [STRING] )
-=item Mail::Message::Field::Unstructured-E<gt>B<stripCFWS>([STRING])
+=item Mail::Message::Field::Unstructured-E<gt>B<stripCFWS>( [STRING] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
-=item $obj-E<gt>B<unfoldedBody>([BODY, [WRAP]])
+=item $obj-E<gt>B<unfoldedBody>( [$body, [$wrap]] )
-See L<Mail::Message::Field/"Access to the body">
+Inherited, see L<Mail::Message::Field/"Access to the body">
=back
=head2 Access to the content
-See L<documentation in the base class|Mail::Message::Field::Full/"Access to the content">.
+Extends L<"Access to the content" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Access to the content">.
=over 4
=item $obj-E<gt>B<addresses>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<attribute>(NAME [, VALUE])
+=item $obj-E<gt>B<attribute>( $name, [$value] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<attributes>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<beautify>()
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
-=item $obj-E<gt>B<comment>([STRING])
+=item $obj-E<gt>B<comment>( [STRING] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<createComment>(STRING, OPTIONS)
+=item $obj-E<gt>B<createComment>(STRING, %options)
-=item Mail::Message::Field::Unstructured-E<gt>B<createComment>(STRING, OPTIONS)
+=item Mail::Message::Field::Unstructured-E<gt>B<createComment>(STRING, %options)
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
-=item $obj-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item $obj-E<gt>B<createPhrase>(STRING, %options)
-=item Mail::Message::Field::Unstructured-E<gt>B<createPhrase>(STRING, OPTIONS)
+=item Mail::Message::Field::Unstructured-E<gt>B<createPhrase>(STRING, %options)
-See L<Mail::Message::Field::Full/"Access to the content">
+Inherited, see L<Mail::Message::Field::Full/"Access to the content">
=item $obj-E<gt>B<study>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
-=item $obj-E<gt>B<toDate>([TIME])
+=item $obj-E<gt>B<toDate>( [$time] )
-=item Mail::Message::Field::Unstructured-E<gt>B<toDate>([TIME])
+=item Mail::Message::Field::Unstructured-E<gt>B<toDate>( [$time] )
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=item $obj-E<gt>B<toInt>()
-See L<Mail::Message::Field/"Access to the content">
+Inherited, see L<Mail::Message::Field/"Access to the content">
=back
=head2 Other methods
-See L<documentation in the base class|Mail::Message::Field::Full/"Other methods">.
+Extends L<"Other methods" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Other methods">.
=over 4
@@ -279,57 +279,57 @@ See L<documentation in the base class|Mail::Message::Field::Full/"Other methods"
=item Mail::Message::Field::Unstructured-E<gt>B<dateToTimestamp>(STRING)
-See L<Mail::Message::Field/"Other methods">
+Inherited, see L<Mail::Message::Field/"Other methods">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Field::Full/"Internals">.
+Extends L<"Internals" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Internals">.
=over 4
-=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))
+=item $obj-E<gt>B<consume>( $line | <$name,<$body|$objects>> )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<decode>(STRING, OPTIONS)
+=item $obj-E<gt>B<decode>(STRING, %options)
-=item Mail::Message::Field::Unstructured-E<gt>B<decode>(STRING, OPTIONS)
+=item Mail::Message::Field::Unstructured-E<gt>B<decode>(STRING, %options)
-See L<Mail::Message::Field::Full/"Internals">
+Inherited, see L<Mail::Message::Field::Full/"Internals">
-=item $obj-E<gt>B<defaultWrapLength>([LENGTH])
+=item $obj-E<gt>B<defaultWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<encode>(STRING, OPTIONS)
+=item $obj-E<gt>B<encode>(STRING, %options)
-See L<Mail::Message::Field::Full/"Internals">
+Inherited, see L<Mail::Message::Field::Full/"Internals">
-=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item $obj-E<gt>B<fold>( $name, $body, [$maxchars] )
-=item Mail::Message::Field::Unstructured-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item Mail::Message::Field::Unstructured-E<gt>B<fold>( $name, $body, [$maxchars] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<setWrapLength>([LENGTH])
+=item $obj-E<gt>B<setWrapLength>( [$length] )
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
-=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|OBJECTS)
+=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|$objects)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=item $obj-E<gt>B<unfold>(STRING)
-See L<Mail::Message::Field/"Internals">
+Inherited, see L<Mail::Message::Field/"Internals">
=back
=head2 Parsing
-See L<documentation in the base class|Mail::Message::Field::Full/"Parsing">.
+Extends L<"Parsing" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Parsing">.
=over 4
@@ -337,105 +337,105 @@ See L<documentation in the base class|Mail::Message::Field::Full/"Parsing">.
=item Mail::Message::Field::Unstructured-E<gt>B<consumeComment>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumeDotAtom>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumePhrase>(STRING)
=item Mail::Message::Field::Unstructured-E<gt>B<consumePhrase>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<parse>(STRING)
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<produceBody>()
-See L<Mail::Message::Field::Full/"Parsing">
+Inherited, see L<Mail::Message::Field::Full/"Parsing">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Field::Full/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Field::Unstructured-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Field::Unstructured-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Field::Unstructured-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Field::Unstructured-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Field::Unstructured-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Field::Unstructured-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Field::Full/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Field::Full|Mail::Message::Field::Full/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Field::Full/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Field::Full|Mail::Message::Field::Full/"DETAILS">.
=head1 DIAGNOSTICS
@@ -482,12 +482,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Field;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -456,8 +456,6 @@ sub fold($$;$)
wantarray ? @folded : join('', @folded);
}
-#------------------------------------------
-
sub unfold($)
{ my $string = $_[1];
@@ -48,13 +48,13 @@ added methods of a message:
my $other = $message->get('Reply-To');
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 OVERLOADED
=over 4
-=item overload: B<"">()
+=item overload: B<"">
(stringification) produces the unfolded body of the field, which may
be what you expect. This is what makes what the field object seems
@@ -68,13 +68,13 @@ example:
my $subject = $msg->get('subject') || 'your mail';
print "Re: $subject\n";
-=item overload: B<0+>()
+=item overload: B<0+>
(numification) When the field is numeric, the value will be returned.
The result is produced by L<toInt()|Mail::Message::Field/"Access to the content">. If the value is not correct,
a C<0> is produced, to simplify calculations.
-=item overload: B<<=>>()
+=item overload: B<<=>>
(numeric comparison) Compare the integer field contents with something
else.
@@ -84,11 +84,11 @@ example:
if($msg->get('Content-Length') > 10000) ...
if($msg->size > 10000) ... ; # same, but better
-=item overload: B<bool>()
+=item overload: B<bool>
Always true, to make it possible to say C<if($field)>.
-=item overload: B<cmp>()
+=item overload: B<cmp>
(string comparison) Compare the unfolded body of a field with an other
field or a string, using the buildin C<cmp>.
@@ -97,11 +97,11 @@ field or a string, using the buildin C<cmp>.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
@@ -109,7 +109,7 @@ See L<documentation in the base class|Mail::Reporter/"Constructors">.
Create a copy of this field object.
-=item Mail::Message::Field-E<gt>B<new>(DATA)
+=item Mail::Message::Field-E<gt>B<new>($data)
See L<Mail::Message::Field::Fast::new()|Mail::Message::Field::Fast/"METHODS">,
L<Mail::Message::Field::Flex::new()|Mail::Message::Field::Flex/"METHODS">,
@@ -159,21 +159,21 @@ field's name, body and folding characters.
Returns the number of lines needed to display this header-line.
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
Print the whole header-line to the specified file-handle. One line may
result in more than one printed line, because of the folding of long
-lines. The FILEHANDLE defaults to the selected handle.
+lines. The $fh defaults to the selected handle.
=item $obj-E<gt>B<size>()
Returns the number of bytes needed to display this header-line, Same
as L<length()|Mail::Message::Field/"The field">.
-=item $obj-E<gt>B<string>([WRAP])
+=item $obj-E<gt>B<string>( [$wrap] )
Returns the field as string. By default, this returns the same as
-L<folded()|Mail::Message::Field/"Access to the body">. However, the optional WRAP will cause to re-fold to take
+L<folded()|Mail::Message::Field/"Access to the body">. However, the optional $wrap will cause to re-fold to take
place (without changing the folding stored inside the field).
=item $obj-E<gt>B<toDisclose>()
@@ -198,7 +198,7 @@ Returns the name of this field in original casing. See L<name()|Mail::Message::
Returns the name of this field, with all characters lower-cased for
ease of comparison. See L<Name()|Mail::Message::Field/"Access to the name"> as well.
-=item $obj-E<gt>B<wellformedName>([STRING])
+=item $obj-E<gt>B<wellformedName>( [STRING] )
(Instance method class method)
As instance method, the current field's name is correctly formatted
@@ -247,18 +247,18 @@ example:
print $field->folded;
print scalar $field->folded; # faster
-=item $obj-E<gt>B<foldedBody>([BODY])
+=item $obj-E<gt>B<foldedBody>( [$body] )
Returns the body as a set of lines. In scalar context, this will be one line
containing newlines. Be warned about the newlines when you do
pattern-matching on the result of thie method.
-The optional BODY argument changes the field's body. The folding of the
+The optional $body argument changes the field's body. The folding of the
argument must be correct.
-=item $obj-E<gt>B<stripCFWS>([STRING])
+=item $obj-E<gt>B<stripCFWS>( [STRING] )
-=item Mail::Message::Field-E<gt>B<stripCFWS>([STRING])
+=item Mail::Message::Field-E<gt>B<stripCFWS>( [STRING] )
Remove the I<comments> and I<folding white spaces> from the STRING. Without
string and only as instance method, the L<unfoldedBody()|Mail::Message::Field/"Access to the body"> is being stripped
@@ -269,13 +269,13 @@ are defined by the various RFCs as being so. You don't want parts within
braces which are in the Subject header line to be removed, to give an
example.
-=item $obj-E<gt>B<unfoldedBody>([BODY, [WRAP]])
+=item $obj-E<gt>B<unfoldedBody>( [$body, [$wrap]] )
Returns the body as one single line, where all folding information (if
available) is removed. This line will also NOT end on a new-line.
-The optional BODY argument changes the field's body. The right folding is
-performed before assignment. The WRAP may be specified to enforce a
+The optional $body argument changes the field's body. The right folding is
+performed before assignment. The $wrap may be specified to enforce a
folding size.
example:
@@ -299,7 +299,7 @@ example:
my @addr = $message->head->get('to')->addresses;
my @addr = $message->to;
-=item $obj-E<gt>B<attribute>(NAME [, VALUE])
+=item $obj-E<gt>B<attribute>( $name, [$value] )
Get the value of an attribute, optionally after setting it to a new value.
Attributes are part of some header lines, and hide themselves in the
@@ -331,7 +331,7 @@ example:
my %attributes = $head->get('Content-Disposition')->attributes;
-=item $obj-E<gt>B<comment>([STRING])
+=item $obj-E<gt>B<comment>( [STRING] )
Returns the unfolded comment (part after a semi-colon) in a structureed
header-line. optionally after setting it to a new STRING first.
@@ -354,13 +354,13 @@ example:
my $subject = $msg->head->study('subject'); # same
my $subject = $msg->study('subject'); # same
-=item $obj-E<gt>B<toDate>([TIME])
+=item $obj-E<gt>B<toDate>( [$time] )
-=item Mail::Message::Field-E<gt>B<toDate>([TIME])
+=item Mail::Message::Field-E<gt>B<toDate>( [$time] )
Convert a timestamp into an rfc2822 compliant date format. This differs
from the default output of C<localtime> in scalar context. Without
-argument, the C<localtime> is used to get the current time. TIME can
+argument, the C<localtime> is used to get the current time. $time can
be specified as one numeric (like the result of C<time()>) and as list
(like produced by c<localtime()> in list context).
@@ -402,38 +402,38 @@ a timestamp like is produced by the C<time> function.
=over 4
-=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))
+=item $obj-E<gt>B<consume>( $line | <$name,<$body|$objects>> )
-Accepts a whole field LINE, or a pair with the field's NAME and BODY. In
-the latter case, the BODY data may be specified as array of OBJECTS which
+Accepts a whole field $line, or a pair with the field's $name and $body. In
+the latter case, the $body data may be specified as array of $objects which
are stringified. Returned is a nicely formatted pair of two strings: the
field's name and a folded body.
This method is called by L<new()|Mail::Message::Field/"Constructors">, and usually not by an application
-program. The details about converting the OBJECTS to a field content
+program. The details about converting the $objects to a field content
are explained in L</Specifying field data>.
-=item $obj-E<gt>B<defaultWrapLength>([LENGTH])
+=item $obj-E<gt>B<defaultWrapLength>( [$length] )
Any field from any header for any message will have this default wrapping.
-This is maintained in one global variable. Without a specified LENGTH,
+This is maintained in one global variable. Without a specified $length,
the current value is returned. The default is 78.
-=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item $obj-E<gt>B<fold>( $name, $body, [$maxchars] )
-=item Mail::Message::Field-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
+=item Mail::Message::Field-E<gt>B<fold>( $name, $body, [$maxchars] )
-Make the header field with NAME fold into multiple lines.
+Make the header field with $name fold into multiple lines.
Wrapping is performed by inserting newlines before a blanks in the
-BODY, such that no line exceeds the MAXCHARS and each line is as long
+$body, such that no line exceeds the $maxchars and each line is as long
as possible.
The RFC requests for folding on nice spots, but this request is
mainly ignored because it would make folding too slow.
-=item $obj-E<gt>B<setWrapLength>([LENGTH])
+=item $obj-E<gt>B<setWrapLength>( [$length] )
-Force the wrapping of this field to the specified LENGTH characters. The
+Force the wrapping of this field to the specified $length characters. The
wrapping is performed with L<fold()|Mail::Message::Field/"Internals"> and the results stored within
the field object.
@@ -441,7 +441,7 @@ example: refolding the field
$field->setWrapLength(99);
-=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|OBJECTS)
+=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|$objects)
This method implements the translation of user supplied objects into
ascii fields. The process is explained in L</Specifying field data>.
@@ -456,75 +456,75 @@ Possible leading blanks on the first line are removed as well.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Field-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Field-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Field-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Field-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Field-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Field-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -808,12 +808,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Head::Complete;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Head';
@@ -61,15 +61,13 @@ sub build(@)
sub isDelayed() {0}
-sub nrLines() { sum 1, map { $_->nrLines } shift->orderedFields }
-
-
-sub size() { sum 1, map {$_->size} shift->orderedFields }
+sub nrLines() { sum 1, map $_->nrLines, shift->orderedFields }
+sub size() { sum 1, map $_->size, shift->orderedFields }
sub wrap($)
{ my ($self, $length) = @_;
- $_->setWrapLength($length) foreach $self->orderedFields;
+ $_->setWrapLength($length) for $self->orderedFields;
}
#------------------------------------------
@@ -189,7 +187,7 @@ sub reset($@)
# Cloning required, otherwise double registrations will not be
# removed from the ordered list: that's controled by 'weaken'
- my @fields = map {$_->clone} @_;
+ my @fields = map $_->clone, @_;
if(@_==1) { $known->{$name} = $fields[0] }
else { $known->{$name} = [@fields] }
@@ -29,83 +29,83 @@ E-mail's message can be in various states: unread, partially read, and
fully read. The class stores a message of which all header lines are
known for sure.
-See L<documentation in the base class|Mail::Message::Head/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Head|Mail::Message::Head/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Head/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Head|Mail::Message::Head/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Head/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Head|Mail::Message::Head/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Head/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Head|Mail::Message::Head/"Constructors">.
=over 4
-=item $obj-E<gt>B<build>([PAIR|FIELD]-LIST)
+=item $obj-E<gt>B<build>( [PAIR|$field], ... )
Undefined values are interpreted as empty field values, and therefore skipped.
-=item $obj-E<gt>B<clone>([NAMES|ARRAY-OF-NAMES|REGEXS])
+=item $obj-E<gt>B<clone>( [@names|ARRAY|Regexps] )
Make a copy of the header, optionally limited only to the header lines
-specified by NAMES. See L<grepNames()|Mail::Message::Head::Complete/"Access to the header"> on the way these fields can be
+specified by @names. See L<grepNames()|Mail::Message::Head::Complete/"Access to the header"> on the way these fields can be
used.
example:
my $newhead = $head->clone('Subject', 'Received');
-=item Mail::Message::Head::Complete-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Head::Complete-E<gt>B<new>(%options)
-See L<Mail::Message::Head/"Constructors">
+Inherited, see L<Mail::Message::Head/"Constructors">
=back
=head2 The header
-See L<documentation in the base class|Mail::Message::Head/"The header">.
+Extends L<"The header" in Mail::Message::Head|Mail::Message::Head/"The header">.
=over 4
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isEmpty>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<knownNames>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<nrLines>()
@@ -114,7 +114,7 @@ the trailing newline)
=item $obj-E<gt>B<orderedFields>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<size>()
@@ -123,9 +123,9 @@ the trailing newline). On systems which use CRLF as line separator,
the number of lines in the header (see L<nrLines()|Mail::Message::Head::Complete/"The header">) must be added to
find the actual size in the file.
-=item $obj-E<gt>B<wrap>(INTEGER)
+=item $obj-E<gt>B<wrap>($integer)
-Re-fold all fields from the header to contain at most INTEGER number of
+Re-fold all fields from the header to contain at most $integer number of
characters per line.
example: re-folding a header
@@ -136,21 +136,21 @@ example: re-folding a header
=head2 Access to the header
-See L<documentation in the base class|Mail::Message::Head/"Access to the header">.
+Extends L<"Access to the header" in Mail::Message::Head|Mail::Message::Head/"Access to the header">.
=over 4
-=item $obj-E<gt>B<add>(FIELD | LINE | (NAME,BODY[,ATTRS]))
+=item $obj-E<gt>B<add>( $field | $line | <$name, $body, [$attrs]> )
Add a field to the header. If a field is added more than once, all values
are stored in the header, in the order they are added.
-When a FIELD object is specified (some L<Mail::Message::Field|Mail::Message::Field> instance), that
-will be added. Another possibility is to specify a raw header LINE, or a
-header line nicely split-up in NAME and BODY, in which case the
+When a $field object is specified (some L<Mail::Message::Field|Mail::Message::Field> instance), that
+will be added. Another possibility is to specify a raw header $line, or a
+header line nicely split-up in $name and $body, in which case the
field constructor is called for you.
-LINE or BODY specifications which are terminated by a new-line are considered
+$line or $body specifications which are terminated by a new-line are considered
to be correctly folded. Lines which are not terminated by a new-line will
be folded when needed: new-lines will be added where required. It is strongly
advised to let MailBox do the folding for you.
@@ -167,12 +167,12 @@ example:
$head->add($field);
my Mail::Message::Field $s = $head->add(Sender => 'I');
-=item $obj-E<gt>B<addListGroup>(OBJECT)
+=item $obj-E<gt>B<addListGroup>($object)
A I<list group> is a set of header fields which contain data about a
mailing list which was used to transmit the message. See
L<Mail::Message::Head::ListGroup|Mail::Message::Head::ListGroup> for details about the implementation
-of the OBJECT.
+of the $object.
When you have a list group prepared, you can add it later using this
method. You will get your private copy of the list group data in
@@ -183,10 +183,10 @@ example: of adding a list group to a header
my $lg = Mail::Message::Head::ListGroup->new(...);
my $own_lg = $msg->head->addListGroup($lg);
-=item $obj-E<gt>B<addResentGroup>(RESENT-GROUP|DATA)
+=item $obj-E<gt>B<addResentGroup>($resent_group|$data)
-Add a RESENT-GROUP (a L<Mail::Message::Head::ResentGroup|Mail::Message::Head::ResentGroup> object) to
-the header. If you specify DATA, that is used to create such group
+Add a $resent_group (a L<Mail::Message::Head::ResentGroup|Mail::Message::Head::ResentGroup> object) to
+the header. If you specify $data, that is used to create such group
first. If no C<Received> line is specified, it will be created
for you.
@@ -201,11 +201,11 @@ example:
my $rg = $head->addResentGroup(From => 'me');
-=item $obj-E<gt>B<addSpamGroup>(OBJECT)
+=item $obj-E<gt>B<addSpamGroup>($object)
A I<spam fighting group> is a set of header fields which contains data
which is used to fight spam. See L<Mail::Message::Head::SpamGroup|Mail::Message::Head::SpamGroup>
-for details about the implementation of the OBJECT.
+for details about the implementation of the $object.
When you have a spam group prepared, you can add it later using this
method. You will get your private copy of the spam group data in
@@ -216,30 +216,30 @@ example: of adding a spam group to a header
my $sg = Mail::Message::Head::SpamGroup->new(...);
my $own_sg = $msg->head->addSpamGroup($sg);
-=item $obj-E<gt>B<count>(NAME)
+=item $obj-E<gt>B<count>($name)
-Count the number of fields with this NAME. Most fields will return 1:
+Count the number of fields with this $name. Most fields will return 1:
only one occurance in the header. As example, the C<Received> fields
are usually present more than once.
-=item $obj-E<gt>B<delete>(NAME)
+=item $obj-E<gt>B<delete>($name)
Remove the field with the specified name. If the header contained
multiple lines with the same name, they will be replaced all together.
This method simply calls L<reset()|Mail::Message::Head::Complete/"Access to the header"> without replacement fields.
READ THE IMPORTANT WARNING IN L<removeField()|Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<get>(NAME [,INDEX])
+=item $obj-E<gt>B<get>( $name, [$index] )
-See L<Mail::Message::Head/"Access to the header">
+Inherited, see L<Mail::Message::Head/"Access to the header">
-=item $obj-E<gt>B<grepNames>([NAMES|ARRAY-OF-NAMES|REGEXS])
+=item $obj-E<gt>B<grepNames>( [@names|ARRAY|Regexps] )
Filter from all header fields those with names which start will any of the
specified list. When no names are specified, all fields will be returned.
The list is ordered as they where read from file, or added later.
-The NAMES are considered regular expressions, and will all be matched
+The @names are considered regular expressions, and will all be matched
case insensitive and attached to the front of the string only. You may
also specify one or more prepared regexes.
@@ -270,9 +270,9 @@ Returns a full ordered list of known field names, as defined in the
header. Fields which were reset() to be empty will still be
listed here.
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-Print all headers to the specified FILEHANDLE, by default the selected
+Print all headers to the specified $fh, by default the selected
filehandle. See L<printUndisclosed()|Mail::Message::Head::Complete/"Access to the header"> to limit the headers to include
only the public headers.
@@ -284,21 +284,21 @@ example:
my $fh = IO::File->new(...);
$head->print($fh);
-=item $obj-E<gt>B<printSelected>(FILEHANDLE, (STRING|REGEXP)s)
+=item $obj-E<gt>B<printSelected>($fh, <STRING|Regexp>, ...)
Like the usual L<print()|Mail::Message::Head::Complete/"Access to the header">, the header lines are printed to the specified
-FILEHANDLE. In this case, however, only the fields with names as specified by
-STRING (case insensative) or REGEXP are printed. They will stay the in-order
+$fh. In this case, however, only the fields with names as specified by
+STRING (case insensative) or Regexp are printed. They will stay the in-order
of the source header.
example: printing only a subset of the fields
$head->printSelected(STDOUT, qw/Subject From To/, qr/^x\-(spam|xyz)\-/i)
-=item $obj-E<gt>B<printUndisclosed>([FILEHANDLE])
+=item $obj-E<gt>B<printUndisclosed>( [$fh] )
Like the usual L<print()|Mail::Message::Head::Complete/"Access to the header">, the header lines are printed to the specified
-FILEHANDLE, by default the selected filehandle. In this case, however,
+$fh, by default the selected filehandle. In this case, however,
C<Bcc> and C<Resent-Bcc> lines are included.
=item $obj-E<gt>B<removeContentInfo>()
@@ -306,9 +306,9 @@ C<Bcc> and C<Resent-Bcc> lines are included.
Remove all body related fields from the header. The header will become
partial.
-=item $obj-E<gt>B<removeField>(FIELD)
+=item $obj-E<gt>B<removeField>($field)
-Remove the specified FIELD object from the header. This is useful when
+Remove the specified $field object from the header. This is useful when
there are possible more than one fields with the same name, and you
need to remove exactly one of them. Also have a look at L<delete()|Mail::Message::Head::Complete/"Access to the header">,
L<reset()|Mail::Message::Head::Complete/"Access to the header">, and L<set()|Mail::Message::Head::Complete/"Access to the header">.
@@ -347,13 +347,13 @@ the field content. SAVE are all methods which return the text:
my $s = $msg->subject;
my $s = $msg->string;
-=item $obj-E<gt>B<removeFields>(STRING|REGEXP, [STRING|REGEXP, ...])
+=item $obj-E<gt>B<removeFields>( <STRING|Regexp>, ... )
The header object is turned into a L<Mail::Message::Head::Partial|Mail::Message::Head::Partial> object
which has a set of fields removed. Read about the implications and the
possibilities in L<Mail::Message::Head::Partial::removeFields()|Mail::Message::Head::Partial/"Access to the header">.
-=item $obj-E<gt>B<removeFieldsExcept>(STRING|REGEXP, [STRING|REGEXP, ...])
+=item $obj-E<gt>B<removeFieldsExcept>( <STRING|Regexp>, ... )
The header object is turned into a L<Mail::Message::Head::Partial|Mail::Message::Head::Partial> object
which has a set of fields removed. Read about the implications and the
@@ -391,10 +391,10 @@ with C<Resent-*>. Before the first C<Resent> line is I<trace> information,
which is composed of an optional C<Return-Path> field and an required
C<Received> field.
-=item $obj-E<gt>B<reset>(NAME, FIELDS)
+=item $obj-E<gt>B<reset>($name, @fields)
-Replace the values in the header fields named by NAME with the values
-specified in the list of FIELDS. A single name can correspond to multiple
+Replace the values in the header fields named by $name with the values
+specified in the list of @fields. A single name can correspond to multiple
repeated fields. READ THE IMPORTANT WARNING IN L<removeField()|Mail::Message::Head::Complete/"Access to the header">
Removing fields which are part of one of the predefined field groups is
@@ -405,7 +405,7 @@ to a list group. You can delete a whole group with
L<Mail::Message::Head::FieldGroup::delete()|Mail::Message::Head::FieldGroup/"The header">, or with methods which
are provided by L<Mail::Message::Head::Partial|Mail::Message::Head::Partial>.
-If FIELDS is empty, the corresponding NAME fields will
+If FIELDS is empty, the corresponding $name fields will
be removed. The location of removed fields in the header order will be
remembered. Fields with the same name which are added later will appear at
the remembered position. This is equivalent to the L<delete()|Mail::Message::Head::Complete/"Access to the header"> method.
@@ -421,7 +421,7 @@ example:
shift @rgs; # keep this one (later is added in front)
$_->delete foreach @rgs;
-=item $obj-E<gt>B<set>(FIELD | LINE | (NAME, BODY [,ATTRS]))
+=item $obj-E<gt>B<set>( $field | $line | <$name, $body, [$attrs]> )
The C<set> method is similar to the L<add()|Mail::Message::Head::Complete/"Access to the header"> method, and takes the same
options. However, existing values for fields will be removed before a new
@@ -440,15 +440,15 @@ example:
call_spamassassin($message)
unless defined $message->spamDetected;
-=item $obj-E<gt>B<spamGroups>([NAMES])
+=item $obj-E<gt>B<spamGroups>( [$names] )
Returns a list of L<Mail::Message::Head::SpamGroup|Mail::Message::Head::SpamGroup> objects, each collecting
-some lines which contain spam fighting information. When any NAMES are
+some lines which contain spam fighting information. When any $names are
given, then only these groups are returned.
See also L<addSpamGroup()|Mail::Message::Head::Complete/"Access to the header"> and L<removeSpamGroups()|Mail::Message::Head::Complete/"Access to the header">.
In scalar context, with exactly one NAME specified, that group will be
-returned. With more NAMES or without NAMES, a list will be returned
+returned. With more $names or without $names, a list will be returned
(which defaults to the length of the list in scalar context).
example: use of listGroup()
@@ -464,21 +464,21 @@ example: use of listGroup()
Returns the whole header as one scalar (in scalar context) or list
of lines (list context). Triggers completion.
-=item $obj-E<gt>B<study>(NAME [,INDEX])
+=item $obj-E<gt>B<study>( $name, [$index] )
-See L<Mail::Message::Head/"Access to the header">
+Inherited, see L<Mail::Message::Head/"Access to the header">
=back
=head2 About the body
-See L<documentation in the base class|Mail::Message::Head/"About the body">.
+Extends L<"About the body" in Mail::Message::Head|Mail::Message::Head/"About the body">.
=over 4
=item $obj-E<gt>B<guessBodySize>()
-See L<Mail::Message::Head/"About the body">
+Inherited, see L<Mail::Message::Head/"About the body">
=item $obj-E<gt>B<guessTimeStamp>()
@@ -492,7 +492,7 @@ supply that information.
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message::Head/"About the body">
+Inherited, see L<Mail::Message::Head/"About the body">
=item $obj-E<gt>B<recvstamp>()
@@ -542,17 +542,17 @@ and C<localtime> methods.
=head2 Internals
-See L<documentation in the base class|Mail::Message::Head/"Internals">.
+Extends L<"Internals" in Mail::Message::Head|Mail::Message::Head/"Internals">.
=over 4
-=item $obj-E<gt>B<addNoRealize>(FIELD)
+=item $obj-E<gt>B<addNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<addOrderedFields>(FIELDS)
+=item $obj-E<gt>B<addOrderedFields>($fields)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<createFromLine>()
@@ -570,24 +570,24 @@ message-threads. See L<messageIdPrefix()|Mail::Message::Head::Complete/"Interna
=item $obj-E<gt>B<fileLocation>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<load>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<messageIdPrefix>([PREFIX, [HOSTNAME]|CODE])
+=item $obj-E<gt>B<messageIdPrefix>( [$prefix, [$hostname]|CODE] )
-=item Mail::Message::Head::Complete-E<gt>B<messageIdPrefix>([PREFIX, [HOSTNAME]|CODE])
+=item Mail::Message::Head::Complete-E<gt>B<messageIdPrefix>( [$prefix, [$hostname]|CODE] )
When options are provided, it sets a new way to create message-ids,
as used by L<createMessageId()|Mail::Message::Head::Complete/"Internals">. You have two choices: either by
-providing a PREFIX and optionally a HOSTNAME, or a CODE reference.
+providing a $prefix and optionally a $hostname, or a CODE reference.
The CODE reference will be called with the header as first argument.
You must ensure yourself that the returned value is RFC compliant.
-The PREFIX defaults to C<mailbox-$$>, the HOSTNAME defaults to the
+The $prefix defaults to C<mailbox-$$>, the $hostname defaults to the
return of L<Net::Domains>'s function C<hostfqdn()>, or when not installed,
the L<Sys::Hostname>'s function C<hostname()>. Inbetween the
two, a nano-second time provided by L<Time::HiRes> is used. If that
@@ -612,97 +612,97 @@ example: setting a message prefix
$many_msg->messageIdPrefix(\&new_msgid);
Mail::Message::Head::Complete->messageIdPrefix(&new_msgid);
-=item $obj-E<gt>B<moveLocation>(DISTANCE)
+=item $obj-E<gt>B<moveLocation>($distance)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<read>(PARSER)
+=item $obj-E<gt>B<read>($parser)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<setNoRealize>(FIELD)
+=item $obj-E<gt>B<setNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Head/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Head|Mail::Message::Head/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Head::Complete-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Head::Complete-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Head::Complete-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Head::Complete-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Head::Complete-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Head::Complete-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Head/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Head|Mail::Message::Head/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Head/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Head|Mail::Message::Head/"DETAILS">.
=head1 DIAGNOSTICS
@@ -728,12 +728,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,13 +1,12 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
-
use strict;
package Mail::Message::Head::Delayed;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Head';
@@ -67,14 +66,11 @@ sub get($;$)
sub guessBodySize() {undef}
-#-------------------------------------------
-
sub guessTimestamp() {undef}
#------------------------------------------
-
sub read($)
{ my ($self, $parser, $headtype, $bodytype) = @_;
@@ -83,14 +79,7 @@ sub read($)
$self;
}
-#------------------------------------------
-
sub load() {$_[0] = $_[0]->message->loadHead}
-
-#------------------------------------------
-
sub setNoRealize($) { shift->log(INTERNAL => "Setting field on a delayed?") }
-#-------------------------------------------
-
1;
@@ -24,100 +24,100 @@ Mail::Message::Head::Delayed - a not-read header of a Mail::Message
This object is used as place-holder, to be replaced
by a L<Mail::Message::Head|Mail::Message::Head> when someone accesses the header of a message.
-See L<documentation in the base class|Mail::Message::Head/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Head|Mail::Message::Head/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Head/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Head|Mail::Message::Head/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Head/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Head|Mail::Message::Head/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Head/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Head|Mail::Message::Head/"Constructors">.
=over 4
-=item $obj-E<gt>B<build>(FIELDS)
+=item $obj-E<gt>B<build>($fields)
You cannot create a delayed header with fields.
-=item Mail::Message::Head::Delayed-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Head::Delayed-E<gt>B<new>(%options)
-See L<Mail::Message::Head/"Constructors">
+Inherited, see L<Mail::Message::Head/"Constructors">
=back
=head2 The header
-See L<documentation in the base class|Mail::Message::Head/"The header">.
+Extends L<"The header" in Mail::Message::Head|Mail::Message::Head/"The header">.
=over 4
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isEmpty>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<knownNames>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<orderedFields>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=back
=head2 Access to the header
-See L<documentation in the base class|Mail::Message::Head/"Access to the header">.
+Extends L<"Access to the header" in Mail::Message::Head|Mail::Message::Head/"Access to the header">.
=over 4
-=item $obj-E<gt>B<get>(NAME [,INDEX])
+=item $obj-E<gt>B<get>( $name, [$index] )
-Get the information about the header line NAME. Realization will
+Get the information about the header line $name. Realization will
take place.
-=item $obj-E<gt>B<study>(NAME [,INDEX])
+=item $obj-E<gt>B<study>( $name, [$index] )
-See L<Mail::Message::Head/"Access to the header">
+Inherited, see L<Mail::Message::Head/"Access to the header">
=back
=head2 About the body
-See L<documentation in the base class|Mail::Message::Head/"About the body">.
+Extends L<"About the body" in Mail::Message::Head|Mail::Message::Head/"About the body">.
=over 4
@@ -140,123 +140,123 @@ L<Mail::Message::timestamp()|Mail::Message/"The header"> usually will give a fig
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message::Head/"About the body">
+Inherited, see L<Mail::Message::Head/"About the body">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Head/"Internals">.
+Extends L<"Internals" in Mail::Message::Head|Mail::Message::Head/"Internals">.
=over 4
-=item $obj-E<gt>B<addNoRealize>(FIELD)
+=item $obj-E<gt>B<addNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<addOrderedFields>(FIELDS)
+=item $obj-E<gt>B<addOrderedFields>($fields)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<fileLocation>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<load>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<moveLocation>(DISTANCE)
+=item $obj-E<gt>B<moveLocation>($distance)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<read>(PARSER)
+=item $obj-E<gt>B<read>($parser)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<setNoRealize>(FIELD)
+=item $obj-E<gt>B<setNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Head/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Head|Mail::Message::Head/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Head::Delayed-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Head::Delayed-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Head::Delayed-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Head::Delayed-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Head::Delayed-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Head::Delayed-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Head/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Head|Mail::Message::Head/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Head/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Head|Mail::Message::Head/"DETAILS">.
=head1 DIAGNOSTICS
@@ -279,12 +279,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Message::Head::FieldGroup;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -29,15 +29,15 @@ related software (implemented by L<Mail::Message::Head::SpamGroup|Mail::Message:
Each set of fields can be extracted or added as group with objects
which are based on the implementation in this class.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
@@ -47,9 +47,9 @@ Make a copy of this object. The collected fieldnames are copied and the
list type information. No deep copy is made for the header: this is
only copied as reference.
-=item $obj-E<gt>B<from>(HEAD|MESSAGE)
+=item $obj-E<gt>B<from>($head|$message)
-Create a group of fields based on the specified MESSAGE or message HEAD.
+Create a group of fields based on the specified $message or message $head.
This may return one or more of the objects, which depends on the
type of group. Mailing list fields are all stored in one object,
where resent and spam groups can appear more than once.
@@ -61,13 +61,13 @@ where resent and spam groups can appear more than once.
Returns a list of strings containing all possible return values for
L<type()|Mail::Message::Head::FieldGroup/"Access to the header">.
-=item Mail::Message::Head::FieldGroup-E<gt>B<new>(FIELDS, OPTIONS)
+=item Mail::Message::Head::FieldGroup-E<gt>B<new>($fields, %options)
-Construct an object which maintains one set of header FIELDS. The
-FIELDS may be specified as C<Mail::Message::Field> objects or as key-value
-pairs. The OPTIONS and FIELDS (as key-value pair) can be mixed: they are
+Construct an object which maintains one set of header $fields. The
+$fields may be specified as C<Mail::Message::Field> objects or as key-value
+pairs. The %options and $fields (as key-value pair) can be mixed: they are
distinguished by their name, where the fields always start with a capital.
-The field objects must aways lead the OPTIONS.
+The field objects must aways lead the %options.
-Option --Defined in --Default
head undef
@@ -111,7 +111,7 @@ Version number for the software which produced the fields.
=over 4
-=item $obj-E<gt>B<add>((FIELD, VALUE) | OBJECT)
+=item $obj-E<gt>B<add>( <$field, $value> | $object )
Add a field to the header, using the field group. When the field group
is already attached to a real message header, it will appear in that
@@ -130,13 +130,13 @@ example: adding a field to an attached list group
my $lg = Mail::Message::Head::ListGroup->from($msg);
$lg->add('List-Id' => 'mailbox');
-=item $obj-E<gt>B<addFields>([FIELDNAMES])
+=item $obj-E<gt>B<addFields>( [$fieldnames] )
-Add some FIELDNAMES to the set.
+Add some $fieldnames to the set.
-=item $obj-E<gt>B<attach>(HEAD)
+=item $obj-E<gt>B<attach>($head)
-Add a group of fields to a message HEAD. The fields will be cloned(!)
+Add a group of fields to a message $head. The fields will be cloned(!)
into the header, so that the field group object can be used again.
example: attaching a list group to a message
@@ -195,11 +195,11 @@ C<undef>
=over 4
-=item $obj-E<gt>B<collectFields>([NAME])
+=item $obj-E<gt>B<collectFields>( [$name] )
Scan the header for fields which are usually contained in field group
-with the specified NAME. For mailinglist groups, you can not specify
-a NAME: only one set of headers will be found (all headers are considered
+with the specified $name. For mailinglist groups, you can not specify
+a $name: only one set of headers will be found (all headers are considered
to be produced by exactly one package of mailinglist software).
This method is automatically called when a field group is
@@ -212,7 +212,7 @@ was no group to be found.
Please warn the author of MailBox if you see that to few
or too many fields are included.
-=item $obj-E<gt>B<detected>(TYPE, SOFTWARE, VERSION)
+=item $obj-E<gt>B<detected>($type, $software, $version)
Sets the values for the field group type, software, and version,
prossibly to C<undef>.
@@ -221,23 +221,23 @@ prossibly to C<undef>.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Head::FieldGroup-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Head::FieldGroup-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<details>()
@@ -246,61 +246,61 @@ helpful during debugging. A nicely formatted string is returned.
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Head::FieldGroup-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Head::FieldGroup-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Head::FieldGroup-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Head::FieldGroup-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-Print the group to the specified FILEHANDLE or GLOB. This is probably only
+Print the group to the specified $fh or GLOB. This is probably only
useful for debugging purposed. The output defaults to the selected file
handle.
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -320,12 +320,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Message::Head::ListGroup;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Head::FieldGroup';
@@ -29,15 +29,15 @@ this module is taken from Mail::ListDetector, written by
Michael Stevens <mailto:michael@etla.org>. The logic is redesigned to
add flexibility and use the powerful MailBox features.
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Constructors">.
=over 4
@@ -48,25 +48,25 @@ defines the posting address of the mailing list.
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Head::FieldGroup/"Constructors">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Constructors">
-=item $obj-E<gt>B<from>(HEAD|MESSAGE)
+=item $obj-E<gt>B<from>($head|$message)
-Create a C<Mail::Message::Head::ListGroup> based in the specified MESSAGE
-or message HEAD.
+Create a C<Mail::Message::Head::ListGroup> based in the specified $message
+or message $head.
=item $obj-E<gt>B<implementedTypes>()
=item Mail::Message::Head::ListGroup-E<gt>B<implementedTypes>()
-See L<Mail::Message::Head::FieldGroup/"Constructors">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Constructors">
=item $obj-E<gt>B<listname>()
Returns the name of the mailing list, which is usually a part of the
e-mail address which is used to post the messages to.
-=item Mail::Message::Head::ListGroup-E<gt>B<new>(FIELDS, OPTIONS)
+=item Mail::Message::Head::ListGroup-E<gt>B<new>($fields, %options)
Construct an object which maintains one set of mailing list headers
@@ -121,67 +121,67 @@ be C<rfc2919>, C<rfc2369>, or C<undef>.
=head2 The header
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"The header">.
+Extends L<"The header" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"The header">.
=over 4
-=item $obj-E<gt>B<add>((FIELD, VALUE) | OBJECT)
+=item $obj-E<gt>B<add>( <$field, $value> | $object )
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
-=item $obj-E<gt>B<addFields>([FIELDNAMES])
+=item $obj-E<gt>B<addFields>( [$fieldnames] )
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
-=item $obj-E<gt>B<attach>(HEAD)
+=item $obj-E<gt>B<attach>($head)
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<delete>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<fieldNames>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<fields>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<head>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=back
=head2 Access to the header
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Access to the header">.
+Extends L<"Access to the header" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Access to the header">.
=over 4
-=item $obj-E<gt>B<isListGroupFieldName>(NAME)
+=item $obj-E<gt>B<isListGroupFieldName>($name)
-=item Mail::Message::Head::ListGroup-E<gt>B<isListGroupFieldName>(NAME)
+=item Mail::Message::Head::ListGroup-E<gt>B<isListGroupFieldName>($name)
=item $obj-E<gt>B<software>()
-See L<Mail::Message::Head::FieldGroup/"Access to the header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Access to the header">
=item $obj-E<gt>B<type>()
-See L<Mail::Message::Head::FieldGroup/"Access to the header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Access to the header">
=item $obj-E<gt>B<version>()
-See L<Mail::Message::Head::FieldGroup/"Access to the header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Access to the header">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Internals">.
+Extends L<"Internals" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Internals">.
=over 4
@@ -198,31 +198,31 @@ a mailing list message.
Please warn the author of MailBox if you see that to few
or too many fields are included.
-=item $obj-E<gt>B<detected>(TYPE, SOFTWARE, VERSION)
+=item $obj-E<gt>B<detected>($type, $software, $version)
-See L<Mail::Message::Head::FieldGroup/"Internals">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Head::ListGroup-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Head::ListGroup-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<details>()
@@ -231,59 +231,59 @@ helpful during debugging, by default to the selected file handle.
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Head::ListGroup-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Head::ListGroup-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Head::ListGroup-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Head::ListGroup-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Head::FieldGroup/"Error handling">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -386,12 +386,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message::Head::Partial;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Head::Complete';
@@ -21,16 +21,13 @@ sub removeFields(@)
foreach my $match (@_)
{
if(ref $match)
- { $_ =~ $match && delete $known->{$_} foreach keys %$known;
- }
+ { $_ =~ $match && delete $known->{$_} foreach keys %$known }
else { delete $known->{lc $match} }
}
$self->cleanupOrderedFields;
}
-#------------------------------------------
-
sub removeFieldsExcept(@)
{ my $self = shift;
@@ -32,117 +32,117 @@ or sometimes it is not used at all. You then can decide to remove most
of the header information. However, be warned that it will be lost
permanently: the header (and therefore the message) gets mutulated!
-See L<documentation in the base class|Mail::Message::Head::Complete/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Head::Complete/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Head::Complete/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Head::Complete/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Constructors">.
=over 4
-=item $obj-E<gt>B<build>([PAIR|FIELD]-LIST)
+=item $obj-E<gt>B<build>( [PAIR|$field], ... )
-See L<Mail::Message::Head::Complete/"Constructors">
+Inherited, see L<Mail::Message::Head::Complete/"Constructors">
-=item $obj-E<gt>B<clone>([NAMES|ARRAY-OF-NAMES|REGEXS])
+=item $obj-E<gt>B<clone>( [@names|ARRAY|Regexps] )
-See L<Mail::Message::Head::Complete/"Constructors">
+Inherited, see L<Mail::Message::Head::Complete/"Constructors">
-=item Mail::Message::Head::Partial-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Head::Partial-E<gt>B<new>(%options)
-See L<Mail::Message::Head/"Constructors">
+Inherited, see L<Mail::Message::Head/"Constructors">
=back
=head2 The header
-See L<documentation in the base class|Mail::Message::Head::Complete/"The header">.
+Extends L<"The header" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"The header">.
=over 4
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isEmpty>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<knownNames>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Head::Complete/"The header">
+Inherited, see L<Mail::Message::Head::Complete/"The header">
=item $obj-E<gt>B<orderedFields>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Head::Complete/"The header">
+Inherited, see L<Mail::Message::Head::Complete/"The header">
-=item $obj-E<gt>B<wrap>(INTEGER)
+=item $obj-E<gt>B<wrap>($integer)
-See L<Mail::Message::Head::Complete/"The header">
+Inherited, see L<Mail::Message::Head::Complete/"The header">
=back
=head2 Access to the header
-See L<documentation in the base class|Mail::Message::Head::Complete/"Access to the header">.
+Extends L<"Access to the header" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Access to the header">.
=over 4
-=item $obj-E<gt>B<add>(FIELD | LINE | (NAME,BODY[,ATTRS]))
+=item $obj-E<gt>B<add>( $field | $line | <$name, $body, [$attrs]> )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<addListGroup>(OBJECT)
+=item $obj-E<gt>B<addListGroup>($object)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<addResentGroup>(RESENT-GROUP|DATA)
+=item $obj-E<gt>B<addResentGroup>($resent_group|$data)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<addSpamGroup>(OBJECT)
+=item $obj-E<gt>B<addSpamGroup>($object)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<cleanupOrderedFields>()
@@ -160,55 +160,55 @@ L<removeFieldsExcept()|Mail::Message::Head::Partial/"Access to the header">, the
from the ordered list as well. In those cases, this method is called
automatically, however you may have your own reasons to call this method.
-=item $obj-E<gt>B<count>(NAME)
+=item $obj-E<gt>B<count>($name)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<delete>(NAME)
+=item $obj-E<gt>B<delete>($name)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<get>(NAME [,INDEX])
+=item $obj-E<gt>B<get>( $name, [$index] )
-See L<Mail::Message::Head/"Access to the header">
+Inherited, see L<Mail::Message::Head/"Access to the header">
-=item $obj-E<gt>B<grepNames>([NAMES|ARRAY-OF-NAMES|REGEXS])
+=item $obj-E<gt>B<grepNames>( [@names|ARRAY|Regexps] )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<listGroup>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<names>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<printSelected>(FILEHANDLE, (STRING|REGEXP)s)
+=item $obj-E<gt>B<printSelected>($fh, <STRING|Regexp>, ...)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<printUndisclosed>([FILEHANDLE])
+=item $obj-E<gt>B<printUndisclosed>( [$fh] )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeContentInfo>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<removeField>(FIELD)
+=item $obj-E<gt>B<removeField>($field)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<removeFields>(STRING|REGEXP, [STRING|REGEXP, ...])
+=item $obj-E<gt>B<removeFields>( <STRING|Regexp>, ... )
Remove the fields from the header which are exactly named 'STRING' (case
insensitive) or match the REGular EXPresssion. Do not forget to add the
-'i' modifier to the REGEXP, because fields are case insensitive.
+'i' modifier to the Regexp, because fields are case insensitive.
See also L<removeField()|Mail::Message::Head::Complete/"Access to the header"> which is used to remove one field object from
the header. The reverse specification can be made with
@@ -219,12 +219,12 @@ example:
$head->removeFields('bcc', 'received');
$head->removeFields( qr/^content-/i );
-=item $obj-E<gt>B<removeFieldsExcept>(STRING|REGEXP, [STRING|REGEXP, ...])
+=item $obj-E<gt>B<removeFieldsExcept>(STRING|Regexp, ...)
Remove all fields from the header which are not equivalent to one of the
specified STRINGs (case-insensitive) and which are not matching one of
the REGular EXPressions. Do not forget to add the 'i' modifier to the
-REGEXP, because fields are case insensitive.
+Regexp, because fields are case insensitive.
See also L<removeField()|Mail::Message::Head::Complete/"Access to the header"> which is used to remove one field object from
the header. The reverse specification can be made with C<removeFields()>.
@@ -257,201 +257,201 @@ L<Mail::Message::Head::SpamGroup|Mail::Message::Head::SpamGroup>. Returned is t
=item $obj-E<gt>B<resentGroups>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<reset>(NAME, FIELDS)
+=item $obj-E<gt>B<reset>($name, @fields)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<set>(FIELD | LINE | (NAME, BODY [,ATTRS]))
+=item $obj-E<gt>B<set>( $field | $line | <$name, $body, [$attrs]> )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<spamDetected>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<spamGroups>([NAMES])
+=item $obj-E<gt>B<spamGroups>( [$names] )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<study>(NAME [,INDEX])
+=item $obj-E<gt>B<study>( $name, [$index] )
-See L<Mail::Message::Head/"Access to the header">
+Inherited, see L<Mail::Message::Head/"Access to the header">
=back
=head2 About the body
-See L<documentation in the base class|Mail::Message::Head::Complete/"About the body">.
+Extends L<"About the body" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"About the body">.
=over 4
=item $obj-E<gt>B<guessBodySize>()
-See L<Mail::Message::Head/"About the body">
+Inherited, see L<Mail::Message::Head/"About the body">
=item $obj-E<gt>B<guessTimeStamp>()
-See L<Mail::Message::Head::Complete/"About the body">
+Inherited, see L<Mail::Message::Head::Complete/"About the body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message::Head/"About the body">
+Inherited, see L<Mail::Message::Head/"About the body">
=item $obj-E<gt>B<recvstamp>()
-See L<Mail::Message::Head::Complete/"About the body">
+Inherited, see L<Mail::Message::Head::Complete/"About the body">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message::Head::Complete/"About the body">
+Inherited, see L<Mail::Message::Head::Complete/"About the body">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Head::Complete/"Internals">.
+Extends L<"Internals" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Internals">.
=over 4
-=item $obj-E<gt>B<addNoRealize>(FIELD)
+=item $obj-E<gt>B<addNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<addOrderedFields>(FIELDS)
+=item $obj-E<gt>B<addOrderedFields>($fields)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<createFromLine>()
-See L<Mail::Message::Head::Complete/"Internals">
+Inherited, see L<Mail::Message::Head::Complete/"Internals">
=item $obj-E<gt>B<createMessageId>()
-See L<Mail::Message::Head::Complete/"Internals">
+Inherited, see L<Mail::Message::Head::Complete/"Internals">
=item $obj-E<gt>B<fileLocation>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<load>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<messageIdPrefix>([PREFIX, [HOSTNAME]|CODE])
+=item $obj-E<gt>B<messageIdPrefix>( [$prefix, [$hostname]|CODE] )
-=item Mail::Message::Head::Partial-E<gt>B<messageIdPrefix>([PREFIX, [HOSTNAME]|CODE])
+=item Mail::Message::Head::Partial-E<gt>B<messageIdPrefix>( [$prefix, [$hostname]|CODE] )
-See L<Mail::Message::Head::Complete/"Internals">
+Inherited, see L<Mail::Message::Head::Complete/"Internals">
-=item $obj-E<gt>B<moveLocation>(DISTANCE)
+=item $obj-E<gt>B<moveLocation>($distance)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<read>(PARSER)
+=item $obj-E<gt>B<read>($parser)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<setNoRealize>(FIELD)
+=item $obj-E<gt>B<setNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Head::Complete/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Head::Partial-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Head::Partial-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Head::Partial-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Head::Partial-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Head::Partial-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Head::Partial-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Head::Complete/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Head::Complete/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"DETAILS">.
=head2 Ordered header fields
-See L<documentation in the base class|Mail::Message::Head::Complete/"Ordered header fields">.
+Extends L<"Ordered header fields" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Ordered header fields">.
=head2 Head class implementation
-See L<documentation in the base class|Mail::Message::Head::Complete/"Head class implementation">.
+Extends L<"Head class implementation" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Head class implementation">.
=head2 Subsets of header fields
-See L<documentation in the base class|Mail::Message::Head::Complete/"Subsets of header fields">.
+Extends L<"Subsets of header fields" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Subsets of header fields">.
=head2 Reducing the header size
@@ -496,12 +496,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message::Head::ResentGroup;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Head::FieldGroup';
@@ -30,43 +30,43 @@ step in the message transport. Resent groups B<have NOTHING to do> with
user activety; there is no relation to the C<user's> sense of creating
reply, forward, or bounce messages at all!
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Head::FieldGroup/"Constructors">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Constructors">
-=item $obj-E<gt>B<from>([HEAD|MESSAGE, OPTIONS])
+=item $obj-E<gt>B<from>( [<$head|$message>, %options] )
WARNING: this method has two very different purposes. For backward
compatibility reasons, without arguments L<resentFrom()|Mail::Message::Head::ResentGroup/"Access to the header"> is called to
return the C<From> field of this resent group.
With any arguments, a list of C<Mail::Message::Head::ResentGroup> objects
-is returned, taken from the specified MESSAGE or message HEAD.
+is returned, taken from the specified $message or message $head.
=item $obj-E<gt>B<implementedTypes>()
=item Mail::Message::Head::ResentGroup-E<gt>B<implementedTypes>()
-See L<Mail::Message::Head::FieldGroup/"Constructors">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Constructors">
-=item Mail::Message::Head::ResentGroup-E<gt>B<new>([FIELDS], OPTIONS)
+=item Mail::Message::Head::ResentGroup-E<gt>B<new>( [$fields], %options )
Create an object which maintains one set of resent headers. The
-FIELDS are L<Mail::Message::Field|Mail::Message::Field> objects from the same header.
+$fields are L<Mail::Message::Field|Mail::Message::Field> objects from the same header.
-OPTIONS which start with capitals will be used to construct additional
+%options which start with capitals will be used to construct additional
fields. These option names are prepended with C<Resent-*>, keeping the
capitization of what is specified.
@@ -150,40 +150,40 @@ C<head> used in this class is only a container for a subset of fields.
=head2 The header
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"The header">.
+Extends L<"The header" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"The header">.
=over 4
-=item $obj-E<gt>B<add>((FIELD =E<gt> VALUE) | OBJECT)
+=item $obj-E<gt>B<add>( <$field, $value> | $object )
All fields appear only once, so C<add()> behaves as L<set()|Mail::Message::Head::ResentGroup/"The header">.
-=item $obj-E<gt>B<addFields>([FIELDNAMES])
+=item $obj-E<gt>B<addFields>( [$fieldnames] )
Not applicable to resent-groups: the same name can appear in more than
one group. Therefore, a FIELDNAME is sufficiently distinctive.
-=item $obj-E<gt>B<attach>(HEAD)
+=item $obj-E<gt>B<attach>($head)
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<delete>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<fieldNames>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<fields>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<head>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
-=item $obj-E<gt>B<messageHead>([HEAD])
+=item $obj-E<gt>B<messageHead>( [$head] )
Returns (optionally after setting) the real header where this resent group
belongs to. This may be undef at creation, and then later filled in
@@ -196,12 +196,12 @@ to rfc2822. For the C<Resent-*> fields of the group, the order is
not that important, but the C<Return-Path>, C<Delivered-To>, and C<Received>
must come first. Only fields mentioned in the RFC are returned.
-=item $obj-E<gt>B<set>((FIELD =E<gt> VALUE) | OBJECT)
+=item $obj-E<gt>B<set>( <$field, $value> | $object )
-Set a FIELD to a (new) VALUE. The FIELD names which do not start with
+Set a $field to a (new) $value. The $field names which do not start with
'Resent-*' but need it will have that added. It is also an option to
-specify a fully prepared message field OBJECT. In any case, a field
-OBJECT is returned.
+specify a fully prepared message field $object. In any case, a field
+$object is returned.
example:
@@ -219,7 +219,7 @@ example:
=head2 Access to the header
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Access to the header">.
+Extends L<"Access to the header" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Access to the header">.
=over 4
@@ -254,9 +254,9 @@ The field which describes the C<Delivered-To> of this resent group.
Returns a list of all addresses specified in the C<Resent-To>, C<-Cc>, and
C<-Bcc> fields of this resent group.
-=item $obj-E<gt>B<isResentGroupFieldName>(NAME)
+=item $obj-E<gt>B<isResentGroupFieldName>($name)
-=item Mail::Message::Head::ResentGroup-E<gt>B<isResentGroupFieldName>(NAME)
+=item Mail::Message::Head::ResentGroup-E<gt>B<isResentGroupFieldName>($name)
=item $obj-E<gt>B<messageId>()
@@ -292,7 +292,7 @@ returned as L<Mail::Address|Mail::Address> objects.
=item $obj-E<gt>B<software>()
-See L<Mail::Message::Head::FieldGroup/"Access to the header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Access to the header">
=item $obj-E<gt>B<to>()
@@ -302,25 +302,25 @@ L<Mail::Address|Mail::Address> objects.
=item $obj-E<gt>B<type>()
-See L<Mail::Message::Head::FieldGroup/"Access to the header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Access to the header">
=item $obj-E<gt>B<version>()
-See L<Mail::Message::Head::FieldGroup/"Access to the header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Access to the header">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Internals">.
+Extends L<"Internals" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Internals">.
=over 4
-=item $obj-E<gt>B<collectFields>([NAME])
+=item $obj-E<gt>B<collectFields>( [$name] )
-See L<Mail::Message::Head::FieldGroup/"Internals">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Internals">
-=item $obj-E<gt>B<createReceived>([DOMAIN])
+=item $obj-E<gt>B<createReceived>( [$domain] )
Create a received field for this resent group. This is automatically
called if none was specified during creation of this resent group object.
@@ -328,91 +328,91 @@ called if none was specified during creation of this resent group object.
The content of this field is described in RFC2821 section 4.4. It could use
some improvement.
-=item $obj-E<gt>B<detected>(TYPE, SOFTWARE, VERSION)
+=item $obj-E<gt>B<detected>($type, $software, $version)
-See L<Mail::Message::Head::FieldGroup/"Internals">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Head::ResentGroup-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Head::ResentGroup-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<details>()
-See L<Mail::Message::Head::FieldGroup/"Error handling">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Head::ResentGroup-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Head::ResentGroup-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Head::ResentGroup-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Head::ResentGroup-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Head::FieldGroup/"Error handling">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -439,12 +439,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package Mail::Message::Head::SpamGroup;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Head::FieldGroup';
@@ -26,27 +26,27 @@ A I<spam group> is a set of header fields which are added by spam detection
and spam fighting software. This class knows various details about
that software.
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
-See L<Mail::Message::Head::FieldGroup/"Constructors">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Constructors">
-=item $obj-E<gt>B<fighter>(NAME, [SETTINGS])
+=item $obj-E<gt>B<fighter>( $name, [$settings] )
-=item Mail::Message::Head::SpamGroup-E<gt>B<fighter>(NAME, [SETTINGS])
+=item Mail::Message::Head::SpamGroup-E<gt>B<fighter>( $name, [$settings] )
-Get the SETTINGS of a certain spam-fighter, optionally after setting them.
+Get the $settings of a certain spam-fighter, optionally after setting them.
The L<knownFighters()> method returns the defined names. The names
are case-sensitive.
@@ -83,10 +83,10 @@ example: adding your own spam-fighter definitions
isspam => sub { my ($sg, $head) = @_; $head->fields > 100 }
);
-=item $obj-E<gt>B<from>(HEAD|MESSAGE, OPTIONS)
+=item $obj-E<gt>B<from>($head|$message, %options)
Returns a list of C<Mail::Message::Head::SpamGroup> objects, based on the
-specified MESSAGE or message HEAD.
+specified $message or message $head.
-Option--Default
types undef
@@ -100,11 +100,11 @@ list is returned. Without this option, all sets are returned.
=back
-=item $obj-E<gt>B<habeasSweFieldsCorrect>([MESSAGE|HEAD])
+=item $obj-E<gt>B<habeasSweFieldsCorrect>( [$message|$head] )
-=item Mail::Message::Head::SpamGroup-E<gt>B<habeasSweFieldsCorrect>([MESSAGE|HEAD])
+=item Mail::Message::Head::SpamGroup-E<gt>B<habeasSweFieldsCorrect>( [$message|$head] )
-Returns a true value if the MESSAGE or HEAD contains C<Habeas-SWE> fields
+Returns a true value if the $message or $head contains C<Habeas-SWE> fields
which are correct. Without argument, this is used as instance method on
an existing Spam-Group.
@@ -126,11 +126,11 @@ example: checking Habeas-SWE fields
=item Mail::Message::Head::SpamGroup-E<gt>B<implementedTypes>()
-See L<Mail::Message::Head::FieldGroup/"Constructors">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Constructors">
-=item $obj-E<gt>B<isSpamGroupFieldName>(NAME)
+=item $obj-E<gt>B<isSpamGroupFieldName>($name)
-=item Mail::Message::Head::SpamGroup-E<gt>B<isSpamGroupFieldName>(NAME)
+=item Mail::Message::Head::SpamGroup-E<gt>B<isSpamGroupFieldName>($name)
=item $obj-E<gt>B<knownFighters>()
@@ -140,7 +140,7 @@ Returns an unsorted list of all names representing pre-defined spam-fighter
software. You can ask details about them, and register more fighters with
the L<fighter()|Mail::Message::Head::SpamGroup/"Constructors"> method.
-=item Mail::Message::Head::SpamGroup-E<gt>B<new>(FIELDS, OPTIONS)
+=item Mail::Message::Head::SpamGroup-E<gt>B<new>($fields, %options)
Construct an object which maintains one set of fields which were added
by spam fighting software.
@@ -169,7 +169,7 @@ by spam fighting software.
=back
-=item $obj-E<gt>B<spamDetected>([BOOLEAN])
+=item $obj-E<gt>B<spamDetected>( [BOOLEAN] )
Returns (after setting) whether this group of spam headers thinks that
this is spam. See L<Mail::Message::Head::Complete::spamDetected()|Mail::Message::Head::Complete/"Access to the header">.
@@ -186,155 +186,155 @@ example:
=head2 The header
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"The header">.
+Extends L<"The header" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"The header">.
=over 4
-=item $obj-E<gt>B<add>((FIELD, VALUE) | OBJECT)
+=item $obj-E<gt>B<add>( <$field, $value> | $object )
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
-=item $obj-E<gt>B<addFields>([FIELDNAMES])
+=item $obj-E<gt>B<addFields>( [$fieldnames] )
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
-=item $obj-E<gt>B<attach>(HEAD)
+=item $obj-E<gt>B<attach>($head)
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<delete>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<fieldNames>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<fields>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<head>()
-See L<Mail::Message::Head::FieldGroup/"The header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"The header">
=back
=head2 Access to the header
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Access to the header">.
+Extends L<"Access to the header" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Access to the header">.
=over 4
=item $obj-E<gt>B<software>()
-See L<Mail::Message::Head::FieldGroup/"Access to the header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Access to the header">
=item $obj-E<gt>B<type>()
-See L<Mail::Message::Head::FieldGroup/"Access to the header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Access to the header">
=item $obj-E<gt>B<version>()
-See L<Mail::Message::Head::FieldGroup/"Access to the header">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Access to the header">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Internals">.
+Extends L<"Internals" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Internals">.
=over 4
-=item $obj-E<gt>B<collectFields>([NAME])
+=item $obj-E<gt>B<collectFields>( [$name] )
-See L<Mail::Message::Head::FieldGroup/"Internals">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Internals">
-=item $obj-E<gt>B<detected>(TYPE, SOFTWARE, VERSION)
+=item $obj-E<gt>B<detected>($type, $software, $version)
-See L<Mail::Message::Head::FieldGroup/"Internals">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Head::SpamGroup-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Head::SpamGroup-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<details>()
-See L<Mail::Message::Head::FieldGroup/"Error handling">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Head::SpamGroup-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Head::SpamGroup-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Head::SpamGroup-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Head::SpamGroup-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Head::FieldGroup/"Error handling">
+Inherited, see L<Mail::Message::Head::FieldGroup/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Head::FieldGroup|Mail::Message::Head::FieldGroup/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -391,12 +391,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use strict;
package Mail::Message::Head::Subset;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Head';
@@ -21,17 +21,11 @@ use Date::Parse;
sub count($)
{ my ($self, $name) = @_;
-
- my @values = $self->get($name);
-
- return $self->load->count($name)
- unless @values;
-
+ my @values = $self->get($name)
+ or return $self->load->count($name);
scalar @values;
}
-#-------------------------------------------
-
sub get($;$)
{ my $self = shift;
@@ -51,7 +45,6 @@ sub get($;$)
#-------------------------------------------
-
sub guessBodySize()
{ my $self = shift;
@@ -89,9 +82,6 @@ sub guessTimestamp()
#-------------------------------------------
-
sub load() { $_[0] = $_[0]->message->loadHead }
-#------------------------------------------
-
1;
@@ -32,107 +32,107 @@ When you access header fields which are not in the header subset, the whole
header has to be parsed (which may consume considerable time, depending on
the type of folder).
-See L<documentation in the base class|Mail::Message::Head/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Head|Mail::Message::Head/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Head/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Head|Mail::Message::Head/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Head/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Head|Mail::Message::Head/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Head/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Head|Mail::Message::Head/"Constructors">.
=over 4
-=item Mail::Message::Head::Subset-E<gt>B<build>([PAIR|FIELD]-LIST)
+=item Mail::Message::Head::Subset-E<gt>B<build>( [PAIR|$field]-LIST )
-See L<Mail::Message::Head/"Constructors">
+Inherited, see L<Mail::Message::Head/"Constructors">
-=item Mail::Message::Head::Subset-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Head::Subset-E<gt>B<new>(%options)
-See L<Mail::Message::Head/"Constructors">
+Inherited, see L<Mail::Message::Head/"Constructors">
=back
=head2 The header
-See L<documentation in the base class|Mail::Message::Head/"The header">.
+Extends L<"The header" in Mail::Message::Head|Mail::Message::Head/"The header">.
=over 4
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isEmpty>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<knownNames>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<orderedFields>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=back
=head2 Access to the header
-See L<documentation in the base class|Mail::Message::Head/"Access to the header">.
+Extends L<"Access to the header" in Mail::Message::Head|Mail::Message::Head/"Access to the header">.
=over 4
-=item $obj-E<gt>B<count>(NAME)
+=item $obj-E<gt>B<count>($name)
-Count the number of fields with this NAME. If the NAME cannot be found,
-the full header get loaded. In case we find any NAME field, it is
+Count the number of fields with this $name. If the $name cannot be found,
+the full header get loaded. In case we find any $name field, it is
decided we know all of them, and loading is not needed.
-=item $obj-E<gt>B<get>(NAME [,INDEX])
+=item $obj-E<gt>B<get>( $name, [$index] )
-Get the data which is related to the field with the NAME. The case of the
-characters in NAME does not matter. When a NAME is used which is not known
+Get the data which is related to the field with the $name. The case of the
+characters in $name does not matter. When a $name is used which is not known
yet, realization will take place.
-=item $obj-E<gt>B<study>(NAME [,INDEX])
+=item $obj-E<gt>B<study>( $name, [$index] )
-See L<Mail::Message::Head/"Access to the header">
+Inherited, see L<Mail::Message::Head/"Access to the header">
=back
=head2 About the body
-See L<documentation in the base class|Mail::Message::Head/"About the body">.
+Extends L<"About the body" in Mail::Message::Head|Mail::Message::Head/"About the body">.
=over 4
@@ -144,123 +144,123 @@ C<Lines> field. When also that field is not known yet, C<undef> is returned.
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message::Head/"About the body">
+Inherited, see L<Mail::Message::Head/"About the body">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Head/"Internals">.
+Extends L<"Internals" in Mail::Message::Head|Mail::Message::Head/"Internals">.
=over 4
-=item $obj-E<gt>B<addNoRealize>(FIELD)
+=item $obj-E<gt>B<addNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<addOrderedFields>(FIELDS)
+=item $obj-E<gt>B<addOrderedFields>($fields)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<fileLocation>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<load>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<moveLocation>(DISTANCE)
+=item $obj-E<gt>B<moveLocation>($distance)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<read>(PARSER)
+=item $obj-E<gt>B<read>($parser)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<setNoRealize>(FIELD)
+=item $obj-E<gt>B<setNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Head/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Head|Mail::Message::Head/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Head::Subset-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Head::Subset-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Head::Subset-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Head::Subset-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Head::Subset-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Head::Subset-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Head/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Head|Mail::Message::Head/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Head/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Head|Mail::Message::Head/"DETAILS">.
=head1 DIAGNOSTICS
@@ -278,12 +278,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Head;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -98,7 +98,7 @@ sub message(;$)
}
-sub orderedFields() { grep {defined $_} @{shift->{MMH_order}} }
+sub orderedFields() { grep defined $_, @{shift->{MMH_order}} }
sub knownNames() { keys %{shift->{MMH_fields}} }
@@ -37,13 +37,13 @@ Other kinds of headers will be translated to that type when time comes.
On this page, the general methods which are available on any header are
described. Read about differences in the sub-class specific pages.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 OVERLOADED
=over 4
-=item overload: B<"">()
+=item overload: B<"">
(stringifaction) The header, when used as string, will format as if
L<Mail::Message::Head::Complete::string()|Mail::Message::Head::Complete/"Access to the header"> was called, so return a
@@ -58,7 +58,7 @@ example: using a header object as string
print "$head"; # explicit stringication
-=item overload: B<bool>()
+=item overload: B<bool>
When the header does not contain any lines (which is illegal, according
to the RFCs), false is returned. In all other cases, a true value is
@@ -68,15 +68,15 @@ produced.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Message::Head-E<gt>B<build>([PAIR|FIELD]-LIST)
+=item Mail::Message::Head-E<gt>B<build>( [PAIR|$field]-LIST )
A fast way to construct a header with many lines.
The PAIRs are C<(name, content)> pairs of the header, but it is also possible
@@ -100,7 +100,7 @@ example:
print ref $head;
# --> Mail::Message::Head::Complete
-=item Mail::Message::Head-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Head-E<gt>B<new>(%options)
Create a new message header object. The object will store all the
fields of a header. When you get information from the header, it
@@ -171,12 +171,12 @@ Like L<Mail::Message::Head::Complete::names()|Mail::Message::Head::Complete/"Acc
header fields, which may be less than C<names> for header types which are
partial. C<names()> will trigger completion, where C<knownNames()> does not.
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
Get (after setting) the message where this header belongs to.
This does not trigger completion.
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
Sets the modified flag to BOOLEAN. Without value, the current setting is
returned, but in that case you can better use L<isModified()|Mail::Message::Head/"The header">.
@@ -198,14 +198,14 @@ Retuns the fields ordered the way they were read or added.
=over 4
-=item $obj-E<gt>B<get>(NAME [,INDEX])
+=item $obj-E<gt>B<get>( $name, [$index] )
-Get the data which is related to the field with the NAME. The case of the
-characters in NAME does not matter.
+Get the data which is related to the field with the $name. The case of the
+characters in $name does not matter.
-If there is only one data element defined for the NAME, or if there is an
-INDEX specified as the second argument, only the specified element will be
-returned. If the field NAME matches more than one header the return value
+If there is only one data element defined for the $name, or if there is an
+$index specified as the second argument, only the specified element will be
+returned. If the field $name matches more than one header the return value
depends on the context. In LIST context, all values will be returned in
the order they are read. In SCALAR context, only the last value will be
returned.
@@ -225,13 +225,13 @@ example:
my $sub_scalar = $head->get('Subject');
print ",@sub_list,$sub_scalar," # ,greetings, greetings,
-=item $obj-E<gt>B<study>(NAME [,INDEX])
+=item $obj-E<gt>B<study>( $name, [$index] )
Like L<get()|Mail::Message::Head/"Access to the header">, but puts more effort in understanding the contents of the
field. L<Mail::Message::Field::study()|Mail::Message::Field/"Access to the content"> will be called for the field
with the specified FIELDNAME, which returns L<Mail::Message::Field::Full|Mail::Message::Field::Full>
objects. In scalar context only the last field with that name is returned.
-When an INDEX is specified, that element is returned.
+When an $index is specified, that element is returned.
=back
@@ -257,14 +257,14 @@ May trigger completion, when the C<Content-Type> field is not defined.
=over 4
-=item $obj-E<gt>B<addNoRealize>(FIELD)
+=item $obj-E<gt>B<addNoRealize>($field)
Add a field, like L<Mail::Message::Head::Complete::add()|Mail::Message::Head::Complete/"Access to the header"> does, but
avoid the loading of a possibly partial header. This method does not
test the validity of the argument, nor flag the header as changed.
This does not trigger completion.
-=item $obj-E<gt>B<addOrderedFields>(FIELDS)
+=item $obj-E<gt>B<addOrderedFields>($fields)
=item $obj-E<gt>B<fileLocation>()
@@ -277,17 +277,17 @@ the header.
Be sure that the header is loaded. This returns the loaded header
object.
-=item $obj-E<gt>B<moveLocation>(DISTANCE)
+=item $obj-E<gt>B<moveLocation>($distance)
Move the registration of the header in the file.
-=item $obj-E<gt>B<read>(PARSER)
+=item $obj-E<gt>B<read>($parser)
Read the header information of one message into this header structure. This
method is called by the folder object (some L<Mail::Box|Mail::Box> sub-class), which
-passes the PARSER as an argument.
+passes the $parser as an argument.
-=item $obj-E<gt>B<setNoRealize>(FIELD)
+=item $obj-E<gt>B<setNoRealize>($field)
Set a field, but avoid the loading of a possibly partial header as set()
does. This method does not test the validity of the argument, nor flag the
@@ -297,75 +297,75 @@ header as changed. This does not trigger completion.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Head-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Head-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Head-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Head-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Head-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Head-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -473,12 +473,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Part;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message';
@@ -33,23 +33,23 @@ READ L<Mail::Message|Mail::Message> FIRST. A part is a special message: it has
reference to its parent message, and will usually not be sub-classed
into mail folder specific variants.
-See L<documentation in the base class|Mail::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message|Mail::Message/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Message|Mail::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Message|Mail::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
-=item Mail::Message::Part-E<gt>B<new>(OPTIONS)
+=item Mail::Message::Part-E<gt>B<new>(%options)
Create a message part.
@@ -106,23 +106,23 @@ or a L<Mail::Message::Body::Nested|Mail::Message::Body::Nested>.
=head2 Constructing a message
-See L<documentation in the base class|Mail::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Message|Mail::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Message::Part-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Message::Part-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Message::Part-E<gt>B<buildFromBody>(BODY, CONTAINER, HEADERS)
+=item Mail::Message::Part-E<gt>B<buildFromBody>($body, $container, $headers)
-Shape a message part around a BODY. Bodies have information about their
+Shape a message part around a $body. Bodies have information about their
content in them, which is used to construct a header for the message.
-Next to that, more HEADERS can be specified. No headers are obligatory.
+Next to that, more $headers can be specified. No headers are obligatory.
No extra headers are fabricated automatically.
example:
@@ -130,414 +130,414 @@ example:
my $multi = Mail::Message::Body::Multipart->new;
my $part = Mail::Message::Part->buildFromBody($body, $multi);
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Message::Part-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Message::Part-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Message::Part-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
-See L<documentation in the base class|Mail::Message/"The message">.
+Extends L<"The message" in Mail::Message|Mail::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<printEscapedFrom>(FILEHANDLE)
+=item $obj-E<gt>B<printEscapedFrom>($fh)
Prints the message part, but all lines which start with 'From ' will get
a leading E<gt>. See L<Mail::Message::Body::printEscapedFrom()|Mail::Message::Body/"Access to the payload">.
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<size>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=back
=head2 The header
-See L<documentation in the base class|Mail::Message/"The header">.
+Extends L<"The header" in Mail::Message|Mail::Message/"The header">.
=over 4
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Message/"The body">.
+Extends L<"The body" in Mail::Message|Mail::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=back
=head2 Flags
-See L<documentation in the base class|Mail::Message/"Flags">.
+Extends L<"Flags" in Mail::Message|Mail::Message/"Flags">.
=over 4
=item $obj-E<gt>B<delete>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Message|Mail::Message/"The whole message as text">.
=over 4
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message/"Internals">.
+Extends L<"Internals" in Mail::Message|Mail::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Message::Part-E<gt>B<coerce>(BODY|MESSAGE, MULTIPART, HEADERS)
+=item Mail::Message::Part-E<gt>B<coerce>( <$body|$message>, $multipart, @headers )
-Transforms a BODY or MESSAGE to a real message part. The MULTIPART
+Transforms a $body or $message to a real message part. The $multipart
refers to the parental body.
-When ta BODY is specified, extra HEADERS can be supplied as well.
+When ta $body is specified, extra @headers can be supplied as well.
Bodies are coerced into message parts by calling L<buildFromBody()|Mail::Message::Part/"METHODS">.
-If you specify a MESSAGE residing in a folder, this message will
+If you specify a $message residing in a folder, this message will
automatically be cloned.
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Message|Mail::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Part-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Part-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Part-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Part-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Part-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Part-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Message::Part-E<gt>B<shortSize>([VALUE])
+=item Mail::Message::Part-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message|Mail::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
@@ -550,7 +550,7 @@ you may cosider L<rebuild()|Mail::Message::Construct::Rebuild/"Constructing a me
=head1 DETAILS
-See L<documentation in the base class|Mail::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message|Mail::Message/"DETAILS">.
=head1 DIAGNOSTICS
@@ -615,12 +615,12 @@ be forcefully freed from memory. Consider L<delete()|Mail::Message/"Flags"> or L
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::Replace::MailHeader;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::Head::Complete';
@@ -33,45 +33,45 @@ Most methods will work without any change, but you should test your
software again. Small changes have been made to L<fold_length()|Mail::Message::Replace::MailHeader/"Simulating Mail::Header">,
L<header_hashref()|Mail::Message::Replace::MailHeader/"Simulating Mail::Header">.
-See L<documentation in the base class|Mail::Message::Head::Complete/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"DESCRIPTION">.
=head1 OVERLOADED
-See L<documentation in the base class|Mail::Message::Head::Complete/"OVERLOADED">.
+Extends L<"OVERLOADED" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"OVERLOADED">.
=over 4
-=item overload: B<"">()
+=item overload: B<"">
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
-=item overload: B<bool>()
+=item overload: B<bool>
-See L<Mail::Message::Head/"OVERLOADED">
+Inherited, see L<Mail::Message::Head/"OVERLOADED">
=back
=head1 METHODS
-See L<documentation in the base class|Mail::Message::Head::Complete/"METHODS">.
+Extends L<"METHODS" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::Head::Complete/"Constructors">.
+Extends L<"Constructors" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Constructors">.
=over 4
-=item $obj-E<gt>B<build>([PAIR|FIELD]-LIST)
+=item $obj-E<gt>B<build>( [PAIR|$field], ... )
-See L<Mail::Message::Head::Complete/"Constructors">
+Inherited, see L<Mail::Message::Head::Complete/"Constructors">
-=item $obj-E<gt>B<clone>([NAMES|ARRAY-OF-NAMES|REGEXS])
+=item $obj-E<gt>B<clone>( [@names|ARRAY|Regexps] )
-See L<Mail::Message::Head::Complete/"Constructors">
+Inherited, see L<Mail::Message::Head::Complete/"Constructors">
-=item Mail::Message::Replace::MailHeader-E<gt>B<new>([ARG], OPTIONS)
+=item Mail::Message::Replace::MailHeader-E<gt>B<new>( [$arg], %options )
-The ARG is an array with header lines.
+The $arg is an array with header lines.
-Option --Defined in --Default
FoldLength 79
@@ -111,325 +111,325 @@ Reformat all header lines when they come in: change the folding.
=head2 The header
-See L<documentation in the base class|Mail::Message::Head::Complete/"The header">.
+Extends L<"The header" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"The header">.
=over 4
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isEmpty>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<knownNames>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<message>([MESSAGE])
+=item $obj-E<gt>B<message>( [$message] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message::Head::Complete/"The header">
+Inherited, see L<Mail::Message::Head::Complete/"The header">
=item $obj-E<gt>B<orderedFields>()
-See L<Mail::Message::Head/"The header">
+Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<size>()
-See L<Mail::Message::Head::Complete/"The header">
+Inherited, see L<Mail::Message::Head::Complete/"The header">
-=item $obj-E<gt>B<wrap>(INTEGER)
+=item $obj-E<gt>B<wrap>($integer)
-See L<Mail::Message::Head::Complete/"The header">
+Inherited, see L<Mail::Message::Head::Complete/"The header">
=back
=head2 Access to the header
-See L<documentation in the base class|Mail::Message::Head::Complete/"Access to the header">.
+Extends L<"Access to the header" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Access to the header">.
=over 4
-=item $obj-E<gt>B<add>(LINE, [INDEX])
+=item $obj-E<gt>B<add>( $line, [$index] )
Add a header line, which simply calls C<Mail::Message::Head::add()> on
-the header for the specified LINE. The INDEX is ignored, the unfolded
+the header for the specified $line. The $index is ignored, the unfolded
body of the field is returned.
-=item $obj-E<gt>B<addListGroup>(OBJECT)
+=item $obj-E<gt>B<addListGroup>($object)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<addResentGroup>(RESENT-GROUP|DATA)
+=item $obj-E<gt>B<addResentGroup>($resent_group|$data)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<addSpamGroup>(OBJECT)
+=item $obj-E<gt>B<addSpamGroup>($object)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<count>(NAME)
+=item $obj-E<gt>B<count>($name)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<delete>(TAG, [INDEX])
+=item $obj-E<gt>B<delete>( $tag, [$index] )
-Delete the fields with the specified TAG. The deleted fields are
+Delete the fields with the specified $tag. The deleted fields are
returned. If no index is given, then all are removed.
-=item $obj-E<gt>B<get>(NAME, [INDEX])
+=item $obj-E<gt>B<get>( $name, [$index] )
-Get all the header fields with the specified NAME. In scalar context,
-only the first fitting NAME is returned. Even when only one NAME is
+Get all the header fields with the specified $name. In scalar context,
+only the first fitting $name is returned. Even when only one $name is
specified, multiple lines may be returned in list context: some fields
appear more than once in a header.
-=item $obj-E<gt>B<grepNames>([NAMES|ARRAY-OF-NAMES|REGEXS])
+=item $obj-E<gt>B<grepNames>( [@names|ARRAY|Regexps] )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<listGroup>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<names>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<printSelected>(FILEHANDLE, (STRING|REGEXP)s)
+=item $obj-E<gt>B<printSelected>($fh, <STRING|Regexp>, ...)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<printUndisclosed>([FILEHANDLE])
+=item $obj-E<gt>B<printUndisclosed>( [$fh] )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeContentInfo>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<removeField>(FIELD)
+=item $obj-E<gt>B<removeField>($field)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<removeFields>(STRING|REGEXP, [STRING|REGEXP, ...])
+=item $obj-E<gt>B<removeFields>( <STRING|Regexp>, ... )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<removeFieldsExcept>(STRING|REGEXP, [STRING|REGEXP, ...])
+=item $obj-E<gt>B<removeFieldsExcept>( <STRING|Regexp>, ... )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeListGroup>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeResentGroups>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeSpamGroups>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<replace>(TAG, LINE, [INDEX])
+=item $obj-E<gt>B<replace>( $tag, $line, [$index] )
-Replace the field named TAG. from place INDEX (by default the first) by
-the LINE. When TAG is C<undef>, it will be extracted from the LINE first.
+Replace the field named $tag. from place $index (by default the first) by
+the $line. When $tag is C<undef>, it will be extracted from the $line first.
This calls L<Mail::Message::Head::Complete::reset()|Mail::Message::Head::Complete/"Access to the header"> on the message's head.
=item $obj-E<gt>B<resentGroups>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<reset>(NAME, FIELDS)
+=item $obj-E<gt>B<reset>($name, @fields)
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<set>(FIELD | LINE | (NAME, BODY [,ATTRS]))
+=item $obj-E<gt>B<set>( $field | $line | <$name, $body, [$attrs]> )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<spamDetected>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<spamGroups>([NAMES])
+=item $obj-E<gt>B<spamGroups>( [$names] )
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Head::Complete/"Access to the header">
+Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
-=item $obj-E<gt>B<study>(NAME [,INDEX])
+=item $obj-E<gt>B<study>( $name, [$index] )
-See L<Mail::Message::Head/"Access to the header">
+Inherited, see L<Mail::Message::Head/"Access to the header">
=back
=head2 About the body
-See L<documentation in the base class|Mail::Message::Head::Complete/"About the body">.
+Extends L<"About the body" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"About the body">.
=over 4
=item $obj-E<gt>B<guessBodySize>()
-See L<Mail::Message::Head/"About the body">
+Inherited, see L<Mail::Message::Head/"About the body">
=item $obj-E<gt>B<guessTimeStamp>()
-See L<Mail::Message::Head::Complete/"About the body">
+Inherited, see L<Mail::Message::Head::Complete/"About the body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message::Head/"About the body">
+Inherited, see L<Mail::Message::Head/"About the body">
=item $obj-E<gt>B<recvstamp>()
-See L<Mail::Message::Head::Complete/"About the body">
+Inherited, see L<Mail::Message::Head::Complete/"About the body">
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message::Head::Complete/"About the body">
+Inherited, see L<Mail::Message::Head::Complete/"About the body">
=back
=head2 Internals
-See L<documentation in the base class|Mail::Message::Head::Complete/"Internals">.
+Extends L<"Internals" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Internals">.
=over 4
-=item $obj-E<gt>B<addNoRealize>(FIELD)
+=item $obj-E<gt>B<addNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<addOrderedFields>(FIELDS)
+=item $obj-E<gt>B<addOrderedFields>($fields)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<createFromLine>()
-See L<Mail::Message::Head::Complete/"Internals">
+Inherited, see L<Mail::Message::Head::Complete/"Internals">
=item $obj-E<gt>B<createMessageId>()
-See L<Mail::Message::Head::Complete/"Internals">
+Inherited, see L<Mail::Message::Head::Complete/"Internals">
=item $obj-E<gt>B<fileLocation>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<load>()
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<messageIdPrefix>([PREFIX, [HOSTNAME]|CODE])
+=item $obj-E<gt>B<messageIdPrefix>( [$prefix, [$hostname]|CODE] )
-=item Mail::Message::Replace::MailHeader-E<gt>B<messageIdPrefix>([PREFIX, [HOSTNAME]|CODE])
+=item Mail::Message::Replace::MailHeader-E<gt>B<messageIdPrefix>( [$prefix, [$hostname]|CODE] )
-See L<Mail::Message::Head::Complete/"Internals">
+Inherited, see L<Mail::Message::Head::Complete/"Internals">
-=item $obj-E<gt>B<moveLocation>(DISTANCE)
+=item $obj-E<gt>B<moveLocation>($distance)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
-=item $obj-E<gt>B<setNoRealize>(FIELD)
+=item $obj-E<gt>B<setNoRealize>($field)
-See L<Mail::Message::Head/"Internals">
+Inherited, see L<Mail::Message::Head/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::Head::Complete/"Error handling">.
+Extends L<"Error handling" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Replace::MailHeader-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Replace::MailHeader-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Replace::MailHeader-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Replace::MailHeader-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Replace::MailHeader-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Replace::MailHeader-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::Head::Complete/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -448,7 +448,7 @@ Calls L<Mail::Message::Head::Complete::string()|Mail::Message::Head::Complete/"A
Cleanup memory usage. Not needed here.
-=item $obj-E<gt>B<combine>(TAG, [WITH])
+=item $obj-E<gt>B<combine>( $tag, [$with] )
I do not see any valid reason for this command, so did not implement it.
@@ -469,19 +469,19 @@ Returns whether there are any fields.
Extract (and remove) header fields from the array.
-=item $obj-E<gt>B<fold>([LENGTH])
+=item $obj-E<gt>B<fold>( [$length] )
-Refold all fields in the header, to LENGTH or whatever L<fold_length()|Mail::Message::Replace::MailHeader/"Simulating Mail::Header">
+Refold all fields in the header, to $length or whatever L<fold_length()|Mail::Message::Replace::MailHeader/"Simulating Mail::Header">
returns.
-=item $obj-E<gt>B<fold_length>([[TAG], LENGTH])
+=item $obj-E<gt>B<fold_length>( [[$tag], $length] )
-Returns the line wrap, optionally after setting it to LENGTH. The
-old value is returned. The TAG argument is ignored, because it is
+Returns the line wrap, optionally after setting it to $length. The
+old value is returned. The $tag argument is ignored, because it is
silly to have different lines fold in different ways. This method
cannot be called statically anymore.
-=item $obj-E<gt>B<header>([ARRAY])
+=item $obj-E<gt>B<header>( [ARRAY] )
Extract the fields from the ARRAY, if specified, and then fold the fields.
Returned is an array with all fields, produced via L<orderedFields()|Mail::Message::Head/"The header">.
@@ -491,29 +491,29 @@ Returned is an array with all fields, produced via L<orderedFields()|Mail::Messa
If you are using this method, you must be stupid... anyway: I do not want to
support it for now: use L<add()|Mail::Message::Replace::MailHeader/"Access to the header"> and friends.
-=item $obj-E<gt>B<mail_from>(['IGNORE'|'ERROR'|'COERCE'|'KEEP'])
+=item $obj-E<gt>B<mail_from>( ['IGNORE'|'ERROR'|'COERCE'|'KEEP'] )
What to do when a header line in the form `From ' is encountered. Valid
values are C<IGNORE> - ignore and discard the header, C<ERROR> - invoke
an error (call die), C<COERCE> - rename them as Mail-From and C<KEEP>
- keep them.
-=item $obj-E<gt>B<modify>([BOOLEAN])
+=item $obj-E<gt>B<modify>( [BOOLEAN] )
Refold the headers when they are added.
-=item $obj-E<gt>B<read>(FILE)
+=item $obj-E<gt>B<read>($file)
-Read the header from the FILE.
+Read the header from the $file.
=item $obj-E<gt>B<tags>()
Returns all the names of fields, implemented by
L<Mail::Message::Head::Complete::names()|Mail::Message::Head::Complete/"Access to the header">.
-=item $obj-E<gt>B<unfold>([TAG])
+=item $obj-E<gt>B<unfold>( [$tag] )
-Remove the folding for all instances of TAG, or all fields at once.
+Remove the folding for all instances of $tag, or all fields at once.
=back
@@ -521,9 +521,9 @@ Remove the folding for all instances of TAG, or all fields at once.
=over 4
-=item $obj-E<gt>B<isa>(CLASS)
+=item $obj-E<gt>B<isa>($class)
-=item Mail::Message::Replace::MailHeader-E<gt>B<isa>(CLASS)
+=item Mail::Message::Replace::MailHeader-E<gt>B<isa>($class)
Of course, the C<isa()> class inheritance check should not see our
nasty trick.
@@ -532,7 +532,7 @@ nasty trick.
=head1 DETAILS
-See L<documentation in the base class|Mail::Message::Head::Complete/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"DETAILS">.
=head1 DIAGNOSTICS
@@ -558,12 +558,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::Replace::MailInternet;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message';
@@ -30,23 +30,23 @@ and many methods are added.
Most methods will work without any change, but you may need to have
a look at your L<smtpsend()|Mail::Message::Replace::MailInternet/"The body"> and L<send()|Mail::Message::Replace::MailInternet/"The message"> calls.
-See L<documentation in the base class|Mail::Message/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message|Mail::Message/"DESCRIPTION">.
=head1 OVERLOADED
=head1 METHODS
-See L<documentation in the base class|Mail::Message/"METHODS">.
+Extends L<"METHODS" in Mail::Message|Mail::Message/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message/"Constructors">.
+Extends L<"Constructors" in Mail::Message|Mail::Message/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
-See L<Mail::Message/"Constructors">
+Inherited, see L<Mail::Message/"Constructors">
=item $obj-E<gt>B<dup>()
@@ -57,7 +57,7 @@ compatible object.
Remove all data from this object. Very dangerous!
-=item Mail::Message::Replace::MailInternet-E<gt>B<new>([ARG], [OPTIONS])
+=item Mail::Message::Replace::MailInternet-E<gt>B<new>( [$arg], [%options] )
-Option --Defined in --Default
Body undef
@@ -83,7 +83,7 @@ Remove all data from this object. Very dangerous!
=item Body => ARRAY-OF-LINES
Array of C<"\n"> terminated lines. If not specified, the lines will be
-read from ARG.
+read from $arg.
=item FoldLength => INTEGER
@@ -94,7 +94,7 @@ Passed to L<Mail::Message::Replace::MailHeader::new(FoldLength)|Mail::Message::R
The L<Mail::Header> object, which is passed here, is a fake one as well...
It is translated into a L<new(head)|Mail::Message/"Constructors">. If not given, the header will be
-parsed from the ARG.
+parsed from the $arg.
=item MailFrom => 'IGNORE'|'ERROR'|'COERCE'|'KEEP'
@@ -148,7 +148,7 @@ example: replace traditional Mail::Internet by this wrapper
=over 4
-=item $obj-E<gt>B<MailFrom>([STRING])
+=item $obj-E<gt>B<MailFrom>( [STRING] )
Your email address.
@@ -156,70 +156,70 @@ Your email address.
=head2 Constructing a message
-See L<documentation in the base class|Mail::Message/"Constructing a message">.
+Extends L<"Constructing a message" in Mail::Message|Mail::Message/"Constructing a message">.
=over 4
-=item $obj-E<gt>B<add_signature>([FILENAME])
+=item $obj-E<gt>B<add_signature>( [$filename] )
-Replaced by L<sign()|Mail::Message::Replace::MailInternet/"Constructing a message">, but still usable. FILENAME is the file which
+Replaced by L<sign()|Mail::Message::Replace::MailInternet/"Constructing a message">, but still usable. $filename is the file which
contains the signature, which defaults to C<$ENV{HOME}/.signature>.
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Message::Replace::MailInternet-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Message::Replace::MailInternet-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Message::Replace::MailInternet-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Message::Replace::MailInternet-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<extract>(ARRAY or FILEHANDLE)
+=item $obj-E<gt>B<extract>(ARRAY|$fh)
-Read header and body from an ARRAY or FILEHANDLE
+Read header and body from an ARRAY or $fh
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<read>(ARRAY|FILEHANDLE, OPTIONS)
+=item $obj-E<gt>B<read>(ARRAY|$fh, %options)
-=item Mail::Message::Replace::MailInternet-E<gt>B<read>(ARRAY|FILEHANDLE, OPTIONS)
+=item Mail::Message::Replace::MailInternet-E<gt>B<read>(ARRAY|$fh, %options)
-Read header and body from the specified ARRAY or FILEHANDLE. When used as
+Read header and body from the specified ARRAY or $fh. When used as
object method, L<Mail::Message::read()|Mail::Message::Construct::Read/"Constructing a message"> is called, to be MailBox compliant.
-As class method, the Mail::Internet compatible read is called. OPTIONS are
+As class method, the Mail::Internet compatible read is called. %options are
only available in the first case.
-Option --Defined in --Default
@@ -234,19 +234,19 @@ only available in the first case.
=back
-=item $obj-E<gt>B<read_body>(ARRAY|FILEHANDLE)
+=item $obj-E<gt>B<read_body>(ARRAY|$fh)
-Read only the message's body from the ARRAY or FILEHANDLE.
+Read only the message's body from the ARRAY or $fh.
-=item $obj-E<gt>B<read_header>(ARRAY|FILEHANDLE)
+=item $obj-E<gt>B<read_header>(ARRAY|$fh)
-Read only the message's header from the ARRAY or FILEHANDLE
+Read only the message's header from the ARRAY or $fh
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
BE WARNED: the main job for creating a reply is done by
L<Mail::Message::reply()|Mail::Message::Construct::Reply/"Constructing a message">, which may produce a result which is compatible,
@@ -335,17 +335,17 @@ set to C<undef>, or the file does not exist, then a header will be created.
=back
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Message::Replace::MailInternet-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<sign>(OPTIONS)
+=item $obj-E<gt>B<sign>(%options)
Add a signature (a few extra lines) to the message.
@@ -369,27 +369,27 @@ The signature in memory.
=head2 The message
-See L<documentation in the base class|Mail::Message/"The message">.
+Extends L<"The message" in Mail::Message|Mail::Message/"The message">.
=over 4
=item $obj-E<gt>B<container>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isDummy>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<nntppost>(OPTIONS)
+=item $obj-E<gt>B<nntppost>(%options)
Send an NNTP message (newsgroup message), which is equivalent to
Mail::Transport::NNTP or L<Mail::Message::send()|Mail::Message/"The message"> with C<via 'nntp'>.
@@ -411,69 +411,69 @@ Mail::Transport::NNTP or L<Mail::Message::send()|Mail::Message/"The message"> wi
=item $obj-E<gt>B<partNumber>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
-Prints the whole message to the specified FILEHANDLE, which default to
+Prints the whole message to the specified $fh, which default to
STDOUT. This calls L<Mail::Message::print()|Mail::Message/"The message">.
-=item $obj-E<gt>B<send>(TYPE, OPTIONS)
+=item $obj-E<gt>B<send>($type, %options)
Send via Mail Transfer Agents (MUA). These will be handled by various
-L<Mail::Transport::Send|Mail::Transport::Send> extensions. The C<test> TYPE is not supported.
+L<Mail::Transport::Send|Mail::Transport::Send> extensions. The C<test> $type is not supported.
=item $obj-E<gt>B<size>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>()
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
-See L<Mail::Message/"The message">
+Inherited, see L<Mail::Message/"The message">
=back
=head2 The header
-See L<documentation in the base class|Mail::Message/"The header">.
+Extends L<"The header" in Mail::Message|Mail::Message/"The header">.
=over 4
-=item $obj-E<gt>B<add>(LINES)
+=item $obj-E<gt>B<add>($lines)
Add header lines, which simply calls C<Mail::Message::Head::add()> on
the header for each specified LINE. The last added LINE is returned.
=item $obj-E<gt>B<bcc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<clean_header>()
Not to be used, replaced by L<header()|Mail::Message::Replace::MailInternet/"The header">.
-=item $obj-E<gt>B<combine>(TAG, [WITH])
+=item $obj-E<gt>B<combine>( $tag, [$with] )
Not implemented, because I see no use for it.
=item $obj-E<gt>B<date>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<delete>(NAME, [INDEX]])
+=item $obj-E<gt>B<delete>( $name, [$index]] )
-Delete the fields with the specified NAME. The deleted fields are
+Delete the fields with the specified $name. The deleted fields are
returned.
-BE WARNED: if no NAME is specified, the C<delete> is interpreted as
+BE WARNED: if no $name is specified, the C<delete> is interpreted as
the deletion of the message in a folder, so L<Mail::Box::Message::delete()|Mail::Message/"Flags">
will be called. This may have no negative effect at all...
@@ -481,41 +481,41 @@ Calls L<Mail::Message::Replace::MailHeader::delete()|Mail::Message::Replace::Mai
=item $obj-E<gt>B<destinations>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<fold>([LENGTH])
+=item $obj-E<gt>B<fold>( [$length] )
-Fold all the fields to a certain maximum LENGTH.
+Fold all the fields to a certain maximum $length.
Implemented by L<Mail::Message::Replace::MailHeader::fold()|Mail::Message::Replace::MailHeader/"Simulating Mail::Header">
-=item $obj-E<gt>B<fold_length>([[TAG], LENGTH])
+=item $obj-E<gt>B<fold_length>( [[$tag], $length] )
-Set the maximum line LENGTH. TAG is ignored.
+Set the maximum line $length. $tag is ignored.
Implemented by L<Mail::Message::Replace::MailHeader::fold_length()|Mail::Message::Replace::MailHeader/"Simulating Mail::Header">
=item $obj-E<gt>B<from>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<get>(NAME, [INDEX])
+=item $obj-E<gt>B<get>( $name, [$index] )
-Get all the header fields with the specified NAME. In scalar context,
-only the first fitting NAME is returned. Even when only one NAME is
+Get all the header fields with the specified $name. In scalar context,
+only the first fitting $name is returned. Even when only one $name is
specified, multiple lines may be returned: some fields appear more than
once in a header. Calls L<Mail::Message::Replace::MailHeader::get()|Mail::Message::Replace::MailHeader/"Access to the header">
=item $obj-E<gt>B<guessTimestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
Returns the head of the message, or creates an empty one if none is
-defined. The HEAD argument, which sets the header, is not available
+defined. The $head argument, which sets the header, is not available
for L<Mail::Internet>, but is there to be compatible with the C<head>
method of L<Mail::Message|Mail::Message>.
-=item $obj-E<gt>B<header>([ARRAY])
+=item $obj-E<gt>B<header>( [ARRAY] )
Optionally reads a header from the ARRAY, and then returns those fields
as array-ref nicely folded.
@@ -523,28 +523,28 @@ Implemented by L<Mail::Message::Replace::MailHeader::header()|Mail::Message::Rep
=item $obj-E<gt>B<nrLines>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<print_header>(FILEHANDLE)
+=item $obj-E<gt>B<print_header>($fh)
Calls L<Mail::Message::Head::Complete::print()|Mail::Message::Head::Complete/"Access to the header">.
-=item $obj-E<gt>B<replace>(TAG, LINE, [INDEX])
+=item $obj-E<gt>B<replace>( $tag, $line, [$index] )
Adds LINES to the header, but removes fields with the same name if they
already exist. Calls L<Mail::Message::Replace::MailHeader::replace()|Mail::Message::Replace::MailHeader/"Access to the header">
=item $obj-E<gt>B<sender>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<tidy_headers>()
@@ -552,23 +552,23 @@ No effect anymore (always performed).
=item $obj-E<gt>B<timestamp>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=item $obj-E<gt>B<to>()
-See L<Mail::Message/"The header">
+Inherited, see L<Mail::Message/"The header">
=back
=head2 The body
-See L<documentation in the base class|Mail::Message/"The body">.
+Extends L<"The body" in Mail::Message|Mail::Message/"The body">.
=over 4
-=item $obj-E<gt>B<body>([ARRAY-OF-LINES|LIST-OF-LINES])
+=item $obj-E<gt>B<body>($lines|@lines)
-Returns an array of lines, representing the body. With arguments, a
+Returns an ARRAY of lines, representing the body. With arguments, a
new body will be created. In L<Mail::Internet>, the body is not an
object but a simple array.
@@ -576,47 +576,47 @@ BE WARNED: this overrules the L<Mail::Message::body()|Mail::Message/"The body">
may cause some confusion. Use L<bodyObject()|Mail::Message::Replace::MailInternet/"The body"> to get access to that
body's data.
-=item $obj-E<gt>B<bodyObject>([BODY])
+=item $obj-E<gt>B<bodyObject>( [$body] )
Calls L<Mail::Message::body()|Mail::Message/"The body">, because that C<body> method is overruled
by the one which has a L<Mail::Internet> compatible interface.
=item $obj-E<gt>B<contentType>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>()
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
-See L<Mail::Message/"The body">
+Inherited, see L<Mail::Message/"The body">
-=item $obj-E<gt>B<print_body>([FILEHANDLE])
+=item $obj-E<gt>B<print_body>( [$fh] )
-Prints the body to the specified FILEHANDLE, which defaults to STDOUT. This
+Prints the body to the specified $fh, which defaults to STDOUT. This
calls L<Mail::Message::Body::print()|Mail::Message::Body/"Access to the payload">.
-=item $obj-E<gt>B<remove_sig>([NRLINES])
+=item $obj-E<gt>B<remove_sig>( [$nrlines] )
-Remove the signature of a message with a maximum of NRLINES lines, which
+Remove the signature of a message with a maximum of $nrlines lines, which
defaults to 10. The work is done on the decoded body content, by
L<Mail::Message::Body::stripSignature()|Mail::Message::Body::Construct/"Constructing a body">.
-=item $obj-E<gt>B<smtpsend>(OPTIONS)
+=item $obj-E<gt>B<smtpsend>(%options)
This method is calling L<Mail::Message::send()|Mail::Message/"The message"> via C<smtp>, which is
implemented in L<Mail::Transport::SMTP|Mail::Transport::SMTP>. The implementation is
@@ -659,47 +659,47 @@ Removes blank lines from begin and end of the body.
=head2 Flags
-See L<documentation in the base class|Mail::Message/"Flags">.
+Extends L<"Flags" in Mail::Message|Mail::Message/"Flags">.
=over 4
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>()
-See L<Mail::Message/"Flags">
+Inherited, see L<Mail::Message/"Flags">
=back
=head2 The whole message as text
-See L<documentation in the base class|Mail::Message/"The whole message as text">.
+Extends L<"The whole message as text" in Mail::Message|Mail::Message/"The whole message as text">.
=over 4
@@ -711,19 +711,19 @@ which start with C<From > are escaped with an E<gt>.
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
@@ -731,9 +731,9 @@ See L<Mail::Message::Construct::Text/"The whole message as text">
=over 4
-=item $obj-E<gt>B<isa>(CLASS)
+=item $obj-E<gt>B<isa>($class)
-=item Mail::Message::Replace::MailInternet-E<gt>B<isa>(CLASS)
+=item Mail::Message::Replace::MailInternet-E<gt>B<isa>($class)
Of course, the C<isa()> class inheritance check should not see our
nasty trick.
@@ -742,141 +742,141 @@ nasty trick.
=head2 Internals
-See L<documentation in the base class|Mail::Message/"Internals">.
+Extends L<"Internals" in Mail::Message|Mail::Message/"Internals">.
=over 4
=item $obj-E<gt>B<clonedFrom>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item Mail::Message::Replace::MailInternet-E<gt>B<coerce>(MESSAGE)
+=item Mail::Message::Replace::MailInternet-E<gt>B<coerce>($message)
-Coerce (adapt type) of the specified MESSAGE (anything
+Coerce (adapt type) of the specified $message (anything
L<Mail::Message::coerce()|Mail::Message/"Internals"> accepts) into an L<Mail::Internet|Mail::Internet> simulating
object.
=item $obj-E<gt>B<isDelayed>()
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
-See L<Mail::Message/"Internals">
+Inherited, see L<Mail::Message/"Internals">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message/"Error handling">.
+Extends L<"Error handling" in Mail::Message|Mail::Message/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::Replace::MailInternet-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::Replace::MailInternet-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::Replace::MailInternet-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::Replace::MailInternet-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::Replace::MailInternet-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::Replace::MailInternet-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Message::Replace::MailInternet-E<gt>B<shortSize>([VALUE])
+=item Mail::Message::Replace::MailInternet-E<gt>B<shortSize>( [$value] )
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>()
-See L<Mail::Message/"Error handling">
+Inherited, see L<Mail::Message/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message|Mail::Message/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
-See L<Mail::Message/"Cleanup">
+Inherited, see L<Mail::Message/"Cleanup">
=back
=head1 DETAILS
-See L<documentation in the base class|Mail::Message/"DETAILS">.
+Extends L<"DETAILS" in Mail::Message|Mail::Message/"DETAILS">.
=head1 DIAGNOSTICS
@@ -930,12 +930,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::TransferEnc::Base64;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::TransferEnc';
@@ -30,55 +30,55 @@ C<[A-Za-z0-9+/]>. This way, three data bytes become 4 base64 bytes.
The encoded data will be trailed by C<'='> characters to align on
four bytes.
-See L<documentation in the base class|Mail::Message::TransferEnc/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::TransferEnc/"METHODS">.
+Extends L<"METHODS" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::TransferEnc/"Constructors">.
+Extends L<"Constructors" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"Constructors">.
=over 4
-=item Mail::Message::TransferEnc::Base64-E<gt>B<new>(OPTIONS)
+=item Mail::Message::TransferEnc::Base64-E<gt>B<new>(%options)
-See L<Mail::Reporter/"Constructors">
+Inherited, see L<Mail::Reporter/"Constructors">
=back
=head2 The Encoder
-See L<documentation in the base class|Mail::Message::TransferEnc/"The Encoder">.
+Extends L<"The Encoder" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"The Encoder">.
=over 4
-=item Mail::Message::TransferEnc::Base64-E<gt>B<addTransferEncoder>(TYPE, CLASS)
+=item Mail::Message::TransferEnc::Base64-E<gt>B<addTransferEncoder>($type, $class)
-See L<Mail::Message::TransferEnc/"The Encoder">
+Inherited, see L<Mail::Message::TransferEnc/"The Encoder">
-=item $obj-E<gt>B<create>(TYPE, OPTIONS)
+=item $obj-E<gt>B<create>($type, %options)
-See L<Mail::Message::TransferEnc/"The Encoder">
+Inherited, see L<Mail::Message::TransferEnc/"The Encoder">
=item $obj-E<gt>B<name>()
-See L<Mail::Message::TransferEnc/"The Encoder">
+Inherited, see L<Mail::Message::TransferEnc/"The Encoder">
=back
=head2 Encoding
-See L<documentation in the base class|Mail::Message::TransferEnc/"Encoding">.
+Extends L<"Encoding" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"Encoding">.
=over 4
-=item $obj-E<gt>B<check>(BODY, OPTIONS)
+=item $obj-E<gt>B<check>($body, %options)
-See L<Mail::Message::TransferEnc/"Encoding">
+Inherited, see L<Mail::Message::TransferEnc/"Encoding">
-=item $obj-E<gt>B<decode>(BODY, OPTIONS)
+=item $obj-E<gt>B<decode>($body, %options)
-Option --Defined in --Default
result_type Mail::Message::TransferEnc <type of source body>
@@ -89,83 +89,83 @@ See L<Mail::Message::TransferEnc/"Encoding">
=back
-=item $obj-E<gt>B<encode>(BODY, OPTIONS)
+=item $obj-E<gt>B<encode>($body, %options)
-See L<Mail::Message::TransferEnc/"Encoding">
+Inherited, see L<Mail::Message::TransferEnc/"Encoding">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Message::TransferEnc/"Error handling">.
+Extends L<"Error handling" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::TransferEnc::Base64-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::TransferEnc::Base64-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::TransferEnc::Base64-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::TransferEnc::Base64-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::TransferEnc::Base64-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::TransferEnc::Base64-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::TransferEnc/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -200,12 +200,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::TransferEnc::Binary;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::TransferEnc';
@@ -21,11 +21,11 @@ Mail::Message::TransferEnc::Binary - encode/decode binary message bodies
Encode or decode message bodies for binary transfer encoding. This is
totally no encoding.
-See L<documentation in the base class|Mail::Message::TransferEnc/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::TransferEnc/"METHODS">.
+Extends L<"METHODS" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"METHODS">.
=head1 DIAGNOSTICS
@@ -52,12 +52,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::TransferEnc::EightBit;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::TransferEnc';
@@ -32,11 +32,11 @@ RFC-2045 Section 2.8 defines legal `8bit' data:
As you can safely conclude: decoding of these bodies is no work
at all.
-See L<documentation in the base class|Mail::Message::TransferEnc/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::TransferEnc/"METHODS">.
+Extends L<"METHODS" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"METHODS">.
=head1 DIAGNOSTICS
@@ -63,12 +63,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::TransferEnc::QuotedPrint;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::TransferEnc';
@@ -26,55 +26,55 @@ characters (as defined by English Americans) are represented by a
triplet consisting of the character "=" followed by two hexadecimal
digits.
-See L<documentation in the base class|Mail::Message::TransferEnc/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::TransferEnc/"METHODS">.
+Extends L<"METHODS" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Message::TransferEnc/"Constructors">.
+Extends L<"Constructors" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"Constructors">.
=over 4
-=item Mail::Message::TransferEnc::QuotedPrint-E<gt>B<new>(OPTIONS)
+=item Mail::Message::TransferEnc::QuotedPrint-E<gt>B<new>(%options)
-See L<Mail::Reporter/"Constructors">
+Inherited, see L<Mail::Reporter/"Constructors">
=back
=head2 The Encoder
-See L<documentation in the base class|Mail::Message::TransferEnc/"The Encoder">.
+Extends L<"The Encoder" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"The Encoder">.
=over 4
-=item Mail::Message::TransferEnc::QuotedPrint-E<gt>B<addTransferEncoder>(TYPE, CLASS)
+=item Mail::Message::TransferEnc::QuotedPrint-E<gt>B<addTransferEncoder>($type, $class)
-See L<Mail::Message::TransferEnc/"The Encoder">
+Inherited, see L<Mail::Message::TransferEnc/"The Encoder">
-=item $obj-E<gt>B<create>(TYPE, OPTIONS)
+=item $obj-E<gt>B<create>($type, %options)
-See L<Mail::Message::TransferEnc/"The Encoder">
+Inherited, see L<Mail::Message::TransferEnc/"The Encoder">
=item $obj-E<gt>B<name>()
-See L<Mail::Message::TransferEnc/"The Encoder">
+Inherited, see L<Mail::Message::TransferEnc/"The Encoder">
=back
=head2 Encoding
-See L<documentation in the base class|Mail::Message::TransferEnc/"Encoding">.
+Extends L<"Encoding" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"Encoding">.
=over 4
-=item $obj-E<gt>B<check>(BODY, OPTIONS)
+=item $obj-E<gt>B<check>($body, %options)
-See L<Mail::Message::TransferEnc/"Encoding">
+Inherited, see L<Mail::Message::TransferEnc/"Encoding">
-=item $obj-E<gt>B<decode>(BODY, OPTIONS)
+=item $obj-E<gt>B<decode>($body, %options)
Decoding is tricky, and not without loss of information. Lines will
stay separate lines, although they might have been joined before the
@@ -91,7 +91,7 @@ end of line are removed.
=back
-=item $obj-E<gt>B<encode>(BODY, OPTIONS)
+=item $obj-E<gt>B<encode>($body, %options)
Encoding is to quoted-printable is a careful process: All characters
outside the normal printing range, and including C<'='> are encoded.
@@ -115,75 +115,75 @@ broken on encoded characters.
=head2 Error handling
-See L<documentation in the base class|Mail::Message::TransferEnc/"Error handling">.
+Extends L<"Error handling" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::TransferEnc::QuotedPrint-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::TransferEnc::QuotedPrint-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::TransferEnc::QuotedPrint-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::TransferEnc::QuotedPrint-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::TransferEnc::QuotedPrint-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::TransferEnc::QuotedPrint-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Message::TransferEnc/"Cleanup">.
+Extends L<"Cleanup" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -212,12 +212,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::TransferEnc::SevenBit;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Message::TransferEnc';
@@ -33,11 +33,11 @@ RFC-2045 Section 2.7 defines legal `7bit' data:
As you can safely conclude: decoding of these bodies is no work
at all.
-See L<documentation in the base class|Mail::Message::TransferEnc/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Message::TransferEnc/"METHODS">.
+Extends L<"METHODS" in Mail::Message::TransferEnc|Mail::Message::TransferEnc/"METHODS">.
=head1 DIAGNOSTICS
@@ -64,12 +64,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Message::TransferEnc;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -42,8 +42,6 @@ sub create($@)
$encoder->new(@_);
}
-#------------------------------------------
-
sub addTransferEncoder($$)
{ my ($class, $type, $encoderclass) = @_;
@@ -51,27 +49,19 @@ sub addTransferEncoder($$)
$class;
}
-#------------------------------------------
-
sub name {shift->notImplemented}
#------------------------------------------
-
sub check($@) {shift->notImplemented}
-#------------------------------------------
-
sub decode($@) {shift->notImplemented}
-#------------------------------------------
-
sub encode($) {shift->notImplemented}
#------------------------------------------
-
1;
@@ -55,21 +55,21 @@ C<quoted-printable> encdoded extended character set data.
=back
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Message::TransferEnc-E<gt>B<new>(OPTIONS)
+=item Mail::Message::TransferEnc-E<gt>B<new>(%options)
-See L<Mail::Reporter/"Constructors">
+Inherited, see L<Mail::Reporter/"Constructors">
=back
@@ -77,13 +77,13 @@ See L<Mail::Reporter/"Constructors">
=over 4
-=item Mail::Message::TransferEnc-E<gt>B<addTransferEncoder>(TYPE, CLASS)
+=item Mail::Message::TransferEnc-E<gt>B<addTransferEncoder>($type, $class)
Adds one new encoder to the list known by the Mail::Box suite. The
-TYPE is found in the message's header in the C<Content-Transfer-Encoding>
+$type is found in the message's header in the C<Content-Transfer-Encoding>
field.
-=item $obj-E<gt>B<create>(TYPE, OPTIONS)
+=item $obj-E<gt>B<create>($type, %options)
Create a new coder/decoder based on the required type.
@@ -97,7 +97,7 @@ The name of the encoder. Case is not significant.
=over 4
-=item $obj-E<gt>B<check>(BODY, OPTIONS)
+=item $obj-E<gt>B<check>($body, %options)
Check whether the body is correctly encoded. If so, the body reference is
returned with the C<checked> flag set. Otherwise, a new object is created
@@ -115,9 +115,9 @@ modified data.
=back
-=item $obj-E<gt>B<decode>(BODY [, OPTIONS])
+=item $obj-E<gt>B<decode>($body, %options)
-Use the encoder to decode the content of BODY. A new body is returned.
+Use the encoder to decode the content of $body. A new body is returned.
-Option --Default
result_type <type of source body>
@@ -131,9 +131,9 @@ modified data.
=back
-=item $obj-E<gt>B<encode>(BODY, OPTIONS)
+=item $obj-E<gt>B<encode>($body, %options)
-Use the encoder to encode the content of BODY.
+Use the encoder to encode the content of $body.
-Option --Default
result_type <type of source body>
@@ -151,75 +151,75 @@ modified data.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message::TransferEnc-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message::TransferEnc-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message::TransferEnc-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message::TransferEnc-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message::TransferEnc-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message::TransferEnc-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -248,12 +248,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message::Wrapper::SpamAssassin;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::SpamAssassin::Message';
@@ -4,6 +4,11 @@
Mail::Message::Wrapper::SpamAssassin - Connect a Mail::Message with Mail::SpamAssassin
+=head1 INHERITANCE
+
+ Mail::Message::Wrapper::SpamAssassin
+ is a Mail::SpamAssassin::Message
+
=head1 SYNOPSIS
# WARNING: requires OLD SpamAssassion 2.x, not the new 3.x
@@ -32,9 +37,9 @@ is an interface to the spam checking software of Mail::SpamAssassin.
=over 4
-=item Mail::Message::Wrapper::SpamAssassin-E<gt>B<new>(MESSAGE, OPTIONS)
+=item Mail::Message::Wrapper::SpamAssassin-E<gt>B<new>($message, %options)
-Creates a wrapper around the MESSAGE. The already present fields
+Creates a wrapper around the $message. The already present fields
from a previous run of Spam::Assassin (or probably fake lines) are
removed first.
@@ -42,12 +47,12 @@ removed first.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Message;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -21,7 +21,6 @@ use Mail::Message::Body::Nested;
use Carp;
use Scalar::Util 'weaken';
-use Devel::GlobalDestruction 'in_global_destruction';
our $crlf_platform;
@@ -223,7 +222,7 @@ sub study($)
sub from()
{ my @from = shift->head->get('From') or return ();
- map {$_->addresses} @from;
+ map $_->addresses, @from;
}
@@ -236,19 +235,18 @@ sub sender()
}
-sub to() { map {$_->addresses} shift->head->get('To') }
+sub to() { map $_->addresses, shift->head->get('To') }
-sub cc() { map {$_->addresses} shift->head->get('Cc') }
+sub cc() { map $_->addresses, shift->head->get('Cc') }
-sub bcc() { map {$_->addresses} shift->head->get('Bcc') }
+sub bcc() { map $_->addresses, shift->head->get('Bcc') }
sub destinations()
{ my $self = shift;
- my %to = map { (lc($_->address) => $_) }
- $self->to, $self->cc, $self->bcc;
+ my %to = map +(lc($_->address) => $_), $self->to, $self->cc, $self->bcc;
values %to;
}
@@ -688,16 +686,6 @@ sub shortString()
#------------------------------------------
-sub DESTROY()
-{ my $self = shift;
- return if in_global_destruction;
-
- $self->SUPER::DESTROY;
- $self->head(undef);
- $self->body(undef);
-}
-
-
sub destruct() { $_[0] = undef }
#------------------------------------------
@@ -60,19 +60,19 @@ implemented in separate packages which are autoloaded into this class.
This means you can simply use these methods as if they are part of this class.
Those package add functionality to all kinds of message objects.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item $obj-E<gt>B<clone>(OPTIONS)
+=item $obj-E<gt>B<clone>(%options)
Create a copy of this message. Returned is a C<Mail::Message> object.
The head and body, the log and trace levels are taken. Labels are
@@ -122,7 +122,7 @@ example:
$copy = $msg->clone;
-=item Mail::Message-E<gt>B<new>(OPTIONS)
+=item Mail::Message-E<gt>B<new>(%options)
-Option --Defined in --Default
body undef
@@ -203,71 +203,71 @@ body data is decoded or used for transmission.
=over 4
-=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
+=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )
-See L<Mail::Message::Construct::Bounce/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">
-=item Mail::Message-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
+=item Mail::Message-E<gt>B<build>( [$message|$part|$body], $content )
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item Mail::Message-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
+=item Mail::Message-E<gt>B<buildFromBody>($body, [$head], $headers)
-See L<Mail::Message::Construct::Build/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">
-=item $obj-E<gt>B<forward>(OPTIONS)
+=item $obj-E<gt>B<forward>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardAttach>(OPTIONS)
+=item $obj-E<gt>B<forwardAttach>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
+=item $obj-E<gt>B<forwardEncapsulate>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardInline>(OPTIONS)
+=item $obj-E<gt>B<forwardInline>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item $obj-E<gt>B<forwardNo>(OPTIONS)
+=item $obj-E<gt>B<forwardNo>(%options)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>()
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
-See L<Mail::Message::Construct::Forward/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">
-=item Mail::Message-E<gt>B<read>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)
+=item Mail::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)
-See L<Mail::Message::Construct::Read/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">
-=item $obj-E<gt>B<rebuild>(OPTIONS)
+=item $obj-E<gt>B<rebuild>(%options)
-See L<Mail::Message::Construct::Rebuild/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">
-=item $obj-E<gt>B<reply>(OPTIONS)
+=item $obj-E<gt>B<reply>(%options)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
-=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
+=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Message-E<gt>B<replySubject>(STRING)
-See L<Mail::Message::Construct::Reply/"Constructing a message">
+Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">
=back
@@ -325,7 +325,7 @@ nested part may for instance return '2.5.1'.
Usually, this string is very short. Numbering follows the IMAP4 design,
see RFC2060 secion 6.4.5.
-=item $obj-E<gt>B<print>([FILEHANDLE])
+=item $obj-E<gt>B<print>( [$fh] )
Print the message to the FILE-HANDLE, which defaults to the selected
filehandle, without the encapsulation sometimes required by a folder
@@ -340,13 +340,13 @@ example:
$message->print($out); # no encapsulation: no folder
$message->write($out); # with encapsulation: is folder.
-=item $obj-E<gt>B<send>([MAILER], OPTIONS)
+=item $obj-E<gt>B<send>( [$mailer], %options )
-Transmit the message to anything outside this Perl program. MAILER
-is a L<Mail::Transport::Send|Mail::Transport::Send> object. When the MAILER is not specified, one
+Transmit the message to anything outside this Perl program. $mailer
+is a L<Mail::Transport::Send|Mail::Transport::Send> object. When the $mailer is not specified, one
will be created, and kept as default for the next messages as well.
-The OPTIONS are mailer specific, and a mixture of what is usable for
+The %options are mailer specific, and a mixture of what is usable for
the creation of the mailer object and the sending itself. Therefore, see
for possible options L<Mail::Transport::Send::new()|Mail::Transport::Send/"METHODS"> and
L<Mail::Transport::Send::send()|Mail::Transport::Send/"Sending mail">.
@@ -386,10 +386,10 @@ method returns.
Returns a reference to the main message, which will be the current
message if the message is not part of another message.
-=item $obj-E<gt>B<write>([FILEHANDLE])
+=item $obj-E<gt>B<write>( [$fh] )
Write the message to the FILE-HANDLE, which defaults to the selected
-FILEHANDLE, with all surrounding information which is needed to put
+$fh, with all surrounding information which is needed to put
it correctly in a folder file.
In most cases, the result of C<write> will be the same as with L<print()|Mail::Message/"The message">.
@@ -444,10 +444,10 @@ example: using from() to get all sender addresses
my @from = $message->from;
-=item $obj-E<gt>B<get>(FIELDNAME)
+=item $obj-E<gt>B<get>($fieldname)
Returns the value which is stored in the header field with the specified
-name. The FIELDNAME is case insensitive. The I<unfolded body> of the
+name. The $fieldname is case insensitive. The I<unfolded body> of the
field is returned, stripped from any attributes.
See L<Mail::Message::Field::body()|Mail::Message::Field/"Access to the body">.
@@ -479,9 +479,9 @@ example: using guessTimestamp() to get a transmission date
print "Receipt ", ($message->timestamp || 'unknown'), "\n";
-=item $obj-E<gt>B<head>([HEAD])
+=item $obj-E<gt>B<head>( [$head] )
-Return (optionally after setting) the HEAD of this message.
+Return (optionally after setting) the $head of this message.
The head must be an (sub-)class of L<Mail::Message::Head|Mail::Message::Head>.
When the head is added, status information is taken from it
and transformed into labels. More labels can be added by the
@@ -510,7 +510,7 @@ example: using sender() to get exactly one sender address
my $sender = $message->sender;
print "Reply to: ", $sender->format, "\n" if defined $sender;
-=item $obj-E<gt>B<study>(FIELDNAME)
+=item $obj-E<gt>B<study>($fieldname)
Study the content of a field, like L<get()|Mail::Message/"The header"> does, with as main difference
that a L<Mail::Message::Field::Full|Mail::Message::Field::Full> object is returned. These objects
@@ -573,13 +573,13 @@ example: using to() to get all primar destination addresses
=over 4
-=item $obj-E<gt>B<body>([BODY])
+=item $obj-E<gt>B<body>( [$body] )
Return the body of this message. BE WARNED that this returns
you an object which may be encoded: use decoded() to get a body
with usable data.
-With options, a new BODY is set for this message. This is B<not>
+With options, a new $body is set for this message. This is B<not>
for normal use unless you understand the consequences: you change
the message content without changing the message-ID. The right
way to go is via
@@ -588,13 +588,13 @@ way to go is via
$message = Mail::Message->build($body); # or
$message = $origmsg->forward(body => $body);
-The BODY must be an (sub-)class of L<Mail::Message::Body|Mail::Message::Body>. In this case,
+The $body must be an (sub-)class of L<Mail::Message::Body|Mail::Message::Body>. In this case,
information from the specified body will be copied into the header. The
body object will be encoded if needed, because messages written to file
or transmitted shall not contain binary data. The converted body
is returned.
-When BODY is C<undef>, the current message body will be dissected from
+When $body is C<undef>, the current message body will be dissected from
the message. All relation will be cut. The body is returned, and
can be connected to a different message.
@@ -611,15 +611,15 @@ example:
Returns the content type header line, or C<text/plain> if it is not
defined. The parameters will be stripped off.
-=item $obj-E<gt>B<decoded>(OPTIONS)
+=item $obj-E<gt>B<decoded>(%options)
Decodes the body of this message, and returns it as a body object.
-Short for C<<$msg->body->decoded>> All OPTIONS are passed-on.
+Short for C<<$msg->body->decoded>> All %options are passed-on.
-=item $obj-E<gt>B<encode>(OPTIONS)
+=item $obj-E<gt>B<encode>(%options)
Encode the message to a certain format. Read the details in the
-dedicated manual page L<Mail::Message::Body::Encode|Mail::Message::Body::Encode>. The OPTIONS which
+dedicated manual page L<Mail::Message::Body::Encode|Mail::Message::Body::Encode>. The %options which
can be specified here are those of the L<Mail::Message::Body::encode()|Mail::Message::Body::Encode/"Constructing a body">
method.
@@ -633,7 +633,7 @@ need to read the body of the message to detect this.
Returns C<true> for C<message/rfc822> messages and message parts.
-=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
+=item $obj-E<gt>B<parts>( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
Returns the I<parts> of this message. Usually, the term I<part> is used
with I<multipart> messages: messages which are encapsulated in the body
@@ -650,7 +650,7 @@ be combined with the other options, which you may want: it that case
you have to test yourself.
'ACTIVE' and 'DELETED' check for the deleted flag on messages and
-message parts. The FILTER is a code reference, which is called for
+message parts. The $filter is a code reference, which is called for
each part of the message; each part as C<RECURSE> would return.
example:
@@ -687,7 +687,7 @@ example:
$message->label(deleted => 1);
delete $message;
-=item $obj-E<gt>B<deleted>([BOOLEAN])
+=item $obj-E<gt>B<deleted>( [BOOLEAN] )
Set the delete flag for this message. Without argument, the method
returns the same as L<isDeleted()|Mail::Message/"Flags">, which is preferred. When a true
@@ -725,9 +725,9 @@ Returns whether this message is flagged as being modified. Modifications
are changes in header lines, when a new body is set to the message
(dangerous), or when labels change.
-=item $obj-E<gt>B<label>(LABEL|PAIRS)
+=item $obj-E<gt>B<label>($label|PAIRS)
-Return the value of the LABEL, optionally after setting some values. In
+Return the value of the $label, optionally after setting some values. In
case of setting values, you specify key-value PAIRS.
Labels are used to store knowledge about handling of the message within
@@ -766,7 +766,7 @@ between these fields and the labels in the DETAILS chapter.
The method will carefully only affect the result of L<modified()|Mail::Message/"Flags"> when
there is a real change of flags, so not for each call to L<label()|Mail::Message/"Flags">.
-=item $obj-E<gt>B<modified>([BOOLEAN])
+=item $obj-E<gt>B<modified>( [BOOLEAN] )
Returns (optionally after setting) whether this message is flagged as
being modified. See isModified().
@@ -784,19 +784,19 @@ description in the DETAILS chapter.
=item $obj-E<gt>B<file>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
+=item $obj-E<gt>B<printStructure>( [$fh|undef],[$indent] )
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>()
-See L<Mail::Message::Construct::Text/"The whole message as text">
+Inherited, see L<Mail::Message::Construct::Text/"The whole message as text">
=back
@@ -806,12 +806,12 @@ See L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<clonedFrom>()
-Returns the MESSAGE which is the source of this message, which was
+Returns the $message which is the source of this message, which was
created by a L<clone()|Mail::Message/"Constructors"> operation.
-=item Mail::Message-E<gt>B<coerce>(MESSAGE, OPTIONS)
+=item Mail::Message-E<gt>B<coerce>($message, %options)
-Coerce a MESSAGE into a Mail::Message. In some occasions, for instance
+Coerce a $message into a Mail::Message. In some occasions, for instance
where you add a message to a folder, this coercion is automatically
called to ensure that the correct message type is stored.
@@ -859,45 +859,45 @@ Simpler replacement for the previous two lines:
Check whether the message is delayed (not yet read from file). Returns
true or false, dependent on the body type.
-=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
+=item $obj-E<gt>B<readBody>( $parser, $head, [$bodytype] )
-Read a body of a message. The PARSER is the access to the folder's
-file, and the HEAD is already read. Information from the HEAD is used
+Read a body of a message. The $parser is the access to the folder's
+file, and the $head is already read. Information from the $head is used
to create expectations about the message's length, but also to determine
the mime-type and encodings of the body data.
-The BODYTYPE determines which kind of body will be made and defaults to
+The $bodytype determines which kind of body will be made and defaults to
the value specified by new(body_type).
-BODYTYPE may be the name of a body class, or a reference
-to a routine which returns the body's class when passed the HEAD as only
+$bodytype may be the name of a body class, or a reference
+to a routine which returns the body's class when passed the $head as only
argument.
-=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
+=item $obj-E<gt>B<readFromParser>( $parser, [$bodytype] )
-Read one message from file. The PARSER is opened on the file. First
+Read one message from file. The $parser is opened on the file. First
L<readHead()|Mail::Message/"Internals"> is called, and the head is stored in the message. Then
L<readBody()|Mail::Message/"Internals"> is called, to produce a body. Also the body is added to
the message without decodings being done.
-The optional BODYTYPE may be a body class or a reference to a code
+The optional $bodytype may be a body class or a reference to a code
which returns a body-class based on the header.
-=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
+=item $obj-E<gt>B<readHead>( $parser, [$class] )
-Read a head into an object of the specified CLASS. The CLASS defaults to
-L<new(head_type)|Mail::Message/"Constructors">. The PARSER is the access to the folder's file.
+Read a head into an object of the specified $class. The $class defaults to
+L<new(head_type)|Mail::Message/"Constructors">. The $parser is the access to the folder's file.
-=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
+=item $obj-E<gt>B<recursiveRebuildPart>($part, %options)
-See L<Mail::Message::Construct::Rebuild/"Internals">
+Inherited, see L<Mail::Message::Construct::Rebuild/"Internals">
-=item $obj-E<gt>B<storeBody>(BODY)
+=item $obj-E<gt>B<storeBody>($body)
Where the L<body()|Mail::Message/"The body"> method can be used to set and get a body, with all
the necessary checks, this method is bluntly adding the specified body
to the message. No conversions, not checking.
-=item $obj-E<gt>B<takeMessageId>([STRING])
+=item $obj-E<gt>B<takeMessageId>( [STRING] )
Take the message-id from the STRING, or create one when the C<undef>
is specified. If not STRING nor C<undef> is given, the current header
@@ -909,63 +909,63 @@ Angles (if present) are removed from the id.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Message::Construct/"METHODS">
+Inherited, see L<Mail::Message::Construct/"METHODS">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Message-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Message-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Message-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Message-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Message-E<gt>B<logPriority>(LEVEL)
+=item Mail::Message-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<shortSize>([VALUE])
+=item $obj-E<gt>B<shortSize>( [$value] )
-=item Mail::Message-E<gt>B<shortSize>([VALUE])
+=item Mail::Message-E<gt>B<shortSize>( [$value] )
-Represent an integer VALUE representing the size of file or memory,
+Represent an integer $value representing the size of file or memory,
(which can be large) into a short string using M and K (Megabytes
-and Kilobytes). Without VALUE, the size of the message head is used.
+and Kilobytes). Without $value, the size of the message head is used.
=item $obj-E<gt>B<shortString>()
@@ -973,28 +973,25 @@ Convert the message header to a short string (without trailing newline),
representing the most important facts (for debugging purposes only). For
now, it only reports size and subject.
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-When a message is to accessible anymore by any user's reference, Perl
-will call DESTROY for final clean-up. In this case, the head and
-body are released, and de-registered for the folder. You shall not call
-this yourself!
+Inherited, see L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<destruct>()
@@ -1002,7 +999,7 @@ Remove the information contained in the message object. This will be
ignored when more than one reference to the same message object exists,
because the method has the same effect as assigning C<undef> to the
variable which contains the reference. Normal garbage collection will
-call L<DESTROY()|Mail::Message/"Cleanup"> when possible.
+call C<DESTROY()> when possible.
This method is only provided to hide differences with messages which are
located in folders: their L<Mail::Box::Message::destruct()|Mail::Box::Message/"Cleanup"> works quite
@@ -1284,12 +1281,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Reporter;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Carp;
@@ -55,11 +55,11 @@ constructor L<new()|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Reporter-E<gt>B<new>(OPTIONS)
+=item Mail::Reporter-E<gt>B<new>(%options)
This error container is also the base constructor for all modules, (as long
as there is no need for another base object) The constructor always accepts
-the following OPTIONS related to error reports.
+the following %options related to error reports.
-Option--Default
log 'WARNINGS'
@@ -99,27 +99,27 @@ be changed with L<defaultTrace()|Mail::Reporter/"Error handling">.
By default, produce a nice warning if the sub-classes cannot resolve
a method.
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-Add the report from other OBJECT to the report of this object. This is
+Add the report from other $object to the report of this object. This is
useful when complex actions use temporary objects which are not returned
to the main application but where the main application would like to know
about any problems.
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Reporter-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Reporter-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
Reports the default log and trace level which is used for object as list
of two elements. When not explicitly set, both are set to C<WARNINGS>.
This method has three different uses. When one argument is specified, that
-LEVEL is set for both loglevel as tracelevel.
+$level is set for both loglevel as tracelevel.
With two arguments, the second determines which configuration you like. If
-the second argument is a CODE reference, you install a CALLBACK. The loglevel
+the second argument is a CODE reference, you install a $callback. The loglevel
will be set to NONE, and all warnings produced in your program will get
-passed to the CALLBACK function. That function will get the problem level,
+passed to the $callback function. That function will get the problem level,
the object or class which reports the problem, and the problem text passed
as arguments.
@@ -154,9 +154,9 @@ Equivalent to
$folder->report('ERRORS')
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Reporter-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Reporter-E<gt>B<log>( [$level, [$strings]] )
As instance method this function has three different purposes. Without
any argument, it returns one scalar containing the number which is internally
@@ -172,8 +172,8 @@ As class method, only a message can be passed. The global configuration
value set with L<defaultTrace()|Mail::Reporter/"Error handling"> is used to decide whether the message is
shown or ignored.
-Each log-entry has a LEVEL and a text string which will
-be constructed by joining the STRINGS. If there is no newline, it will
+Each log-entry has a $level and a text string which will
+be constructed by joining the $strings. If there is no newline, it will
be added.
example:
@@ -188,9 +188,9 @@ example:
Mail::Message->log(ERROR => 'Unknown');
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Reporter-E<gt>B<logPriority>(LEVEL)
+=item Mail::Reporter-E<gt>B<logPriority>($level)
One error level (log or trace) has more than one representation: a
numeric value and one or more strings. For instance, C<4>, C<'WARNING'>,
@@ -224,12 +224,12 @@ example:
A special case of L<log()|Mail::Reporter/"Error handling">, which logs a C<INTERNAL>-error
and then croaks. This is used by extension writers.
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-Get logged reports, as list of strings. If a LEVEL is specified, the log
+Get logged reports, as list of strings. If a $level is specified, the log
for that level is returned.
-In case no LEVEL is specified, you get all messages each as reference
+In case no $level is specified, you get all messages each as reference
to a tuple with level and message.
example:
@@ -248,7 +248,7 @@ example:
print "$level report: $text";
}
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
Report all messages which were produced by this object and all the objects
which are maintained by this object. This will return a list of triplets,
@@ -269,9 +269,9 @@ example:
}
}
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-Change the trace LEVEL of the object. When no arguments are specified, the
+Change the trace $level of the object. When no arguments are specified, the
current level is returned only. It will be returned in one scalar which
contains both the number which is internally used to represent the level,
and the string which represents it. See L<logPriority()|Mail::Reporter/"Error handling">.
@@ -310,12 +310,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Server::IMAP4::Fetch;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Date::Parse;
@@ -101,14 +101,12 @@ sub new($)
#------------------------------------------
-
sub headLocation() { @{ (shift) }{ qw/headbegin bodybegin/ } }
sub bodyLocation() { @{ (shift) }{ qw/bodybegin bodyend/ } }
sub partLocation() { @{ (shift) }{ qw/headbegin bodyend/ } }
#------------------------------------------
-
sub fetchBody($)
{ my ($self, $extended) = @_;
@@ -118,7 +116,7 @@ sub fetchBody($)
if($self->{parts})
{ # Multipart message
# WARNING: no blanks between part descriptions
- my $parts = join '', map {$_->fetchBody($extended)} @{$self->{parts}};
+ my $parts = join '', map $_->fetchBody($extended), @{$self->{parts}};
my @fields = (\$parts, $subtype || 'MIXED');
if($extended) # only included when any valid info
@@ -136,34 +134,31 @@ sub fetchBody($)
# Simple message
#
- my @fields = ( ($mediatype || 'TEXT')
- , ($subtype || 'PLAIN')
- , $self->{typeattr}
- , $self->{messageid}
- , $self->{description}
- , uc($self->{transferenc} || '8BIT')
- , \($self->{bodysize})
- );
+ my @fields =
+ ( ($mediatype || 'TEXT')
+ , ($subtype || 'PLAIN')
+ , $self->{typeattr}
+ , $self->{messageid}
+ , $self->{description}
+ , uc($self->{transferenc} || '8BIT')
+ , \($self->{bodysize})
+ );
if(my $nest = $self->{nest})
{ # type MESSAGE (message/rfc822 encapsulated)
- push @fields, \$nest->fetchEnvelope,
- , \$nest->fetchBody($extended);
+ push @fields
+ , \$nest->fetchEnvelope,
+ , \$nest->fetchBody($extended);
}
-
push @fields, \$self->{bodylines};
- if( $extended
- && ($self->{bodyMD5} || $self->{disposition} || $self->{language})
- )
- { push @fields, @{$self}{ qw/bodyMD5 disposition language/ };
- }
+ push @fields, @{$self}{ qw/bodyMD5 disposition language/ }
+ if $extended
+ && ($self->{bodyMD5} || $self->{disposition} || $self->{language});
$self->_imapList(@fields);
}
-#------------------------------------------
-
sub fetchEnvelope()
{ my $self = shift;
@@ -194,13 +189,9 @@ sub fetchEnvelope()
$self->_imapList(@fields);
}
-#------------------------------------------
-
sub fetchSize() { shift->{bodysize} }
-#------------------------------------------
-
sub part(;$)
{ my $self = shift;
@@ -219,8 +210,6 @@ sub part(;$)
$self;
}
-#------------------------------------------
-
sub printStructure(;$$)
{ my $self = shift;
@@ -29,7 +29,7 @@ Therefore, this object can be frozen by L<Storable> if you want to.
=over 4
-=item Mail::Server::IMAP4::Fetch-E<gt>B<new>(MESSAGE|PART, OPTIONS)
+=item Mail::Server::IMAP4::Fetch-E<gt>B<new>( <$message|$part>, %options )
-Option --Default
md5checksums 0
@@ -58,11 +58,11 @@ Therefore, this object can be frozen by L<Storable> if you want to.
=over 4
-=item $obj-E<gt>B<fetchBody>(EXTENDED)
+=item $obj-E<gt>B<fetchBody>($extended)
Returns one string, representing the message's structure as defined by
the IMAP protocol. The boolean argument indicates whether you like to
-have the EXTENDED information, as the imap command 'FETCH BODYSTRUCTURE'
+have the $extended information, as the imap command 'FETCH BODYSTRUCTURE'
defines or the limited information of 'FETCH BODY'.
=item $obj-E<gt>B<fetchEnvelope>()
@@ -73,7 +73,7 @@ Returns a string representation of some header information.
Returns the size of the message body.
-=item $obj-E<gt>B<part>([PARTNR])
+=item $obj-E<gt>B<part>( [$partnr] )
The partnummer is a list of dot-separated positive integers, numbering
(nested) parts in multi-part message bodies. By default, the info of
@@ -84,9 +84,9 @@ example:
my $partinfo = $msg->info->part('1.2.1');
print $msg->info->part('3.3')->fetchBody;
-=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef, [NUMBER]])
+=item $obj-E<gt>B<printStructure>( [<$fh|undef>, [$number]] )
-Print the structure of the fetch data to the specified FILEHANDLE or the
+Print the structure of the fetch data to the specified $fh or the
selected filehandle. When explicitly C<undef> is specified as handle,
then the output will be returned as string.
Only a limited set of the information is displayed.
@@ -116,12 +116,12 @@ See
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Server::IMAP4::List;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
@@ -23,7 +23,7 @@ Mail::Server::IMAP4::List - folder related IMAP4 answers
=over 4
-=item Mail::Server::IMAP4::List-E<gt>B<new>(USER)
+=item Mail::Server::IMAP4::List-E<gt>B<new>($user)
Create a (temporary) object to handle the LIST requests for
a certain user, based upon a set of folders. The data is kept by
@@ -69,7 +69,7 @@ must get reported.
=over 4
-=item $obj-E<gt>B<delimiter>([FOLDERNAME])
+=item $obj-E<gt>B<delimiter>( [$foldername] )
Returns the delimiter string. The foldername is only required when a
CODE reference was specified at initiation.
@@ -109,7 +109,7 @@ Returns the L<Mail::Box::Manage::User|Mail::Box::Manage::User> object, if define
=over 4
-=item $obj-E<gt>B<list>(BASE, PATTERN)
+=item $obj-E<gt>B<list>($base, $pattern)
IMAP's LIST command. The request must be partially decoded, the answer
will need to be encoded.
@@ -144,12 +144,12 @@ sections 6.3.8 (LIST question) and 7.2.2 (LIST answer)
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Server::IMAP4::Search;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Box::Search';
@@ -27,19 +27,19 @@ Mail::Server::IMAP4::Search - select messages within a IMAP folder (not complete
THIS PACKAGES IS NOT IMPLEMENTED YET... (it's waiting for a volunteer)
-See L<documentation in the base class|Mail::Box::Search/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Box::Search|Mail::Box::Search/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Box::Search/"METHODS">.
+Extends L<"METHODS" in Mail::Box::Search|Mail::Box::Search/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Box::Search/"Constructors">.
+Extends L<"Constructors" in Mail::Box::Search|Mail::Box::Search/"Constructors">.
=over 4
-=item Mail::Server::IMAP4::Search-E<gt>B<new>(OPTIONS)
+=item Mail::Server::IMAP4::Search-E<gt>B<new>(%options)
-Option --Defined in --Default
binaries Mail::Box::Search <false>
@@ -87,111 +87,111 @@ See L<documentation in the base class|Mail::Box::Search/"Constructors">.
=head2 Searching
-See L<documentation in the base class|Mail::Box::Search/"Searching">.
+Extends L<"Searching" in Mail::Box::Search|Mail::Box::Search/"Searching">.
=over 4
-=item $obj-E<gt>B<inBody>(PART, BODY)
+=item $obj-E<gt>B<inBody>($part, $body)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
-=item $obj-E<gt>B<inHead>(PART, HEAD)
+=item $obj-E<gt>B<inHead>($part, $head)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
-=item $obj-E<gt>B<search>(FOLDER|THREAD|MESSAGE|ARRAY-OF-MESSAGES)
+=item $obj-E<gt>B<search>($folder|$thread|$message|ARRAY)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
-=item $obj-E<gt>B<searchPart>(PART)
+=item $obj-E<gt>B<searchPart>($part)
-See L<Mail::Box::Search/"Searching">
+Inherited, see L<Mail::Box::Search/"Searching">
=back
=head2 The Results
-See L<documentation in the base class|Mail::Box::Search/"The Results">.
+Extends L<"The Results" in Mail::Box::Search|Mail::Box::Search/"The Results">.
=over 4
-=item $obj-E<gt>B<printMatch>([FILEHANDLE], HASH)
+=item $obj-E<gt>B<printMatch>( [$fh], HASH )
-See L<Mail::Box::Search/"The Results">
+Inherited, see L<Mail::Box::Search/"The Results">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Box::Search/"Error handling">.
+Extends L<"Error handling" in Mail::Box::Search|Mail::Box::Search/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Server::IMAP4::Search-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Server::IMAP4::Search-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Server::IMAP4::Search-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Server::IMAP4::Search-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Server::IMAP4::Search-E<gt>B<logPriority>(LEVEL)
+=item Mail::Server::IMAP4::Search-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Box::Search/"Cleanup">.
+Extends L<"Cleanup" in Mail::Box::Search|Mail::Box::Search/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -211,12 +211,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Server::IMAP4;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Server';
@@ -41,11 +41,11 @@ the SEARCH request. Not implemented yet... looking for a volunteer.
=back
-See L<documentation in the base class|Mail::Server/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Server|Mail::Server/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Server/"METHODS">.
+Extends L<"METHODS" in Mail::Server|Mail::Server/"METHODS">.
=head1 DETAILS
@@ -57,7 +57,7 @@ See
=back
-See L<documentation in the base class|Mail::Server/"DETAILS">.
+Extends L<"DETAILS" in Mail::Server|Mail::Server/"DETAILS">.
=head1 DIAGNOSTICS
@@ -75,12 +75,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Server;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -33,11 +33,11 @@ Partial IMAP4 implementation.
=back
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head1 DETAILS
@@ -57,12 +57,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Transport::Exim;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Transport::Send';
@@ -22,19 +22,19 @@ Implements mail transport using the external C<'Exim'> program.
When instantiated, the mailer will look for the binary in specific system
directories, and the first version found is taken.
-See L<documentation in the base class|Mail::Transport::Send/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Transport::Send|Mail::Transport::Send/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Transport::Send/"METHODS">.
+Extends L<"METHODS" in Mail::Transport::Send|Mail::Transport::Send/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Transport::Send/"Constructors">.
+Extends L<"Constructors" in Mail::Transport::Send|Mail::Transport::Send/"Constructors">.
=over 4
-=item Mail::Transport::Exim-E<gt>B<new>(OPTIONS)
+=item Mail::Transport::Exim-E<gt>B<new>(%options)
If you have Exim installed in a non-standard location, you will need to
specify the path, using L<new(proxy)|Mail::Transport/"METHODS">.
@@ -57,7 +57,7 @@ specify the path, using L<new(proxy)|Mail::Transport/"METHODS">.
=item executable => FILENAME
-=item hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
+=item hostname => HOSTNAME|ARRAY
=item interval => SECONDS
@@ -85,117 +85,117 @@ specify the path, using L<new(proxy)|Mail::Transport/"METHODS">.
=head2 Sending mail
-See L<documentation in the base class|Mail::Transport::Send/"Sending mail">.
+Extends L<"Sending mail" in Mail::Transport::Send|Mail::Transport::Send/"Sending mail">.
=over 4
-=item $obj-E<gt>B<destinations>(MESSAGE, [ADDRESS|ARRAY-OF-ADDRESSES])
+=item $obj-E<gt>B<destinations>( $message, [$address|ARRAY] )
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<putContent>(MESSAGE, FILEHANDLE, OPTIONS)
+=item $obj-E<gt>B<putContent>($message, $fh, %options)
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<send>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<send>($message, %options)
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<trySend>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<trySend>($message, %options)
=back
=head2 Server connection
-See L<documentation in the base class|Mail::Transport::Send/"Server connection">.
+Extends L<"Server connection" in Mail::Transport::Send|Mail::Transport::Send/"Server connection">.
=over 4
-=item $obj-E<gt>B<findBinary>(NAME [, DIRECTORIES])
+=item $obj-E<gt>B<findBinary>( $name, [@directories] )
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<remoteHost>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<retry>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Transport::Send/"Error handling">.
+Extends L<"Error handling" in Mail::Transport::Send|Mail::Transport::Send/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Transport::Exim-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Transport::Exim-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Transport::Exim-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Transport::Exim-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Transport::Exim-E<gt>B<logPriority>(LEVEL)
+=item Mail::Transport::Exim-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Transport::Send/"Cleanup">.
+Extends L<"Cleanup" in Mail::Transport::Send|Mail::Transport::Send/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -240,12 +240,12 @@ found in the message itself about the destination.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,7 +8,7 @@ use warnings;
package Mail::Transport::IMAP4;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Transport::Receive';
@@ -37,11 +37,11 @@ module, and solving those is outside the scope of MailBox. See
F<http://rt.cpan.org/Public/Dist/Display.html?Name=Mail-IMAPClient>
for all the reported bugs.
-See L<documentation in the base class|Mail::Transport::Receive/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Transport::Receive|Mail::Transport::Receive/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Transport::Receive/"METHODS">.
+Extends L<"METHODS" in Mail::Transport::Receive|Mail::Transport::Receive/"METHODS">.
=over 4
@@ -53,11 +53,11 @@ Represent this imap4 connection as URL.
=head2 Constructors
-See L<documentation in the base class|Mail::Transport::Receive/"Constructors">.
+Extends L<"Constructors" in Mail::Transport::Receive|Mail::Transport::Receive/"Constructors">.
=over 4
-=item Mail::Transport::IMAP4-E<gt>B<new>(OPTIONS)
+=item Mail::Transport::IMAP4-E<gt>B<new>(%options)
Create the IMAP connection to the server. IMAP servers can handle
multiple folders for a single user, which means that connections
@@ -86,11 +86,11 @@ C<port>, C<username>, and C<password> are extracted from it.
=over 2
-=item authenticate => TYPE|ARRAY-OF-TYPES
+=item authenticate => TYPE|ARRAY
Authenthication method to L<login()|Mail::Transport::IMAP4/"Protocol [internals]">, which will be passed to
-L<Mail::IMAPClient> method authenticate(). See the latter method for
-the available types.
+Mail::IMAPClient subroutine authenticate. See the latter method for
+the available types. You may provide an ARRAY of types.
=item domain => WINDOWS_DOMAIN
@@ -98,7 +98,7 @@ Used for NTLM authentication.
=item executable => FILENAME
-=item hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
+=item hostname => HOSTNAME|ARRAY
=item imap_client => OBJECT|CLASS
@@ -141,33 +141,33 @@ tart Transport Security Layer (TLS).
=head2 Receiving mail
-See L<documentation in the base class|Mail::Transport::Receive/"Receiving mail">.
+Extends L<"Receiving mail" in Mail::Transport::Receive|Mail::Transport::Receive/"Receiving mail">.
=over 4
-=item $obj-E<gt>B<receive>([UNIQUE-MESSAGE-ID])
+=item $obj-E<gt>B<receive>( [$unique_message_id] )
-See L<Mail::Transport::Receive/"Receiving mail">
+Inherited, see L<Mail::Transport::Receive/"Receiving mail">
=back
=head2 Server connection
-See L<documentation in the base class|Mail::Transport::Receive/"Server connection">.
+Extends L<"Server connection" in Mail::Transport::Receive|Mail::Transport::Receive/"Server connection">.
=over 4
-=item $obj-E<gt>B<findBinary>(NAME [, DIRECTORIES])
+=item $obj-E<gt>B<findBinary>( $name, [@directories] )
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<remoteHost>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<retry>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=back
@@ -175,16 +175,16 @@ See L<Mail::Transport/"Server connection">
=over 4
-=item $obj-E<gt>B<authentication>(['AUTO'|TYPE|LIST-OF-TYPES])
+=item $obj-E<gt>B<authentication>( ['AUTO'|$type|$types] )
-Returned is a list of pairs (ref arrays) each describing one possible
-way to contact the server. Each pair contains a mechanism name and
-a challenge callback (which may be C<undef>).
+Returns a LIST of ARRAYS, each describing one possible way to contact
+the server. Each pair contains a mechanism name and a challenge callback
+(which may be C<undef>).
The settings are used by L<login()|Mail::Transport::IMAP4/"Protocol [internals]"> to get server access. The initial
value origins from L<new(authenticate)|Mail::Transport::IMAP4/"METHODS">, but may be changed later.
-Available basic TYPES are C<CRAM-MD5>, C<NTLM>, and C<PLAIN>. With
+Available basic $types are C<CRAM-MD5>, C<NTLM>, and C<PLAIN>. With
C<AUTO>, all available types will be tried. When the Authen::NTLM
is not installed, the C<NTLM> option will silently be skipped. Be warned
that, because of C<PLAIN>, erroneous username/password combinations will
@@ -194,7 +194,7 @@ The C<NTLM> authentication requires Authen::NTLM to be installed. Other
methods may be added later. Besides, you may also specify a CODE
reference which implements some authentication.
-An ARRAY as TYPE can be used to specify both mechanism as callback. When
+An ARRAY as $type can be used to specify both mechanism as callback. When
no array is used, callback of the pair is set to C<undef>. See
L<Mail::IMAPClient/authenticate> for the gory details.
@@ -207,7 +207,7 @@ example:
...
}
-=item $obj-E<gt>B<domain>([DOMAIN])
+=item $obj-E<gt>B<domain>( [$domain] )
Used in NTLM authentication to define the Windows domain which is
accessed. Initially set by L<new(domain)|Mail::Transport::IMAP4/"METHODS"> and defaults to the
@@ -224,22 +224,22 @@ by a normal user of this class.
=over 4
-=item $obj-E<gt>B<appendMessage>(MESSAGE, FOLDERNAME, [DATE])
+=item $obj-E<gt>B<appendMessage>( $message, $foldername, [$date] )
Write the message to the server.
The optional DATA can be a RFC-822 date or a timestamp.
-=item $obj-E<gt>B<createFolder>(NAME)
+=item $obj-E<gt>B<createFolder>($name)
Add a folder.
-=item $obj-E<gt>B<createImapClient>(CLASS, OPTIONS)
+=item $obj-E<gt>B<createImapClient>($class, %options)
-Create an object of CLASS, which extends L<Mail::IMAPClient>.
+Create an object of $class, which extends L<Mail::IMAPClient>.
-All OPTIONS will be passed to the constructor (new) of CLASS.
+All %options will be passed to the constructor (new) of $class.
-=item $obj-E<gt>B<currentFolder>([FOLDERNAME])
+=item $obj-E<gt>B<currentFolder>( [$foldername] )
Be sure that the specific FOLDER is the current one selected. If the
folder is already selected, no IMAP traffic will be produced.
@@ -247,21 +247,21 @@ folder is already selected, no IMAP traffic will be produced.
The boolean return value indicates whether the folder is selectable. It
will return undef if it does not exist.
-=item $obj-E<gt>B<deleteFolder>(NAME)
+=item $obj-E<gt>B<deleteFolder>($name)
Remove one folder.
-=item $obj-E<gt>B<destroyDeleted>(FOLDER)
+=item $obj-E<gt>B<destroyDeleted>($folder)
Command the server to delete for real all messages which are flagged to
be deleted.
-=item $obj-E<gt>B<fetch>(ARRAY-OF-MESSAGES, INFO)
+=item $obj-E<gt>B<fetch>(ARRAY-$of-$messages, $info)
-Get some INFO about the MESSAGES from the server. The specified messages
+Get some $info about the $messages from the server. The specified messages
shall extend L<Mail::Box::Net::Message|Mail::Box::Net::Message>, Returned is a list
of hashes, each info about one result. The contents of the hash
-differs per INFO, but at least a C<message> field will be present, to
+differs per $info, but at least a C<message> field will be present, to
relate to the message in question.
The right folder should be selected before this method is called. When
@@ -270,14 +270,14 @@ messages, and empty array is returned. The retrieval is done by
L<Mail::IMAPClient|Mail::IMAPClient> method C<fetch()>, which is then
parsed.
-=item $obj-E<gt>B<flagsToLabels>(WHAT|FLAGS)
+=item $obj-E<gt>B<flagsToLabels>($what|$flags)
-=item Mail::Transport::IMAP4-E<gt>B<flagsToLabels>(WHAT|FLAGS)
+=item Mail::Transport::IMAP4-E<gt>B<flagsToLabels>($what|$flags)
In SCALAR context, a hash with labels is returned. In LIST context, pairs
are returned.
-The WHAT parameter can be C<'SET'>, C<'CLEAR'>, or C<'REPLACE'>. With the
+The $what parameter can be C<'SET'>, C<'CLEAR'>, or C<'REPLACE'>. With the
latter, all standard imap flags do not appear in the list will be ignored:
their value may either by set or cleared. See L<getFlags()|Mail::Transport::IMAP4/"Protocol [internals]">
@@ -289,27 +289,27 @@ example: translating IMAP4 flags into MailBox flags
my @flags = ('\Seen', '\Flagged');
my $labels = Mail::Transport::IMAP4->flags2labels(SET => @flags);
-=item $obj-E<gt>B<folders>([FOLDERNAME])
+=item $obj-E<gt>B<folders>( [$foldername] )
Returns a list of folder names which are sub-folders of the specified
-FOLDERNAME. Without FOLDERNAME, the top-level foldernames are returned.
+$foldername. Without $foldername, the top-level foldernames are returned.
-=item $obj-E<gt>B<getFields>(UID, NAME, [NAME, ...])
+=item $obj-E<gt>B<getFields>( $uid, $name, [$name, ...] )
Get the records with the specified NAMES from the header. The header
fields are returned as list of L<Mail::Message::Field::Fast|Mail::Message::Field::Fast> objects.
When the name is C<ALL>, the whole header is returned.
-=item $obj-E<gt>B<getFlags>(FOLDER, ID)
+=item $obj-E<gt>B<getFlags>($folder, $id)
Returns the values of all flags which are related to the message with the
-specified ID. These flags are translated into the names which are
+specified $id. These flags are translated into the names which are
standard for the MailBox suite.
A HASH is returned. Names which do not appear will also provide
a value in the returned: the negative for the value is it was present.
-=item $obj-E<gt>B<getMessageAsString>(MESSAGE|UID)
+=item $obj-E<gt>B<getMessageAsString>($message|$uid)
Returns the whole text of the specified message: the head and the body.
@@ -341,82 +341,82 @@ Returns all predefined flags as list.
Establish a new connection to the IMAP4 server, using username and password.
-=item $obj-E<gt>B<setFlags>(ID, LABEL, VALUE, [LABEL, VALUE], ...)
+=item $obj-E<gt>B<setFlags>($id, $label, $value, [$label, $value], ...)
Change the flags on the message which are represented by the label. The
value which can be related to the label will be lost, because IMAP only
defines a boolean value, where MailBox labels can contain strings.
-Returned is a list of LABEL=>VALUE pairs which could not be send to
+Returned is a list of $label=>$value pairs which could not be send to
the IMAP server. These values may be cached in a different way.
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Transport::Receive/"Error handling">.
+Extends L<"Error handling" in Mail::Transport::Receive|Mail::Transport::Receive/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Transport::IMAP4-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Transport::IMAP4-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Transport::IMAP4-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Transport::IMAP4-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Transport::IMAP4-E<gt>B<logPriority>(LEVEL)
+=item Mail::Transport::IMAP4-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Transport::Receive/"Cleanup">.
+Extends L<"Cleanup" in Mail::Transport::Receive|Mail::Transport::Receive/"Cleanup">.
=over 4
@@ -453,12 +453,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Transport::Mailx;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Transport::Send';
@@ -33,19 +33,19 @@ standard, what may cause many headers to be lost. For these platforms (and
probably for other platforms as well), you can better not use this transport
mechanism.
-See L<documentation in the base class|Mail::Transport::Send/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Transport::Send|Mail::Transport::Send/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Transport::Send/"METHODS">.
+Extends L<"METHODS" in Mail::Transport::Send|Mail::Transport::Send/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Transport::Send/"Constructors">.
+Extends L<"Constructors" in Mail::Transport::Send|Mail::Transport::Send/"Constructors">.
=over 4
-=item Mail::Transport::Mailx-E<gt>B<new>(OPTIONS)
+=item Mail::Transport::Mailx-E<gt>B<new>(%options)
-Option --Defined in --Default
executable Mail::Transport undef
@@ -66,7 +66,7 @@ See L<documentation in the base class|Mail::Transport::Send/"Constructors">.
=item executable => FILENAME
-=item hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
+=item hostname => HOSTNAME|ARRAY
=item interval => SECONDS
@@ -104,117 +104,117 @@ distributions).
=head2 Sending mail
-See L<documentation in the base class|Mail::Transport::Send/"Sending mail">.
+Extends L<"Sending mail" in Mail::Transport::Send|Mail::Transport::Send/"Sending mail">.
=over 4
-=item $obj-E<gt>B<destinations>(MESSAGE, [ADDRESS|ARRAY-OF-ADDRESSES])
+=item $obj-E<gt>B<destinations>( $message, [$address|ARRAY] )
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<putContent>(MESSAGE, FILEHANDLE, OPTIONS)
+=item $obj-E<gt>B<putContent>($message, $fh, %options)
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<send>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<send>($message, %options)
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<trySend>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<trySend>($message, %options)
=back
=head2 Server connection
-See L<documentation in the base class|Mail::Transport::Send/"Server connection">.
+Extends L<"Server connection" in Mail::Transport::Send|Mail::Transport::Send/"Server connection">.
=over 4
-=item $obj-E<gt>B<findBinary>(NAME [, DIRECTORIES])
+=item $obj-E<gt>B<findBinary>( $name, [@directories] )
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<remoteHost>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<retry>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Transport::Send/"Error handling">.
+Extends L<"Error handling" in Mail::Transport::Send|Mail::Transport::Send/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Transport::Mailx-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Transport::Mailx-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Transport::Mailx-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Transport::Mailx-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Transport::Mailx-E<gt>B<logPriority>(LEVEL)
+=item Mail::Transport::Mailx-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Transport::Send/"Cleanup">.
+Extends L<"Cleanup" in Mail::Transport::Send|Mail::Transport::Send/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -259,12 +259,12 @@ accepting messages, but did not succeed sending it.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -8,13 +8,12 @@ use warnings;
package Mail::Transport::POP3;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Transport::Receive';
use IO::Socket ();
use Socket qw/$CRLF/;
-
use Digest::MD5 ();
@@ -27,19 +27,19 @@ You probably should B<not use this> module, but L<Mail::Box::POP3|Mail::Box::POP
module is the interface to POP3, whereas L<Mail::Box::POP3|Mail::Box::POP3> hides the
protocol weirdness and works as any other mail folder.
-See L<documentation in the base class|Mail::Transport::Receive/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Transport::Receive|Mail::Transport::Receive/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Transport::Receive/"METHODS">.
+Extends L<"METHODS" in Mail::Transport::Receive|Mail::Transport::Receive/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Transport::Receive/"Constructors">.
+Extends L<"Constructors" in Mail::Transport::Receive|Mail::Transport::Receive/"Constructors">.
=over 4
-=item Mail::Transport::POP3-E<gt>B<new>(OPTIONS)
+=item Mail::Transport::POP3-E<gt>B<new>(%options)
Create a new pop3 server connection. One object can only handle one
connection: for a single user to one single server. If the server
@@ -73,7 +73,7 @@ used, first APOP is tried, and then LOGIN.
=item executable => FILENAME
-=item hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
+=item hostname => HOSTNAME|ARRAY
=item interval => SECONDS
@@ -103,13 +103,13 @@ used, first APOP is tried, and then LOGIN.
=head2 Receiving mail
-See L<documentation in the base class|Mail::Transport::Receive/"Receiving mail">.
+Extends L<"Receiving mail" in Mail::Transport::Receive|Mail::Transport::Receive/"Receiving mail">.
=over 4
-=item $obj-E<gt>B<receive>([UNIQUE-MESSAGE-ID])
+=item $obj-E<gt>B<receive>( [$unique_message_id] )
-See L<Mail::Transport::Receive/"Receiving mail">
+Inherited, see L<Mail::Transport::Receive/"Receiving mail">
=back
@@ -122,7 +122,7 @@ See L<Mail::Transport::Receive/"Receiving mail">
Mark all messages that have been fetched with L<message()|Mail::Transport::POP3/"Exchanging information"> for deletion.
See L<fetched()|Mail::Transport::POP3/"Exchanging information">.
-=item $obj-E<gt>B<deleted>(BOOLEAN, ID's)
+=item $obj-E<gt>B<deleted>(BOOLEAN, @ids)
Either mark the specified message(s) to be deleted on the remote server or
unmark them for deletion (if the first parameter is false). Deletion of
@@ -154,12 +154,12 @@ See also L<deleteFetched()|Mail::Transport::POP3/"Exchanging information">.
Returns the total number of octets used by the mailbox on the remote server.
-=item $obj-E<gt>B<header>(ID, [BODYLINES])
+=item $obj-E<gt>B<header>( $id, [$bodylines] )
Returns a reference to an array which contains the header of the message
-with the specified ID. C<undef> is returned if something has gone wrong.
+with the specified $id. C<undef> is returned if something has gone wrong.
-The optional integer BODYLINES specifies the number of lines from the body
+The optional integer $bodylines specifies the number of lines from the body
which should be added, by default none.
example:
@@ -167,9 +167,9 @@ example:
my $ref_lines = $pop3->header($uidl);
print @$ref_lines;
-=item $obj-E<gt>B<id2n>(ID)
+=item $obj-E<gt>B<id2n>($id)
-Translates the unique ID of a message into a sequence number which
+Translates the unique $id of a message into a sequence number which
represents the message as long a this connection to the POP3 server
exists. When the message has been deleted for some reason, C<undef>
is returned.
@@ -177,12 +177,12 @@ is returned.
=item $obj-E<gt>B<ids>()
Returns a list (in list context) or a reference to a list (in scalar context)
-of all ID's which are known by the server on this moment.
+of all IDs which are known by the server on this moment.
-=item $obj-E<gt>B<message>(ID)
+=item $obj-E<gt>B<message>($id)
Returns a reference to an array which contains the lines of the
-message with the specified ID. Returns C<undef> if something has gone
+message with the specified $id. Returns C<undef> if something has gone
wrong.
example:
@@ -190,9 +190,9 @@ example:
my $ref_lines = $pop3->message($uidl);
print @$ref_lines;
-=item $obj-E<gt>B<messageSize>(ID)
+=item $obj-E<gt>B<messageSize>($id)
-Returns the size of the message which is indicated by the ID, in octets.
+Returns the size of the message which is indicated by the $id, in octets.
If the message has been deleted on the remote server, this will return
C<undef>.
@@ -214,17 +214,17 @@ by a normal user of this class.
Establish a new connection to the POP3 server, using username and password.
-=item $obj-E<gt>B<send>(SOCKET, data)
+=item $obj-E<gt>B<send>($socket, $data)
-Send data to the indicated socket and return the first line read from
+Send $data to the indicated socket and return the first line read from
that socket. Logs an error if either writing to or reading from socket failed.
This method does B<not> attempt to reconnect or anything: if reading or
writing the socket fails, something is very definitely wrong.
-=item $obj-E<gt>B<sendList>(SOCKET, COMMAND)
+=item $obj-E<gt>B<sendList>($socket, $command)
-Sends the indicated COMMAND to the specified socket, and retrieves the
+Sends the indicated $command to the specified socket, and retrieves the
response. It returns a reference to an array with all the lines that
were reveived after the first C<+OK> line and before the end-of-message
delimiter (a single dot on a line). Returns C<undef>
@@ -241,7 +241,7 @@ If the contact to the server was still present, or could be established,
an IO::Socket::INET object is returned. Else, C<undef> is returned and
no further actions should be tried on the object.
-=item $obj-E<gt>B<status>(SOCKET)
+=item $obj-E<gt>B<status>($socket)
Update the current status of folder on the remote POP3 server.
@@ -249,21 +249,21 @@ Update the current status of folder on the remote POP3 server.
=head2 Server connection
-See L<documentation in the base class|Mail::Transport::Receive/"Server connection">.
+Extends L<"Server connection" in Mail::Transport::Receive|Mail::Transport::Receive/"Server connection">.
=over 4
-=item $obj-E<gt>B<findBinary>(NAME [, DIRECTORIES])
+=item $obj-E<gt>B<findBinary>( $name, [@directories] )
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<remoteHost>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<retry>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<url>()
@@ -273,75 +273,75 @@ Represent this pop3 connection as URL.
=head2 Error handling
-See L<documentation in the base class|Mail::Transport::Receive/"Error handling">.
+Extends L<"Error handling" in Mail::Transport::Receive|Mail::Transport::Receive/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Transport::POP3-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Transport::POP3-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Transport::POP3-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Transport::POP3-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Transport::POP3-E<gt>B<logPriority>(LEVEL)
+=item Mail::Transport::POP3-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Transport::Receive/"Cleanup">.
+Extends L<"Cleanup" in Mail::Transport::Receive|Mail::Transport::Receive/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -414,12 +414,12 @@ service on the specified port.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Transport::Qmail;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Transport::Send';
@@ -21,19 +21,19 @@ Mail::Transport::Qmail - transmit messages using external Qmail program
Implements mail transport using the external programs C<'qmail-inject'>,
part of the qmail mail-delivery system.
-See L<documentation in the base class|Mail::Transport::Send/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Transport::Send|Mail::Transport::Send/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Transport::Send/"METHODS">.
+Extends L<"METHODS" in Mail::Transport::Send|Mail::Transport::Send/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Transport::Send/"Constructors">.
+Extends L<"Constructors" in Mail::Transport::Send|Mail::Transport::Send/"Constructors">.
=over 4
-=item Mail::Transport::Qmail-E<gt>B<new>(OPTIONS)
+=item Mail::Transport::Qmail-E<gt>B<new>(%options)
-Option --Defined in --Default
executable Mail::Transport undef
@@ -53,7 +53,7 @@ See L<documentation in the base class|Mail::Transport::Send/"Constructors">.
=item executable => FILENAME
-=item hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
+=item hostname => HOSTNAME|ARRAY
=item interval => SECONDS
@@ -81,117 +81,117 @@ See L<documentation in the base class|Mail::Transport::Send/"Constructors">.
=head2 Sending mail
-See L<documentation in the base class|Mail::Transport::Send/"Sending mail">.
+Extends L<"Sending mail" in Mail::Transport::Send|Mail::Transport::Send/"Sending mail">.
=over 4
-=item $obj-E<gt>B<destinations>(MESSAGE, [ADDRESS|ARRAY-OF-ADDRESSES])
+=item $obj-E<gt>B<destinations>( $message, [$address|ARRAY] )
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<putContent>(MESSAGE, FILEHANDLE, OPTIONS)
+=item $obj-E<gt>B<putContent>($message, $fh, %options)
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<send>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<send>($message, %options)
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<trySend>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<trySend>($message, %options)
=back
=head2 Server connection
-See L<documentation in the base class|Mail::Transport::Send/"Server connection">.
+Extends L<"Server connection" in Mail::Transport::Send|Mail::Transport::Send/"Server connection">.
=over 4
-=item $obj-E<gt>B<findBinary>(NAME [, DIRECTORIES])
+=item $obj-E<gt>B<findBinary>( $name, [@directories] )
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<remoteHost>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<retry>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Transport::Send/"Error handling">.
+Extends L<"Error handling" in Mail::Transport::Send|Mail::Transport::Send/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Transport::Qmail-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Transport::Qmail-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Transport::Qmail-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Transport::Qmail-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Transport::Qmail-E<gt>B<logPriority>(LEVEL)
+=item Mail::Transport::Qmail-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Transport::Send/"Cleanup">.
+Extends L<"Cleanup" in Mail::Transport::Send|Mail::Transport::Send/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -236,12 +236,12 @@ found in the message itself about the destination.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Transport::Receive;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Transport';
@@ -36,21 +36,21 @@ Implements the POP3 protocol. See also L<Mail::Box::POP3|Mail::Box::POP3>.
=back
-See L<documentation in the base class|Mail::Transport/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Transport|Mail::Transport/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Transport/"METHODS">.
+Extends L<"METHODS" in Mail::Transport|Mail::Transport/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Transport/"Constructors">.
+Extends L<"Constructors" in Mail::Transport|Mail::Transport/"Constructors">.
=over 4
-=item Mail::Transport::Receive-E<gt>B<new>(OPTIONS)
+=item Mail::Transport::Receive-E<gt>B<new>(%options)
-See L<Mail::Transport/"METHODS">
+Inherited, see L<Mail::Transport/"METHODS">
=back
@@ -58,7 +58,7 @@ See L<Mail::Transport/"METHODS">
=over 4
-=item $obj-E<gt>B<receive>([UNIQUE-MESSAGE-ID])
+=item $obj-E<gt>B<receive>( [$unique_message_id] )
Receive one message from the remote server. Some receivers will provide
the next message automatically, other are random access and use the
@@ -68,95 +68,95 @@ specified ID.
=head2 Server connection
-See L<documentation in the base class|Mail::Transport/"Server connection">.
+Extends L<"Server connection" in Mail::Transport|Mail::Transport/"Server connection">.
=over 4
-=item $obj-E<gt>B<findBinary>(NAME [, DIRECTORIES])
+=item $obj-E<gt>B<findBinary>( $name, [@directories] )
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<remoteHost>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<retry>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Transport/"Error handling">.
+Extends L<"Error handling" in Mail::Transport|Mail::Transport/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Transport::Receive-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Transport::Receive-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Transport::Receive-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Transport::Receive-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Transport::Receive-E<gt>B<logPriority>(LEVEL)
+=item Mail::Transport::Receive-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Transport/"Cleanup">.
+Extends L<"Cleanup" in Mail::Transport|Mail::Transport/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -187,12 +187,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Transport::SMTP;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Transport::Send';
@@ -34,22 +34,26 @@ sub init($)
|| eval { require Net::Config; $Net::Config::inet_domain }
|| eval { require Net::Domain; Net::Domain::hostfqdn() };
- $self->{MTS_net_smtp_opts}
- = { Hello => $helo
- , Debug => ($args->{smtp_debug} || 0)
- };
-
+ $self->{MTS_net_smtp_opts} =
+ +{ Hello => $helo
+ , Debug => ($args->{smtp_debug} || 0)
+ };
+ $self->{MTS_esmtp_options} = $args->{esmtp_options};
+ $self->{MTS_from} = $args->{from};
$self;
}
-#------------------------------------------
-
sub trySend($@)
{ my ($self, $message, %args) = @_;
+ my %send_options =
+ ( %{$self->{MTS_esmtp_options} || {}}
+ , %{$args{esmtp_options} || {}}
+ );
+
# From whom is this message.
- my $from = $args{from} || $message->sender || '<>';
+ my $from = $args{from} || $self->{MTS_from} || $message->sender || '<>';
$from = $from->address if ref $from && $from->isa('Mail::Address');
# Who are the destinations.
@@ -83,7 +87,7 @@ sub trySend($@)
unless $server = $self->contactAnyServer;
return (0, $server->code, $server->message, 'FROM', $server->quit)
- unless $server->mail($from);
+ unless $server->mail($from, %send_options);
foreach (@to)
{ next if $server->to($_);
@@ -111,7 +115,7 @@ sub trySend($@)
return 0 unless $server = $self->contactAnyServer;
$server->quit, return 0
- unless $server->mail($from);
+ unless $server->mail($from, %send_options);
foreach (@to)
{
@@ -137,7 +141,6 @@ sub trySend($@)
#------------------------------------------
-
sub contactAnyServer()
{ my $self = shift;
@@ -171,14 +174,10 @@ sub contactAnyServer()
undef;
}
-#------------------------------------------
-
sub tryConnectTo($@)
{ my ($self, $host) = (shift, shift);
Net::SMTP->new($host, @_);
}
-#------------------------------------------
-
1;
@@ -24,40 +24,55 @@ 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">.
+B<warning:> you may need to install Net::SMTPS, to get TLS support.
+
+Extends L<"DESCRIPTION" in Mail::Transport::Send|Mail::Transport::Send/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Transport::Send/"METHODS">.
+Extends L<"METHODS" in Mail::Transport::Send|Mail::Transport::Send/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Transport::Send/"Constructors">.
+Extends L<"Constructors" in Mail::Transport::Send|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'
+=item Mail::Transport::SMTP-E<gt>B<new>(%options)
+
+ -Option --Defined in --Default
+ esmtp_options {}
+ executable Mail::Transport undef
+ from 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 esmtp_options => HASH
+
+[2.116] ESMTP options to pass to Net::SMTP. See the L<Net::SMTP>
+documentation for full details. Options can also be passed at send time.
+For example: C<< { XVERP => 1 } >>
+
=item executable => FILENAME
+=item from => ADDRESS
+
+Allows a default sender address to be specified globally.
+See L<trySend()|Mail::Transport::SMTP/"METHODS"> for full details.
+
=item helo => HOST
The fully qualified name of the sender's host (your system) which
@@ -66,7 +81,7 @@ 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 hostname => HOSTNAME|ARRAY
=item interval => SECONDS
@@ -111,25 +126,25 @@ Authen::SASL object.
=head2 Sending mail
-See L<documentation in the base class|Mail::Transport::Send/"Sending mail">.
+Extends L<"Sending mail" in Mail::Transport::Send|Mail::Transport::Send/"Sending mail">.
=over 4
-=item $obj-E<gt>B<destinations>(MESSAGE, [ADDRESS|ARRAY-OF-ADDRESSES])
+=item $obj-E<gt>B<destinations>( $message, [$address|ARRAY] )
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<putContent>(MESSAGE, FILEHANDLE, OPTIONS)
+=item $obj-E<gt>B<putContent>($message, $fh, %options)
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<send>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<send>($message, %options)
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<trySend>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<trySend>($message, %options)
-Try to send the MESSAGE once. This may fail, in which case this
+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:
@@ -140,12 +155,17 @@ 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 []
+ -Option --Default
+ esmtp_options {}
+ from < >
+ to []
=over 2
+=item esmtp_options => HASH
+
+Additional or overridden EMSTP options. See L<new(esmtp_options)|Mail::Transport::SMTP/"METHODS">
+
=item from => ADDRESS
Your own identification. This may be fake. If not specified, it is
@@ -165,7 +185,7 @@ object.
=head2 Server connection
-See L<documentation in the base class|Mail::Transport::Send/"Server connection">.
+Extends L<"Server connection" in Mail::Transport::Send|Mail::Transport::Send/"Server connection">.
=over 4
@@ -175,96 +195,96 @@ 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])
+=item $obj-E<gt>B<findBinary>( $name, [@directories] )
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<remoteHost>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<retry>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
-=item $obj-E<gt>B<tryConnectTo>(HOST, OPTIONS)
+=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.
+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">.
+Extends L<"Error handling" in Mail::Transport::Send|Mail::Transport::Send/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Transport::SMTP-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">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Transport::SMTP-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Transport::SMTP-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Transport::SMTP-E<gt>B<logPriority>(LEVEL)
+=item Mail::Transport::SMTP-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Transport::Send/"Cleanup">.
+Extends L<"Cleanup" in Mail::Transport::Send|Mail::Transport::Send/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -306,12 +326,12 @@ found in the message itself about the destination.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Transport::Send;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Transport';
@@ -53,13 +53,13 @@ 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).
+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>
@@ -70,19 +70,19 @@ known to have exploitable security breaches.
=back
-See L<documentation in the base class|Mail::Transport/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Transport|Mail::Transport/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Transport/"METHODS">.
+Extends L<"METHODS" in Mail::Transport|Mail::Transport/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Transport/"Constructors">.
+Extends L<"Constructors" in Mail::Transport|Mail::Transport/"Constructors">.
=over 4
-=item Mail::Transport::Send-E<gt>B<new>(OPTIONS)
+=item Mail::Transport::Send-E<gt>B<new>(%options)
-Option --Defined in --Default
executable Mail::Transport undef
@@ -102,7 +102,7 @@ See L<documentation in the base class|Mail::Transport/"Constructors">.
=item executable => FILENAME
-=item hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
+=item hostname => HOSTNAME|ARRAY
=item interval => SECONDS
@@ -132,20 +132,20 @@ See L<documentation in the base class|Mail::Transport/"Constructors">.
=over 4
-=item $obj-E<gt>B<destinations>(MESSAGE, [ADDRESS|ARRAY-OF-ADDRESSES])
+=item $obj-E<gt>B<destinations>( $message, [$address|ARRAY] )
-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.
+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. It may also be an ARRAY of addresses.
-If no ADDRESS is specified, the message is scanned for resent groups
+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)
+=item $obj-E<gt>B<putContent>($message, $fh, %options)
-Print the content of the MESSAGE to the FILEHANDLE.
+Print the content of the $message to the $fh.
-Option --Default
body_only <false>
@@ -164,9 +164,9 @@ means that they are not printed.
=back
-=item $obj-E<gt>B<send>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<send>($message, %options)
-Transmit the MESSAGE, which may be anything what can be coerced into a
+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.
@@ -188,7 +188,7 @@ from the (Resent-)To, (Resent-)Cc, and (Resent-)Bcc.
=back
-=item $obj-E<gt>B<trySend>(MESSAGE, OPTIONS)
+=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
@@ -198,95 +198,95 @@ the exit status of the command which was started.
=head2 Server connection
-See L<documentation in the base class|Mail::Transport/"Server connection">.
+Extends L<"Server connection" in Mail::Transport|Mail::Transport/"Server connection">.
=over 4
-=item $obj-E<gt>B<findBinary>(NAME [, DIRECTORIES])
+=item $obj-E<gt>B<findBinary>( $name, [@directories] )
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<remoteHost>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<retry>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Transport/"Error handling">.
+Extends L<"Error handling" in Mail::Transport|Mail::Transport/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Transport::Send-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">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Transport::Send-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Transport::Send-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Transport::Send-E<gt>B<logPriority>(LEVEL)
+=item Mail::Transport::Send-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Transport/"Cleanup">.
+Extends L<"Cleanup" in Mail::Transport|Mail::Transport/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -331,12 +331,12 @@ but only receive message.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Transport::Sendmail;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Transport::Send';
@@ -26,19 +26,19 @@ Some people use Postfix as MTA. Postfix can be installed as replacement
for Sendmail: is provides a program with the same name and options. So,
this module supports postfix as well.
-See L<documentation in the base class|Mail::Transport::Send/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Transport::Send|Mail::Transport::Send/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Transport::Send/"METHODS">.
+Extends L<"METHODS" in Mail::Transport::Send|Mail::Transport::Send/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Transport::Send/"Constructors">.
+Extends L<"Constructors" in Mail::Transport::Send|Mail::Transport::Send/"Constructors">.
=over 4
-=item Mail::Transport::Sendmail-E<gt>B<new>(OPTIONS)
+=item Mail::Transport::Sendmail-E<gt>B<new>(%options)
-Option --Defined in --Default
executable Mail::Transport undef
@@ -59,7 +59,7 @@ See L<documentation in the base class|Mail::Transport::Send/"Constructors">.
=item executable => FILENAME
-=item hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
+=item hostname => HOSTNAME|ARRAY
=item interval => SECONDS
@@ -93,23 +93,23 @@ because the latter will be taken by sendmail as one word only.
=head2 Sending mail
-See L<documentation in the base class|Mail::Transport::Send/"Sending mail">.
+Extends L<"Sending mail" in Mail::Transport::Send|Mail::Transport::Send/"Sending mail">.
=over 4
-=item $obj-E<gt>B<destinations>(MESSAGE, [ADDRESS|ARRAY-OF-ADDRESSES])
+=item $obj-E<gt>B<destinations>( $message, [$address|ARRAY] )
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<putContent>(MESSAGE, FILEHANDLE, OPTIONS)
+=item $obj-E<gt>B<putContent>($message, $fh, %options)
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<send>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<send>($message, %options)
-See L<Mail::Transport::Send/"Sending mail">
+Inherited, see L<Mail::Transport::Send/"Sending mail">
-=item $obj-E<gt>B<trySend>(MESSAGE, OPTIONS)
+=item $obj-E<gt>B<trySend>($message, %options)
-Option --Default
sendmail_options undef
@@ -124,95 +124,95 @@ See L<Mail::Transport::Send/"Sending mail">
=head2 Server connection
-See L<documentation in the base class|Mail::Transport::Send/"Server connection">.
+Extends L<"Server connection" in Mail::Transport::Send|Mail::Transport::Send/"Server connection">.
=over 4
-=item $obj-E<gt>B<findBinary>(NAME [, DIRECTORIES])
+=item $obj-E<gt>B<findBinary>( $name, [@directories] )
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<remoteHost>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=item $obj-E<gt>B<retry>()
-See L<Mail::Transport/"Server connection">
+Inherited, see L<Mail::Transport/"Server connection">
=back
=head2 Error handling
-See L<documentation in the base class|Mail::Transport::Send/"Error handling">.
+Extends L<"Error handling" in Mail::Transport::Send|Mail::Transport::Send/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Transport::Sendmail-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Transport::Sendmail-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Transport::Sendmail-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Transport::Sendmail-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Transport::Sendmail-E<gt>B<logPriority>(LEVEL)
+=item Mail::Transport::Sendmail-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Transport::Send/"Cleanup">.
+Extends L<"Cleanup" in Mail::Transport::Send|Mail::Transport::Send/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -257,12 +257,12 @@ found in the message itself about the destination.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -1,4 +1,4 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
@@ -7,7 +7,7 @@ use warnings;
package Mail::Transport;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use base 'Mail::Reporter';
@@ -27,8 +27,6 @@ my %mailers =
, smtp => '::SMTP'
);
-#------------------------------------------
-
sub new(@)
{ my $class = shift;
@@ -86,22 +84,17 @@ sub init($)
#------------------------------------------
-
sub remoteHost()
{ my $self = shift;
@$self{ qw/MT_hostname MT_port MT_username MT_password/ };
}
-#------------------------------------------
-
sub retry()
{ my $self = shift;
@$self{ qw/MT_interval MT_retry MT_timeout/ };
}
-#------------------------------------------
-
my @safe_directories
= qw(/usr/local/bin /usr/bin /bin /sbin /usr/sbin /usr/lib);
@@ -122,5 +115,4 @@ sub findBinary($@)
#------------------------------------------
-
1;
@@ -38,19 +38,19 @@ functionality for send protocols, like SMTP. L<Mail::Transport::Receive|Mail::T
also extends this class, and offers receive method. Some transport
protocols will implement both sending and receiving.
-See L<documentation in the base class|Mail::Reporter/"DESCRIPTION">.
+Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 METHODS
-See L<documentation in the base class|Mail::Reporter/"METHODS">.
+Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
-See L<documentation in the base class|Mail::Reporter/"Constructors">.
+Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
-=item Mail::Transport-E<gt>B<new>(OPTIONS)
+=item Mail::Transport-E<gt>B<new>(%options)
-Option --Defined in --Default
executable undef
@@ -76,9 +76,9 @@ decreases the flexible usage of your program: moving your program
to other systems may involve changing the path to the executable,
which otherwise would work auto-detect and unmodified.
-=item hostname => HOSTNAME|ARRAY-OF-HOSTNAMES
+=item hostname => HOSTNAME|ARRAY
-The host on which the server runs. Some protocols accept an array
+The host on which the server runs. Some protocols accept an ARRAY
of alternatives for this option.
=item interval => SECONDS
@@ -135,11 +135,11 @@ protocol implementation can be found in L<Mail::Transport::POP3|Mail::Transport:
=over 4
-=item $obj-E<gt>B<findBinary>(NAME [, DIRECTORIES])
+=item $obj-E<gt>B<findBinary>( $name, [@directories] )
-Look for a binary with the specified NAME in the directories which
+Look for a binary with the specified $name in the directories which
are defined to be safe. The list of standard directories is followed
-by the optional DIRECTORIES. The full pathname is returned.
+by the optional @directories. The full pathname is returned.
You may specify L<new(proxy)|Mail::Transport/"METHODS">, which specifies the absolute name
of the binary to be used.
@@ -157,75 +157,75 @@ Returns the retry interval, retry count, and timeout for the connection.
=head2 Error handling
-See L<documentation in the base class|Mail::Reporter/"Error handling">.
+Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<addReport>(OBJECT)
+=item $obj-E<gt>B<addReport>($object)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-=item Mail::Transport-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
+=item Mail::Transport-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
+=item $obj-E<gt>B<log>( [$level, [$strings]] )
-=item Mail::Transport-E<gt>B<log>([LEVEL [,STRINGS]])
+=item Mail::Transport-E<gt>B<log>( [$level, [$strings]] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<logPriority>(LEVEL)
+=item $obj-E<gt>B<logPriority>($level)
-=item Mail::Transport-E<gt>B<logPriority>(LEVEL)
+=item Mail::Transport-E<gt>B<logPriority>($level)
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<report>([LEVEL])
+=item $obj-E<gt>B<report>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<reportAll>([LEVEL])
+=item $obj-E<gt>B<reportAll>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
-=item $obj-E<gt>B<trace>([LEVEL])
+=item $obj-E<gt>B<trace>( [$level] )
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
-See L<Mail::Reporter/"Error handling">
+Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
-See L<documentation in the base class|Mail::Reporter/"Cleanup">.
+Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
-See L<Mail::Reporter/"Cleanup">
+Inherited, see L<Mail::Reporter/"Cleanup">
=back
@@ -256,12 +256,12 @@ of the package.
=head1 SEE ALSO
-This module is part of Mail-Box distribution version 2.109,
-built on August 19, 2013. Website: F<http://perl.overmeer.net/mailbox/>
+This module is part of Mail-Box distribution version 2.118,
+built on February 26, 2015. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
-Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.
+Copyrights 2001-2015 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.
@@ -9,7 +9,8 @@ use File::Basename;
use lib qw(tests lib);
# test env at home
-$ENV{PERL5LIB} .= qw(:/home/markov/shared/perl/IMAPClient/lib);
+$ENV{PERL5LIB} .= qw(:/home/markov/shared/perl/IMAPClient/lib)
+ if $ENV{MARKOV_DEVEL};
delete $ENV{PERLIO};
use Config;
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::01platform::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"platform specific preparations"}
@@ -3,7 +3,6 @@ use warnings;
use strict;
use Test::More;
-use Test::Pod;
use File::Spec::Functions qw/updir catdir/;
BEGIN
@@ -16,6 +15,6 @@ BEGIN
if qx(/bin/pwd) =~ m[^/home/markov/];
}
-my @dirs = map { catdir updir, $_ } qw(lib script);
+my @dirs = map catdir(updir, $_), qw(lib script);
all_pod_files_ok all_pod_files @dirs;
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::02dist::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"check distribution"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::10reporter::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Report; general base class"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::11field::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Message::Field; fields in headers"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::12head::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Message::Head; message headers"}
@@ -26,6 +26,11 @@ the reading into a lines body
would work (or not)
SIMULATED_FILE
+# Test script has Unix line endings (LF) even under Windows.
+# Replace LF by CRLF if running under Windows,
+# so the file is truly a Windows file:
+$filedata =~ s/\n/\r\n/gs if $Mail::Message::crlf_platform;
+
my $f = IO::Scalar->new(\$filedata);
my $body = Mail::Message::Body::File->new(file => $f);
@@ -33,7 +38,10 @@ ok($body, 'body creation from file');
is($body->string, $filedata, 'stringify');
cmp_ok($body->nrLines, "==", 5, 'nr lines');
-cmp_ok($body->size, "==", length $filedata, 'size');
+# Mail::Message::Body::File::size() substracts 1 per line (for CR) on Windows
+my $body_length = length $filedata;
+$body_length -= $body->nrLines if $Mail::Message::crlf_platform;
+cmp_ok($body->size, "==", $body_length, 'size');
my $fakeout;
my $g = IO::Scalar->new(\$fakeout);
@@ -52,7 +60,7 @@ $body = Mail::Message::Body::File->new(data => [@filedata]);
ok($body, 'creation from array of lines');
is($body->string, $filedata, 'data');
cmp_ok($body->nrLines, "==", 5, 'nr lines');
-cmp_ok($body->size, "==", length $filedata, 'size');
+cmp_ok($body->size, "==", $body_length, 'size');
$fakeout = '';
$body->print($g);
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::13body::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Message::Body; message bodies"}
@@ -6,7 +6,9 @@
use strict;
use warnings;
-package Mail::Message::Field::Attribute; # define package name
+# define package name when loading fails
+package Mail::Message::Field::Attribute;
+package Mail::Message::Field::Full;
package main;
use lib qw(. .. tests);
@@ -26,7 +28,9 @@ BEGIN {
exit 0;
}
else
- { plan tests => 98;
+ { plan tests => 100;
+ eval 'require Mail::Message::Field::Full';
+ plan skip_all => $@ if $@;
}
}
@@ -237,3 +241,15 @@ ok($m1 ne $m4, "$m1 ne $m4");
# fallback
my $m5 = $mmfa->new(M => 42);
cmp_ok($m5 +1, '==', 43, 'fallback');
+
+# rt.cpan.org#90342
+my $h = Mail::Message::Field::Full->new('Content-Disposition' =>
+ 'inline;
+ filename*0="Selling #1 (signed) -";
+ filename*1=" 11-13.p";
+ filename*2=df');
+
+#use Data::Dumper;
+#warn Dumper $h;
+isa_ok($h, 'Mail::Message::Field::Structured');
+is($h->attribute('filename'), 'Selling #1 (signed) - 11-13.pdf');
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::14fieldu::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Message::Field::Full; unicode fields"}
@@ -15,11 +15,15 @@ use Mail::Box::Parser::Perl;
use Mail::Message::Body::File;
use Mail::Message::Head;
+# MO: I do not know whether there is an other way to get this to work
+# on Windows without error messages.
+my $trusted = $Mail::Message::crlf_platform;
+
###
### First carefully read the first message
###
-my $parser = Mail::Box::Parser::Perl->new(filename => $src);
+my $parser = Mail::Box::Parser::Perl->new(filename => $src, trusted =>$trusted);
ok(defined $parser, "creation of parser");
$parser->pushSeparator('From ');
@@ -123,7 +127,7 @@ $parser->stop;
undef $parser;
-$parser = Mail::Box::Parser::Perl->new(filename => $src);
+$parser = Mail::Box::Parser::Perl->new(filename => $src, trusted => $trusted);
$parser->pushSeparator('From ');
my $count = 0;
@@ -163,7 +167,7 @@ $parser->stop;
undef $parser;
-$parser = Mail::Box::Parser::Perl->new(filename => $src);
+$parser = Mail::Box::Parser::Perl->new(filename => $src, trusted => $trusted);
$parser->pushSeparator('From ');
$count = 0;
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::20pparser::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Box::Parser::Perl; parser in pure perl"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::30encode::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Message::TransferEnc; transfer encodings"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::31fgroups::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Message::Head::FieldGroup; grouping fields"}
@@ -14,7 +14,7 @@ use File::Compare;
use Mail::Box::Mbox;
-my @src = (folder => "=$fn", folderdir => 'folders');
+my @src = (folder => "=$fn", folderdir => $folderdir);
ok(Mail::Box::Mbox->foundIn(@src), 'check foundIn');
@@ -23,11 +23,11 @@ use Mail::Box::Mbox;
unlink $cpy;
copy $src, $cpy
- or die "Cannot create test folder: $!\n";
+ or die "Cannot create test folder $cpy: $!\n";
my $folder = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'ALWAYS'
, access => 'rw'
@@ -57,7 +57,7 @@ ok($folder->write(policy => 'REPLACE'));
my $copy = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'ALWAYS'
);
@@ -22,11 +22,11 @@ use Mail::Box::Mbox;
#
copy $src, $cpy
- or die "Cannot create test folder: $!\n";
+ or die "Cannot create test folder $cpy: $!\n";
my $folder = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'LAZY'
, access => 'rw'
@@ -80,7 +80,7 @@ cmp_ok($oldsize, "==", -s $folder->filename, "expected size");
my $copy = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'LAZY'
);
@@ -17,7 +17,7 @@ use File::Spec;
use Mail::Box::Mbox;
use Mail::Message::Construct;
-my $top = File::Spec->catdir('folders', 'Mail');
+my $top = File::Spec->catdir($folderdir, 'Mail');
clean_dir $top;
@@ -28,7 +28,7 @@ ok($mgr);
my $folder = $mgr->open
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'LAZY'
, access => 'rw'
@@ -21,12 +21,13 @@ use Mail::Box::Mbox;
# over our test file.
#
+unlink $cpy;
copy $src, $cpy
or die "Cannot create test folder $cpy: $!\n";
my $folder = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'LAZY'
, access => 'rw'
@@ -99,7 +100,7 @@ $folder->close;
my $copy = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'ALWAYS'
);
@@ -124,7 +125,7 @@ ok(!@folder_subjects);
$copy = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'LAZY'
, access => 'rw'
@@ -142,7 +143,7 @@ ok($copy->write(policy => 'INPLACE'), "write folder with fewer messsages");
$copy = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'ALWAYS'
);
@@ -159,7 +160,7 @@ ok(! defined $copy, "Folder is really closed");
$copy = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'ALWAYS'
, access => 'rw'
@@ -174,7 +175,7 @@ ok($copy->write(policy => 'INPLACE'), "write folder with fewer messsages");
$copy = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'ALWAYS'
);
@@ -191,7 +192,7 @@ ok(! defined $copy, "Folder is really closed");
$copy = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'ALWAYS'
, access => 'rw'
@@ -206,7 +207,7 @@ ok($copy->write(policy => 'INPLACE'), "write folder with fewer messsages");
$copy = new Mail::Box::Mbox
( folder => "=$cpyfn"
- , folderdir => 'folders'
+ , folderdir => $folderdir
, lock_type => 'NONE'
, extract => 'ALWAYS'
);
@@ -20,6 +20,7 @@ use Mail::Box::Manager;
# over our test file.
#
+unlink $cpy;
copy $src, $cpy
or die "Cannot create test folder $cpy: $!\n";
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::40mbox::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Box::Mbox; mbox folders"}
@@ -45,7 +45,53 @@ my @lines = split /^/, $out;
cmp_ok(@lines, '==', $folder->messages);
$out = join '', sort @lines;
-my $dump = <<'DUMP';
+my $dump = $Mail::Message::crlf_platform ? <<'__DUMP_CRLF' : <<'__DUMP_LF';
+1.4K Resize with Transparency
+1.3K *- Re: File Conversion From HTML to PS and TIFF
+2.1K `--*- Re: File Conversion From HTML to PS and TIFF
+2.1K `- Re: File Conversion From HTML to PS and TIFF
+1.5K Transparency question
+2.5K RE: Transparency question
+3.4K RE: Transparency question
+5.7K RE: Transparency question
+7.4K RE: Transparency question
+2.8K RE: jpeg2000 question
+1.3K *- Problem resizing images through perl script
+843 | `- Re: Problem resizing images through perl script
+1.9K | `- RE: Problem resizing images through perl script
+1.0K | `- Re: Problem resizing images through perl script
+1.2K `- Re: Convert HTM, HTML files to the .jpg format
+766 Undefined Symbol: SetWarningHandler
+1.1K `- Re: Undefined Symbol: SetWarningHandler
+1.9K *- Re: watermarks/embossing
+316 Re: Annotate problems (PR#298)
+585 `- Re: Annotate problems (PR#298)
+1.0K
+1.4K `- Re: your mail
+2.0K `- Re: your mail
+156 Re: your mail
+703 `- Re: your mail
+194 Re: your mail
+2.0K
+684 Re: your mail
+4.5K `- Re: your mail
+569 mailing list archives
+1.4K delegates.mgk set-up for unixware printing
+1.5K printing solution for UW 7.1
+1.5K *- Re: converts new sharpen factors
+1.2K New ImageMagick mailing list
+ 28 subscribe
+847 Confirmation for subscribe magick-developer
+ 64 `- Re: Confirmation for subscribe magick-developer
+ 11K Welcome to magick-developer
+1.7K core dump in simple ImageMagick example
+2.2K `- Re: core dump in simple ImageMagick example
+908 `- Re: core dump in simple ImageMagick example
+770 `- Re: core dump in simple ImageMagick example
+2.0K Core Dump on ReadImage
+1.0K `- Re: Core Dump on ReadImage
+1.6K Font metrics
+__DUMP_CRLF
1.3K Resize with Transparency
1.2K *- Re: File Conversion From HTML to PS and TIFF
2.1K `--*- Re: File Conversion From HTML to PS and TIFF
@@ -91,7 +137,7 @@ my $dump = <<'DUMP';
2.0K Core Dump on ReadImage
1.0K `- Re: Core Dump on ReadImage
1.6K Font metrics
-DUMP
+__DUMP_LF
$dump = join '', sort split /^/, $dump;
compare_thread_dumps($out, $dump, 'sort thread full dump');
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::41mh::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Box::MH; mh folders"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::42maildir::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use Tools qw/$windows/;
@@ -6,7 +6,14 @@ use strict;
use lib qw(. .. tests);
use Tools;
-use Test::More tests => 14;
+use Test::More;
+BEGIN
+{ if($windows)
+ { plan skip_all => "not available on MicroSoft Windows.";
+ exit 0;
+ }
+ plan tests => 14;
+}
BEGIN { use_ok('Mail::Transport::POP3') }
@@ -6,7 +6,14 @@ use warnings;
use lib qw(. .. tests);
use Tools;
-use Test::More tests => 7;
+use Test::More;
+BEGIN
+{ if($windows)
+ { plan skip_all => "not available on MicroSoft Windows.";
+ exit 0;
+ }
+ plan tests => 7;
+}
BEGIN { use_ok('Mail::Transport::POP3') }
@@ -6,7 +6,14 @@ use warnings;
use lib qw(. .. tests);
use Tools;
-use Test::More tests => 7;
+use Test::More;
+BEGIN
+{ if($windows)
+ { plan skip_all => "not available on MicroSoft Windows.";
+ exit 0;
+ }
+ plan tests => 7;
+}
BEGIN { use_ok('Mail::Transport::POP3') }
@@ -6,7 +6,14 @@ use warnings;
use lib qw(. .. tests);
use Tools;
-use Test::More tests => 7;
+use Test::More;
+BEGIN
+{ if($windows)
+ { plan skip_all => "not available on MicroSoft Windows.";
+ exit 0;
+ }
+ plan tests => 7;
+}
BEGIN { use_ok('Mail::Transport::POP3') }
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::43pop3::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Box::POP3; pop3 folders"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::44imap::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Box::IMAP; imap folders"}
@@ -17,7 +17,7 @@ BEGIN
{
eval { require Mail::Box::Dbx };
- if($@ || ! Mail::Box::Dbx->type eq 'dbx')
+ if($@ || Mail::Box::Dbx->type ne 'dbx')
{ plan(skip_all => 'Mail::Box::Dbx is not installed');
exit 0;
}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::45dbx::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Box::Dbx; Outlook Express folders"}
@@ -13,7 +13,7 @@ use Test::More tests => 58;
use Mail::Box::Mbox;
-my @src = (folder => "=$fn", folderdir => 'folders');
+my @src = (folder => "=$fn", folderdir => $folderdir);
#
# Destruct folder messages
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::50message::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Message::Construct; message construction"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::51folder::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Box; general folder handling"}
@@ -40,7 +40,7 @@ ok(!defined $second, 'open same folder fails');
my @errors = $manager->report('ERRORS');
cmp_ok(@errors, "==", 1, 'mgr noticed double');
-$errors[-1] =~ s#\\mbox\.win#/mbox.src#g; # Windows
+$errors[-1] =~ s#[\\/]mbox\.win#/mbox.src#g; # Windows
is($errors[-1], "Folder folders/mbox.src is already open.");
cmp_ok($manager->openFolders, "==", 1, 'only one folder open');
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::52manager::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Box::Manager; library manager"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::53threads::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Box::Threads; message threads"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::54search::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Box::Search; searching folders"}
@@ -19,6 +19,11 @@ my $fakefolder = bless {MB_foldername=> 'this'}, 'Mail::Box';
my $lockfile = File::Spec->catfile('folders', 'lockfiletest');
unlink $lockfile;
+if($windows)
+{ open my $OUT, '>', $lockfile or die;
+ close $OUT;
+}
+
my $locker = Mail::Box::Locker->new
( method => 'MULTI'
, timeout => 1
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::55locking::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Box::Locker; folder locking"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::60imap::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Server::IMAP; imap server"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::80msgconv::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Message::Convert; message conversions"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
package MailBox::Test::81bodyconv::Definition;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
sub name {"Mail::Message::Convert; body type conversions"}
@@ -1,11 +1,11 @@
-# Copyrights 2001-2013 by [Mark Overmeer].
+# Copyrights 2001-2015 by [Mark Overmeer].
# For other contributors see ChangeLog.
# See the manual pages for details on the licensing terms.
# Pod stripped from pm file by OODoc 2.01.
use strict;
package Tools;
use vars '$VERSION';
-$VERSION = '2.109';
+$VERSION = '2.118';
use lib qw(lib ../lib);
@@ -53,12 +53,16 @@ BEGIN {
$winfn = 'mbox.win';
$cpyfn = 'mbox.cpy';
- $unixsrc = File::Spec->catfile('folders', $unixfn);
- $winsrc = File::Spec->catfile('folders', $winfn);
- $cpy = File::Spec->catfile('folders', $cpyfn);
+ $unixsrc = File::Spec->catfile($folderdir, $unixfn);
+ $winsrc = File::Spec->catfile($folderdir, $winfn);
+ $cpy = File::Spec->catfile($folderdir, $cpyfn);
($src, $fn) = $crlf_platform ? ($winsrc, $winfn) : ($unixsrc, $unixfn);
+ # ensure to test the Perl Parser not the C-Parser (separate distribution)
+ require Mail::Box::Parser::Perl;
+ Mail::Box::Parser->defaultParserType( 'Mail::Box::Parser::Perl' );
+
# IO::File::open() is wrapped, because starting with 1.11 (Perl 5.8.7)
# it cannot open files with relative pathnames when tainting checks are
# enabled. I want to test relative folder names!!