NAME
Mail::Box::POP3s - handle secure POP3 folders as client
INHERITANCE
Mail::Box::POP3s
is a Mail::Box::POP3
is a Mail::Box::Net
is a Mail::Box
is a Mail::ReporterSYNOPSIS
use Mail::Box::POP3s;
my $folder = new Mail::Box::POP3s folder => $ENV{MAIL}, ...;DESCRIPTION
This module mainly extends Mail::Box::POP3.
OVERLOADED
METHODS
Constructors
- Mail::Box::POP3s->new(OPTIONS)
-
-Option --Defined in --Default access Mail::Box 'r' authenticate Mail::Box::POP3 'AUTO' body_delayed_type Mail::Box Mail::Message::Body::Delayed body_type Mail::Box Mail::Message::Body::Lines coerce_options Mail::Box [] create Mail::Box <not applicable> extract Mail::Box 10240 field_type Mail::Box undef fix_headers Mail::Box <false> folder Mail::Box <not applicable> 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::POP3::Message multipart_type Mail::Box Mail::Message::Body::Multipart password Mail::Box::Net undef pop_client Mail::Box::POP3 undef remove_when_empty Mail::Box <false> save_on_exit Mail::Box <true> server_name Mail::Box::Net undef server_port Mail::Box::Net 995 trace Mail::Reporter 'WARNINGS' trusted Mail::Box <false> username Mail::Box::Net undef- access => MODE
- authenticate => 'LOGIN'|'APOP'|'AUTO'
- 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
- pop_client => OBJECT
- remove_when_empty => BOOLEAN
- save_on_exit => BOOLEAN
- server_name => HOSTNAME
- server_port => INTEGER
- trace => LEVEL
- trusted => BOOLEAN
- username => STRING
The folder
- $obj->addMessage(MESSAGE)
- $obj->addMessages(MESSAGES)
- Mail::Box::POP3s->appendMessages(OPTIONS)
- $obj->close(OPTIONS)
- $obj->copyTo(FOLDER, OPTIONS)
- $obj->delete(OPTIONS)
- $obj->folderdir([DIRECTORY])
- $obj->name
- $obj->organization
- $obj->size
- $obj->type
- $obj->update
- $obj->url
Folder flags
The messages
- $obj->current([NUMBER|MESSAGE|MESSAGE-ID])
- $obj->find(MESSAGE-ID)
- $obj->findFirstLabeled(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])
- $obj->message(INDEX [,MESSAGE])
- $obj->messageId(MESSAGE-ID [,MESSAGE])
- $obj->messageIds
- $obj->messages(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])
- $obj->nrMessages(OPTIONS)
- $obj->scanForMessages(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)
Sub-folders
- $obj->listSubFolders(OPTIONS)
-
Mail::Box::POP3s->listSubFolders(OPTIONS)
- $obj->nameOfSubFolder(SUBNAME, [PARENTNAME])
-
Mail::Box::POP3s->nameOfSubFolder(SUBNAME, [PARENTNAME])
- $obj->openRelatedFolder(OPTIONS)
- $obj->openSubFolder(OPTIONS)
- $obj->topFolderWithMessages
-
Mail::Box::POP3s->topFolderWithMessages
Internals
- $obj->coerce(MESSAGE, OPTIONS)
- $obj->create(FOLDER, OPTIONS)
-
Mail::Box::POP3s->create(FOLDER, OPTIONS)
- $obj->determineBodyType(MESSAGE, HEAD)
- Mail::Box::POP3s->foundIn([FOLDERNAME], OPTIONS)
- $obj->getHead(MESSAGE)
- $obj->getHeadAndBody(MESSAGE)
- $obj->lineSeparator([STRING|'CR'|'LF'|'CRLF'])
- $obj->locker
- $obj->popClient(OPTIONS)
- $obj->read(OPTIONS)
- $obj->readMessages(OPTIONS)
- $obj->storeMessage(MESSAGE)
- $obj->toBeThreaded(MESSAGES)
- $obj->toBeUnthreaded(MESSAGES)
- $obj->updateMessages(OPTIONS)
- $obj->write(OPTIONS)
- $obj->writeMessages(OPTIONS)
Other methods
Error handling
- $obj->AUTOLOAD
- $obj->addReport(OBJECT)
- $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
-
Mail::Box::POP3s->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
- $obj->errors
- $obj->log([LEVEL [,STRINGS]])
-
Mail::Box::POP3s->log([LEVEL [,STRINGS]])
- $obj->logPriority(LEVEL)
-
Mail::Box::POP3s->logPriority(LEVEL)
- $obj->logSettings
- $obj->notImplemented
- $obj->report([LEVEL])
- $obj->reportAll([LEVEL])
- $obj->trace([LEVEL])
- $obj->warnings
Cleanup
DIAGNOSTICS
- Error: Cannot create POP3 client for $name.
-
The connection to the POP3 server cannot be established. You may see more, related, error messages about the failure.
- Error: Cannot find head back for $uidl on POP3 server $name.
-
The server told to have this message, but when asked for its headers, no single line was returned. Did the message get destroyed?
- Error: Cannot read body for $uidl on POP3 server $name.
-
The message's headers are retreived from the server, but the body seems to be lost. Did the message get destroyed between reading the header and reading the body?
- 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. - 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
forceoption is set true. - 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 $uidl on POP3 server $name disappeared.
-
The server indicated the existence of this message before, however it has no information about the message anymore.
- 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. - Warning: POP3 folders cannot be deleted.
-
Each user has only one POP3 folder on a server. This folder is created and deleted by the server's administrator only.
- 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: Update of $nr messages ignored for POP3 folder $name.
-
The standard POP3 implementation does not support writing from client back to the server. Therefore, modifications may be lost.
- 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.
- Error: You cannot write a message to a pop server (yet)
-
Some extensions to the POP3 protocol do permit writing messages to the server, but the standard protocol only implements retreival. Feel invited to extend our implementation with writing.
SEE ALSO
This module is part of Mail-Box distribution version 2.097, built on January 26, 2011. Website: http://perl.overmeer.net/mailbox/
LICENSE
Copyrights 2001-2011 by Mark Overmeer. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html