Provided by: libmail-box-pop3-perl_3.003-1_all 
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 = Mail::Box::POP3s->new(folder => $ENV{MAIL}, ...);
DESCRIPTION
This module mainly extends Mail::Box::POP3.
Extends "DESCRIPTION" in Mail::Box::POP3.
OVERLOADED
Extends "OVERLOADED" in Mail::Box::POP3.
overload: ""
Inherited, see "OVERLOADED" in Mail::Box
overload: @{}
Inherited, see "OVERLOADED" in Mail::Box
overload: cmp
Inherited, see "OVERLOADED" in Mail::Box
METHODS
Extends "METHODS" in Mail::Box::POP3.
Constructors
Extends "Constructors" in Mail::Box::POP3.
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 <network location>
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
Extends "The folder" in Mail::Box::POP3.
$obj->addMessage($message)
Inherited, see "METHODS" in Mail::Box::POP3
$obj->addMessages($messages)
Inherited, see "METHODS" in Mail::Box::POP3
Mail::Box::POP3s->appendMessages(%options)
Inherited, see "The folder" in Mail::Box
$obj->close(%options)
Inherited, see "The folder" in Mail::Box
$obj->copyTo($folder, %options)
Inherited, see "The folder" in Mail::Box
$obj->delete(%options)
Inherited, see "METHODS" in Mail::Box::POP3
$obj->folderdir( [$directory] )
Inherited, see "The folder" in Mail::Box
$obj->name()
Inherited, see "The folder" in Mail::Box
$obj->organization()
Inherited, see "The folder" in Mail::Box
$obj->size()
Inherited, see "The folder" in Mail::Box
$obj->type()
Inherited, see "The folder" in Mail::Box
$obj->update()
Inherited, see "METHODS" in Mail::Box::POP3
$obj->url()
Inherited, see "The folder" in Mail::Box
Folder flags
Extends "Folder flags" in Mail::Box::POP3.
$obj->access()
Inherited, see "Folder flags" in Mail::Box
$obj->isModified()
Inherited, see "Folder flags" in Mail::Box
$obj->modified( [BOOLEAN] )
Inherited, see "Folder flags" in Mail::Box
$obj->writable()
Inherited, see "Folder flags" in Mail::Box
The messages
Extends "The messages" in Mail::Box::POP3.
$obj->current( [$number|$message|$message_id] )
Inherited, see "The messages" in Mail::Box
$obj->find($message_id)
Inherited, see "The messages" in Mail::Box
$obj->findFirstLabeled( $label, [BOOLEAN, [$msgs]] )
Inherited, see "The messages" in Mail::Box
$obj->message( $index, [$message] )
Inherited, see "The messages" in Mail::Box
$obj->messageId( $message_id, [$message] )
Inherited, see "The messages" in Mail::Box
$obj->messageIds()
Inherited, see "The messages" in Mail::Box
$obj->messages( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
Inherited, see "The messages" in Mail::Box
$obj->nrMessages(%options)
Inherited, see "The messages" in Mail::Box
$obj->scanForMessages($message, $message_ids, $timespan, $window)
Inherited, see "The messages" in Mail::Box
Sub-folders
Extends "Sub-folders" in Mail::Box::POP3.
$obj->listSubFolders(%options)
Mail::Box::POP3s->listSubFolders(%options)
Inherited, see "METHODS" in Mail::Box::POP3
$obj->nameOfSubFolder( $subname, [$parentname] )
Mail::Box::POP3s->nameOfSubFolder( $subname, [$parentname] )
Inherited, see "Sub-folders" in Mail::Box
$obj->openRelatedFolder(%options)
Inherited, see "Sub-folders" in Mail::Box
$obj->openSubFolder(%options)
Inherited, see "METHODS" in Mail::Box::POP3
$obj->topFolderWithMessages()
Mail::Box::POP3s->topFolderWithMessages()
Inherited, see "Sub-folders" in Mail::Box
Internals
Extends "Internals" in Mail::Box::POP3.
$obj->coerce($message, %options)
Inherited, see "Internals" in Mail::Box
$obj->create($folder, %options)
Mail::Box::POP3s->create($folder, %options)
Inherited, see "METHODS" in Mail::Box::POP3
$obj->determineBodyType($message, $head)
Inherited, see "Internals" in Mail::Box
Mail::Box::POP3s->foundIn( [$foldername], %options )
Inherited, see "Internals" in Mail::Box
$obj->getHead($message)
Inherited, see "Internals" in Mail::Box::POP3
$obj->getHeadAndBody($message)
Inherited, see "Internals" in Mail::Box::POP3
$obj->lineSeparator( [<STRING|'CR'|'LF'|'CRLF'>] )
Inherited, see "Internals" in Mail::Box
$obj->locker()
Inherited, see "Internals" in Mail::Box
$obj->popClient(%options)
Inherited, see "Internals" in Mail::Box::POP3
$obj->read(%options)
Inherited, see "Internals" in Mail::Box
$obj->readMessages(%options)
Inherited, see "Internals" in Mail::Box
$obj->storeMessage($message)
Inherited, see "Internals" in Mail::Box
$obj->toBeThreaded($messages)
Inherited, see "Internals" in Mail::Box
$obj->toBeUnthreaded($messages)
Inherited, see "Internals" in Mail::Box
$obj->updateMessages(%options)
Inherited, see "Internals" in Mail::Box
$obj->write(%options)
Inherited, see "Internals" in Mail::Box
$obj->writeMessages(%options)
Inherited, see "Internals" in Mail::Box::POP3
Other methods
Extends "Other methods" in Mail::Box::POP3.
$obj->timespan2seconds($time)
Mail::Box::POP3s->timespan2seconds($time)
Inherited, see "Other methods" in Mail::Box
Error handling
Extends "Error handling" in Mail::Box::POP3.
$obj->AUTOLOAD()
Inherited, see "Error handling" in Mail::Reporter
$obj->addReport($object)
Inherited, see "Error handling" in Mail::Reporter
$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
Mail::Box::POP3s->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
Inherited, see "Error handling" in Mail::Reporter
$obj->errors()
Inherited, see "Error handling" in Mail::Reporter
$obj->log( [$level, [$strings]] )
Mail::Box::POP3s->log( [$level, [$strings]] )
Inherited, see "Error handling" in Mail::Reporter
$obj->logPriority($level)
Mail::Box::POP3s->logPriority($level)
Inherited, see "Error handling" in Mail::Reporter
$obj->logSettings()
Inherited, see "Error handling" in Mail::Reporter
$obj->notImplemented()
Inherited, see "Error handling" in Mail::Reporter
$obj->report( [$level] )
Inherited, see "Error handling" in Mail::Reporter
$obj->reportAll( [$level] )
Inherited, see "Error handling" in Mail::Reporter
$obj->trace( [$level] )
Inherited, see "Error handling" in Mail::Reporter
$obj->warnings()
Inherited, see "Error handling" in Mail::Reporter
Cleanup
Extends "Cleanup" in Mail::Box::POP3.
$obj->DESTROY()
Inherited, see "Cleanup" in Mail::Box
DETAILS
Extends "DETAILS" in Mail::Box::POP3.
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 retrieved 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
controlled 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-POP3 distribution version 3.003, built on July 16, 2017.
Do not forget to read Mail::Box-Overview, Mail::Box-Cookbook, and Mail::Box-Index.
Examples are included in the Mail-Box distribution, directories 'examples' and 'scripts'.
Browseable manuals, papers, and other released material van be found at Website:
http://perl.overmeer.net/mailbox/
The central modules (in separate distributions) in the MailBox suite are: Mail::Message,
Mail::Box, Mail::Box::IMAP4, Mail::Box::POP3, Mail::Box::Parser::C, Mail::Box::Dbx
(unpublished), Mail::Transport, Object::Realize::Later, and User::Identity.
Please post questions or ideas to the author markov@cpan.org.
LICENSE
Copyrights 2001-2017 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://dev.perl.org/licenses/