=head1 NAME
Mail::Box::Net - handle folders which are stored remote.
=head1 INHERITANCE
Mail::Box::Net
is a Mail::Box
is a Mail::Reporter
Mail::Box::Net is extended by
Mail::Box::IMAP4
Mail::Box::POP3
=head1 SYNOPSIS
# Do not instantiate this object directly
=head1 DESCRIPTION
At the moment, this object is extended by
=over 4
=item * L<Mail::Box::POP3|Mail::Box::POP3>
Implements the POP3 protocol.
=item * L<Mail::Box::IMAP4|Mail::Box::IMAP4>
Implements the IMAP4 protocol. B<UNDER DEVELOPMENT>
=back
=head1 OVERLOADED
=over 4
=item overload: B<"">()
See L<Mail::Box/"OVERLOADED">
=item overload: B<@{}>()
See L<Mail::Box/"OVERLOADED">
=item overload: B<cmp>()
See L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
=head2 Constructors
=over 4
=item Mail::Box::Net-E<gt>B<new>(OPTIONS)
-Option --Defined in --Default
access Mail::Box 'r'
body_delayed_type Mail::Box Mail::Message::Body::Delayed
body_type Mail::Box Mail::Message::Body::Lines
coerce_options Mail::Box []
create Mail::Box <false>
extract Mail::Box 10240
field_type Mail::Box undef
fix_headers Mail::Box <false>
folder Mail::Box '/'
folderdir Mail::Box <not used>
head_delayed_type Mail::Box Mail::Message::Head::Delayed
head_type Mail::Box Mail::Message::Head::Complete
keep_dups Mail::Box <false>
lock_file Mail::Box undef
lock_timeout Mail::Box 1 hour
lock_type Mail::Box 'NONE'
lock_wait Mail::Box 10 seconds
locker Mail::Box undef
log Mail::Reporter 'WARNINGS'
manager Mail::Box undef
message_type Mail::Box Mail::Box::Message
multipart_type Mail::Box Mail::Message::Body::Multipart
password undef
remove_when_empty Mail::Box <false>
save_on_exit Mail::Box <true>
server_name undef
server_port undef
trace Mail::Reporter 'WARNINGS'
trusted Mail::Box <false>
username undef
=over 2
=item access => MODE
=item body_delayed_type => CLASS
=item body_type => CLASS|CODE
=item coerce_options => ARRAY
=item create => BOOLEAN
=item extract => INTEGER | CODE | METHOD | 'LAZY'|'ALWAYS'
=item field_type => CLASS
=item fix_headers => BOOLEAN
=item folder => FOLDERNAME
=item folderdir => DIRECTORY
=item head_delayed_type => CLASS
=item head_type => CLASS
=item keep_dups => BOOLEAN
=item lock_file => FILENAME
=item lock_timeout => SECONDS
=item lock_type => CLASS|STRING|ARRAY
=item lock_wait => SECONDS
=item locker => OBJECT
=item log => LEVEL
=item manager => MANAGER
=item message_type => CLASS
=item multipart_type => CLASS
=item password => STRING
The password which is required to contact the remote server.
=item remove_when_empty => BOOLEAN
=item save_on_exit => BOOLEAN
=item server_name => HOSTNAME
The name of the host which contains the remote mail server.
=item server_port => INTEGER
Port number in use by the server application.
=item trace => LEVEL
=item trusted => BOOLEAN
=item username => STRING
The username which is to be used for the remote server.
=back
=back
=head2 The folder
=over 4
=item $obj-E<gt>B<addMessage>(MESSAGE, OPTIONS)
See L<Mail::Box/"The folder">
=item $obj-E<gt>B<addMessages>(MESSAGE [, MESSAGE, ...])
See L<Mail::Box/"The folder">
=item Mail::Box::Net-E<gt>B<appendMessages>(OPTIONS)
See L<Mail::Box/"The folder">
=item $obj-E<gt>B<close>(OPTIONS)
See L<Mail::Box/"The folder">
=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
See L<Mail::Box/"The folder">
=item $obj-E<gt>B<delete>(OPTIONS)
See L<Mail::Box/"The folder">
=item $obj-E<gt>B<folderdir>([DIRECTORY])
Not applicatable for folders on a remote server, so will always return
the C<undef>.
=item $obj-E<gt>B<name>()
See L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
See L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
See L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
See L<Mail::Box/"The folder">
=item $obj-E<gt>B<update>(OPTIONS)
See L<Mail::Box/"The folder">
=item $obj-E<gt>B<url>()
See L<Mail::Box/"The folder">
=back
=head2 Folder flags
=over 4
=item $obj-E<gt>B<access>()
See L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
See L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<modified>([BOOLEAN])
See L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
See L<Mail::Box/"Folder flags">
=back
=head2 The messages
=over 4
=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])
See L<Mail::Box/"The messages">
=item $obj-E<gt>B<find>(MESSAGE-ID)
See L<Mail::Box/"The messages">
=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
See L<Mail::Box/"The messages">
=item $obj-E<gt>B<message>(INDEX [,MESSAGE])
See L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])
See L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
See L<Mail::Box/"The messages">
=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
See L<Mail::Box/"The messages">
=item $obj-E<gt>B<nrMessages>(OPTIONS)
See L<Mail::Box/"The messages">
=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
See L<Mail::Box/"The messages">
=back
=head2 Sub-folders
=over 4
=item $obj-E<gt>B<listSubFolders>(OPTIONS)
=item Mail::Box::Net-E<gt>B<listSubFolders>(OPTIONS)
See L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
=item Mail::Box::Net-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])
See L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)
See L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<openSubFolder>(SUBNAME, OPTIONS)
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">
=back
=head2 Internals
=over 4
=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)
See L<Mail::Box/"Internals">
=item $obj-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>
=over 2
=item folderdir => DIRECTORY
=back
=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)
See L<Mail::Box/"Internals">
=item Mail::Box::Net-E<gt>B<foundIn>([FOLDERNAME], OPTIONS)
See L<Mail::Box/"Internals">
=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])
See L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
See L<Mail::Box/"Internals">
=item $obj-E<gt>B<read>(OPTIONS)
See L<Mail::Box/"Internals">
=item $obj-E<gt>B<readMessages>(OPTIONS)
See L<Mail::Box/"Internals">
=item $obj-E<gt>B<storeMessage>(MESSAGE)
See L<Mail::Box/"Internals">
=item $obj-E<gt>B<toBeThreaded>(MESSAGES)
See L<Mail::Box/"Internals">
=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)
See L<Mail::Box/"Internals">
=item $obj-E<gt>B<updateMessages>(OPTIONS)
See L<Mail::Box/"Internals">
=item $obj-E<gt>B<write>(OPTIONS)
See L<Mail::Box/"Internals">
=item $obj-E<gt>B<writeMessages>(OPTIONS)
See L<Mail::Box/"Internals">
=back
=head2 Other methods
=over 4
=item $obj-E<gt>B<timespan2seconds>(TIME)
=item Mail::Box::Net-E<gt>B<timespan2seconds>(TIME)
See L<Mail::Box/"Other methods">
=back
=head2 Error handling
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<addReport>(OBJECT)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=item Mail::Box::Net-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
=item Mail::Box::Net-E<gt>B<log>([LEVEL [,STRINGS]])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>(LEVEL)
=item Mail::Box::Net-E<gt>B<logPriority>(LEVEL)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<report>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<reportAll>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<trace>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
See L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
=over 4
=item $obj-E<gt>B<DESTROY>()
See L<Mail::Box/"Cleanup">
=item $obj-E<gt>B<inGlobalDestruction>()
See L<Mail::Reporter/"Cleanup">
=back
=head1 DIAGNOSTICS
=over 4
=item Warning: Changes not written to read-only folder $self.
You have opened the folder read-only --which is the default set
by L<new(access)|Mail::Box/"Constructors">--, made modifications, and now want to close it.
Set L<close(force)|Mail::Box/"The folder"> if you want to overrule the access mode, or close
the folder with L<close(write)|Mail::Box/"The folder"> set to C<NEVER>.
=item Error: Copying failed for one message.
For some reason, for instance disc full, removed by external process, or
read-protection, it is impossible to copy one of the messages. Copying will
proceed for the other messages.
=item Error: Destination folder $name is not writable.
The folder where the messages are copied to is not opened with write
access (see L<new(access)|Mail::Box/"Constructors">). This has no relation with write permission
to the folder which is controled by your operating system.
=item Warning: Different messages with id $msgid
The message id is discovered more than once within the same folder, but the
content of the message seems to be different. This should not be possible:
each message must be unique.
=item Error: Folder $name is opened read-only
You can not write to this folder unless you have opened the folder to
write or append with L<new(access)|Mail::Box/"Constructors">, or the C<force> option is set true.
=item Error: Folder $name not deleted: not writable.
The folder must be opened with write access via L<new(access)|Mail::Box/"Constructors">, otherwise
removing it will be refused. So, you may have write-access according to
the operating system, but that will not automatically mean that this
C<delete> method permits you to. The reverse remark is valid as well.
=item Error: Invalid timespan '$timespan' specified.
The string does not follow the strict rules of the time span syntax which
is permitted as parameter.
=item Warning: Message-id '$msgid' does not contain a domain.
According to the RFCs, message-ids need to contain a unique random part,
then an C<@>, and then a domain name. This is made to avoid the creation
of two messages with the same id. The warning emerges when the C<@> is
missing from the string.
=item Error: Package $package does not implement $method.
Fatal error: the specific package (or one of its superclasses) does not
implement this method where it should. This message means that some other
related classes do implement this method however the class at hand does
not. Probably you should investigate this and probably inform the author
of the package.
=item Error: Unable to create subfolder $name of $folder.
The copy includes the subfolders, but for some reason it was not possible
to copy one of these. Copying will proceed for all other sub-folders.
=item Error: Writing folder $name failed
For some reason (you probably got more error messages about this problem)
it is impossible to write the folder, although you should because there
were changes made.
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.103,
built on April 20, 2012. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
Copyrights 2001-2012 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>