Mail::Box::Net - handle folders which are stored remote.
Mail::Box::Net is a Mail::Box is a Mail::Reporter Mail::Box::Net is extended by Mail::Box::IMAP4 Mail::Box::POP3
# Do not instantiate this object directly
At the moment, this object is extended by
Mail::Box::POP3
Implements the POP3 protocol.
Mail::Box::IMAP4
Implements the IMAP4 protocol. UNDER DEVELOPMENT
overload: ""
See "OVERLOADED" in Mail::Box
overload: @{}
overload: cmp
$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
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
. head_delayed_type CLASS
. head_type CLASS
. keep_dups BOOLEAN
. lock_file FILENAME
. lock_timeout SECONDS
. lock_type CLASS|STRING
. 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.
$obj->addMessage(MESSAGE)
See "The folder" in Mail::Box
$obj->addMessages(MESSAGE [, MESSAGE, ...])
Mail::Box::Net->appendMessages(OPTIONS)
$obj->close(OPTIONS)
$obj->copyTo(FOLDER, OPTIONS)
$obj->delete
$obj->folderdir([DIRECTORY])
Not applicatable for folders on a remote server, so will always return the undef.
undef
Mail::Box::Net->foundIn([FOLDERNAME], OPTIONS)
$obj->name
$obj->organization
$obj->type
$obj->update(OPTIONS)
$obj->url
$obj->isModified
See "Folder flags" in Mail::Box
$obj->modified([BOOLEAN])
$obj->writable
$obj->current([NUMBER|MESSAGE|MESSAGE-ID])
See "The messages" in Mail::Box
$obj->find(MESSAGE-ID)
$obj->message(INDEX [,MESSAGE])
$obj->messageId(MESSAGE-ID [,MESSAGE])
$obj->messageIds
$obj->messages(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
$obj->scanForMessages(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
$obj->listSubFolders(OPTIONS)
Mail::Box::Net->listSubFolders(OPTIONS)
See "Sub-folders" in Mail::Box
$obj->nameOfSubFolder(NAME)
$obj->openRelatedFolder(OPTIONS)
$obj->openSubFolder(NAME, OPTIONS)
$obj->coerce(MESSAGE)
See "Internals" in Mail::Box
$obj->determineBodyType(MESSAGE, HEAD)
$obj->lineSeparator([STRING|'CR'|'LF'|'CRLF'])
$obj->locker
$obj->read(OPTIONS)
$obj->readMessages(OPTIONS)
$obj->storeMessage(MESSAGE)
$obj->toBeThreaded(MESSAGES)
$obj->toBeUnthreaded(MESSAGES)
$obj->updateMessages(OPTIONS)
$obj->write(OPTIONS)
$obj->writeMessages(OPTIONS)
$obj->timespan2seconds(TIME)
Mail::Box::Net->timespan2seconds(TIME)
See "Other methods" in Mail::Box
$obj->AUTOLOAD
See "Error handling" in Mail::Reporter
$obj->defaultTrace([LEVEL, [LEVEL])
Mail::Box::Net->defaultTrace([LEVEL, [LEVEL])
$obj->errors
$obj->log([LEVEL [,STRINGS]])
Mail::Box::Net->log([LEVEL [,STRINGS]])
$obj->logPriority(LEVEL)
Mail::Box::Net->logPriority(LEVEL)
$obj->logSettings
$obj->notImplemented
$obj->report([LEVEL])
$obj->reportAll([LEVEL])
$obj->trace([LEVEL])
$obj->warnings
$obj->DESTROY
See "Cleanup" in Mail::Box
$obj->inGlobalDestruction
See "Cleanup" in Mail::Reporter
Warning: Changes not written to read-only folder $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 NEVER.
NEVER
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 $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 $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 $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 force option is set true.
force
Error: Folder $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 delete method permits you to. The reverse remark is valid as well.
delete
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 @, and then a domain name. This is made to avoid the creation of two messages with the same id. The warning emerges when the @ is missing from the string.
@
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.
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.
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.
See the Mail::Box website at http://perl.overmeer.net/mailbox/ for more details.
Module version 2.042. 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.
To install Mail::Box, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Box
CPAN shell
perl -MCPAN -e shell install Mail::Box
For more information on module installation, please visit the detailed CPAN module installation guide.