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::Reporter
SYNOPSIS¶
use Mail::Box::POP3s;
my $folder = new Mail::Box::POP3s folder => $ENV{MAIL}, ...;
DESCRIPTION¶
This module mainly extends Mail::Box::POP3.
OVERLOADED¶
- overload: ""()
- See "OVERLOADED" in Mail::Box
- overload: @{}()
- See "OVERLOADED" in Mail::Box
- overload: cmp()
- See "OVERLOADED" in Mail::Box
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)
- See "METHODS" in Mail::Box::POP3
- $obj->addMessages(MESSAGES)
- See "METHODS" in Mail::Box::POP3
- Mail::Box::POP3s->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 "METHODS" in Mail::Box::POP3
- $obj->folderdir([DIRECTORY])
- See "METHODS" in Mail::Box::Net
- $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()
- See "METHODS" in Mail::Box::POP3
- $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::POP3s->listSubFolders(OPTIONS)
- See "METHODS" in Mail::Box::POP3
- $obj->nameOfSubFolder(SUBNAME, [PARENTNAME])
- Mail::Box::POP3s->nameOfSubFolder(SUBNAME,
[PARENTNAME])
- See "Sub-folders" in Mail::Box
- $obj->openRelatedFolder(OPTIONS)
- See "Sub-folders" in Mail::Box
- $obj->openSubFolder(OPTIONS)
- See "METHODS" in Mail::Box::POP3
- $obj->topFolderWithMessages()
- Mail::Box::POP3s->topFolderWithMessages()
- See "Sub-folders" in Mail::Box
Internals¶
- $obj->coerce(MESSAGE, OPTIONS)
- See "Internals" in Mail::Box
- $obj->create(FOLDER, OPTIONS)
- Mail::Box::POP3s->create(FOLDER, OPTIONS)
- See "METHODS" in Mail::Box::POP3
- $obj->determineBodyType(MESSAGE, HEAD)
- See "Internals" in Mail::Box
- Mail::Box::POP3s->foundIn([FOLDERNAME],
OPTIONS)
- See "Internals" in Mail::Box
- $obj->getHead(MESSAGE)
- See "Internals" in Mail::Box::POP3
- $obj->getHeadAndBody(MESSAGE)
- See "Internals" in Mail::Box::POP3
- $obj->lineSeparator([STRING|'CR'|'LF'|'CRLF'])
- See "Internals" in Mail::Box
- $obj->locker()
- See "Internals" in Mail::Box
- $obj->popClient(OPTIONS)
- See "Internals" in Mail::Box::POP3
- $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::POP3
Other methods¶
- $obj->timespan2seconds(TIME)
- Mail::Box::POP3s->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::POP3s->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::POP3s->log([LEVEL [,STRINGS]])
- See "Error handling" in Mail::Reporter
- $obj->logPriority(LEVEL)
- Mail::Box::POP3s->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¶
- 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 "force"
option 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.105, built on May 07,
2012. Website:
http://perl.overmeer.net/mailbox/
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
http://www.perl.com/perl/misc/Artistic.html