man Mail::Box::Net () - handle folders which are stored remote.
NAME
Mail::Box::Net - handle folders which are stored remote.
INHERITANCE
Mail::Box::Net is a Mail::Box is a Mail::Reporter
Mail::Box::Net is extended by Mail::Box::IMAP4 Mail::Box::POP3
SYNOPSIS
# Do not instantiate this object directly
DESCRIPTION
At the moment, this object is extended by
- * Mail::Box::POP3
- Implements the POP3 protocol.
- * Mail::Box::IMAP4
- Implements the IMAP4 protocol. UNDER DEVELOPMENT
OVERLOADED
overload: "" See OVERLOADED in Mail::Box
overload: @{} See OVERLOADED in Mail::Box
overload: cmp See OVERLOADED in Mail::Box
METHODS
Constructors
Mail::Box::Net->new(OPTIONS)
Option Defined in Default access L<Mail::Box> C<'r'> body_delayed_type L<Mail::Box> L<Mail::Message::Body::Delayed|Mail::Message::Body::Delayed> body_type L<Mail::Box> L<Mail::Message::Body::Lines|Mail::Message::Body::Lines> coerce_options L<Mail::Box> C<[]> create L<Mail::Box> <false> extract L<Mail::Box> C<10240> field_type L<Mail::Box> undef fix_headers L<Mail::Box> <false> folder L<Mail::Box> C<'/'> folderdir L<Mail::Box> <not used> head_delayed_type L<Mail::Box> L<Mail::Message::Head::Delayed|Mail::Message::Head::Delayed> head_type L<Mail::Box> L<Mail::Message::Head::Complete|Mail::Message::Head::Complete> keep_dups L<Mail::Box> <false> lock_file L<Mail::Box> undef lock_timeout L<Mail::Box> 1 hour lock_type L<Mail::Box> C<'NONE'> lock_wait L<Mail::Box> 10 seconds locker L<Mail::Box> undef log L<Mail::Reporter> C<'WARNINGS'> manager L<Mail::Box> undef message_type L<Mail::Box> L<Mail::Box::Message|Mail::Box::Message> multipart_type L<Mail::Box> L<Mail::Message::Body::Multipart|Mail::Message::Body::Multipart> password undef remove_when_empty L<Mail::Box> <false> save_on_exit L<Mail::Box> <true> server_name undef server_port undef trace L<Mail::Reporter> C<'WARNINGS'> trusted L<Mail::Box> <false> username undef. access MODE . body_delayed_type CLASS . body_type CLASS|CODE . coerce_options ARRAY . create BOOLEAN . extract INTEGER | CODE | METHOD | 'LAZY'|'ALWAYS' . field_type CLASS . fix_headers BOOLEAN . folder FOLDERNAME . folderdir DIRECTORY . head_delayed_type CLASS . head_type CLASS . keep_dups BOOLEAN . lock_file FILENAME . lock_timeout SECONDS . lock_type CLASS|STRING|ARRAY . lock_wait SECONDS . locker OBJECT . log LEVEL . manager MANAGER . message_type CLASS . multipart_type CLASS . password STRING The password which is required to contact the remote server. . remove_when_empty BOOLEAN . save_on_exit BOOLEAN . server_name HOSTNAME The name of the host which contains the remote mail server. . server_port INTEGER Port number in use by the server application. . trace LEVEL . trusted BOOLEAN . username STRING The username which is to be used for the remote server.
The folder
$obj->addMessage(MESSAGE, OPTIONS) See The folder in Mail::Box
$obj->addMessages(MESSAGE [, MESSAGE, ...]) See The folder in Mail::Box
Mail::Box::Net->appendMessages(OPTIONS) See The folder in Mail::Box
$obj->close(OPTIONS) See The folder in Mail::Box
$obj->copyTo(FOLDER, OPTIONS) See The folder in Mail::Box
$obj->delete(OPTIONS) See The folder in Mail::Box
$obj->folderdir([DIRECTORY]) Not applicatable for folders on a remote server, so will always return the CWundef.
$obj->name See The folder in Mail::Box
$obj->organization See The folder in Mail::Box
$obj->size See The folder in Mail::Box
$obj->type See The folder in Mail::Box
$obj->update(OPTIONS) See The folder in Mail::Box
$obj->url See The folder in Mail::Box
Folder flags
$obj->access See Folder flags in Mail::Box
$obj->isModified See Folder flags in Mail::Box
$obj->modified([BOOLEAN]) See Folder flags in Mail::Box
$obj->writable See Folder flags in Mail::Box
The messages
$obj->current([NUMBER|MESSAGE|MESSAGE-ID]) See The messages in Mail::Box
$obj->find(MESSAGE-ID) See The messages in Mail::Box
$obj->findFirstLabeled(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]]) See The messages in Mail::Box
$obj->message(INDEX [,MESSAGE]) See The messages in Mail::Box
$obj->messageId(MESSAGE-ID [,MESSAGE]) See The messages in Mail::Box
$obj->messageIds See The messages in Mail::Box
$obj->messages(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER]) See The messages in Mail::Box
$obj->nrMessages(OPTIONS) See The messages in Mail::Box
$obj->scanForMessages(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW) See The messages in Mail::Box
Sub-folders
$obj->listSubFolders(OPTIONS)
Mail::Box::Net->listSubFolders(OPTIONS) See Sub-folders in Mail::Box
$obj->nameOfSubFolder(SUBNAME, [PARENTNAME])
Mail::Box::Net->nameOfSubFolder(SUBNAME, [PARENTNAME]) See Sub-folders in Mail::Box
$obj->openRelatedFolder(OPTIONS) See Sub-folders in Mail::Box
$obj->openSubFolder(SUBNAME, OPTIONS) See Sub-folders in Mail::Box
$obj->topFolderWithMessages
Mail::Box::Net->topFolderWithMessages See Sub-folders in Mail::Box
Internals
$obj->coerce(MESSAGE, OPTIONS) See Internals in Mail::Box
$obj->create(FOLDER, OPTIONS)
Mail::Box::Net->create(FOLDER, OPTIONS) Create a new folder on the remote server.
Option Defined in Default folderdir L<Mail::Box> <not used>. folderdir DIRECTORY
$obj->determineBodyType(MESSAGE, HEAD) See Internals in Mail::Box
Mail::Box::Net->foundIn([FOLDERNAME], OPTIONS) See Internals in Mail::Box
$obj->lineSeparator([STRING|'CR'|'LF'|'CRLF']) See Internals in Mail::Box
$obj->locker See Internals in Mail::Box
$obj->read(OPTIONS) See Internals in Mail::Box
$obj->readMessages(OPTIONS) See Internals in Mail::Box
$obj->storeMessage(MESSAGE) See Internals in Mail::Box
$obj->toBeThreaded(MESSAGES) See Internals in Mail::Box
$obj->toBeUnthreaded(MESSAGES) See Internals in Mail::Box
$obj->updateMessages(OPTIONS) See Internals in Mail::Box
$obj->write(OPTIONS) See Internals in Mail::Box
$obj->writeMessages(OPTIONS) See Internals in Mail::Box
Other methods
$obj->timespan2seconds(TIME)
Mail::Box::Net->timespan2seconds(TIME) See Other methods in Mail::Box
Error handling
$obj->AUTOLOAD See Error handling in Mail::Reporter
$obj->addReport(OBJECT) See Error handling in Mail::Reporter
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Net->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj->errors See Error handling in Mail::Reporter
$obj->log([LEVEL [,STRINGS]])
Mail::Box::Net->log([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj->logPriority(LEVEL)
Mail::Box::Net->logPriority(LEVEL) See Error handling in Mail::Reporter
$obj->logSettings See Error handling in Mail::Reporter
$obj->notImplemented See Error handling in Mail::Reporter
$obj->report([LEVEL]) See Error handling in Mail::Reporter
$obj->reportAll([LEVEL]) See Error handling in Mail::Reporter
$obj->trace([LEVEL]) See Error handling in Mail::Reporter
$obj->warnings See Error handling in Mail::Reporter
Cleanup
$obj->DESTROY See Cleanup in Mail::Box
$obj->inGlobalDestruction See Cleanup in Mail::Reporter
DIAGNOSTICS
Warning: Changes not written to read-only folder CW$self.
You have opened the folder read-only --which is the default set by new(access)--, made modifications, and now want to close it. Set close(force) if you want to overrule the access mode, or close the folder with close(write) set to CWNEVER.
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.
Error: Destination folder CW$name is not writable.
The folder where the messages are copied to is not opened with write access (see new(access)). This has no relation with write permission to the folder which is controled by your operating system.
Warning: Different messages with id CW$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.
Error: Folder CW$name is opened read-only
You can not write to this folder unless you have opened the folder to write or append with new(access), or the CWforce option is set true.
Error: Folder CW$name not deleted: not writable.
The folder must be opened with write access via new(access), 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 CWdelete method permits you to. The reverse remark is valid as well.
Error: Invalid timespan '$timespan' specified.
The string does not follow the strict rules of the time span syntax which is permitted as parameter.
Warning: Message-id '$msgid' does not contain a domain.
According to the RFCs, message-ids need to contain a unique random part, then an CW@, and then a domain name. This is made to avoid the creation of two messages with the same id. The warning emerges when the CW@ is missing from the string.
Error: Package CW$package does not implement CW$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.
Error: Unable to create subfolder CW$name of CW$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.
Error: Writing folder CW$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.
DETAILS
REFERENCES
See the MailBox website at <http://perl.overmeer.net/mailbox/> for more details.
COPYRIGHTS
Distribution version 2.063. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.