libmail-box-perl 2.099-1 / usr / share / perl5 / Mail / Box / POP3s.pod

=head1 NAME

Mail::Box::POP3s - handle secure POP3 folders as client

=head1 INHERITANCE

 Mail::Box::POP3s
   is a Mail::Box::POP3
   is a Mail::Box::Net
   is a Mail::Box
   is a Mail::Reporter

=head1 SYNOPSIS

 use Mail::Box::POP3s;
 my $folder = new Mail::Box::POP3s folder => $ENV{MAIL}, ...;

=head1 DESCRIPTION

This module mainly extends L<Mail::Box::POP3|Mail::Box::POP3>.

=head1 OVERLOADED

=over 4

=item overload: B<"">

See L<Mail::Box/"OVERLOADED">

=item overload: B<@{}>

See L<Mail::Box/"OVERLOADED">

=item overload: B<cmp>

See L<Mail::Box/"OVERLOADED">

=back

=head1 METHODS

=head2 Constructors

=over 4

=item Mail::Box::POP3s-E<gt>B<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

=over 2

=item access => MODE

=item authenticate => 'LOGIN'|'APOP'|'AUTO'

=item body_delayed_type => CLASS

=item body_type => CLASS|CODE

=item coerce_options => ARRAY

=item create => BOOLEAN

=item extract => INTEGER | CODE | METHOD | 'LAZY'|'ALWAYS'

=item field_type => CLASS

=item fix_headers => BOOLEAN

=item folder => FOLDERNAME

=item folderdir => DIRECTORY

=item head_delayed_type => CLASS

=item head_type => CLASS

=item keep_dups => BOOLEAN

=item lock_file => FILENAME

=item lock_timeout => SECONDS

=item lock_type => CLASS|STRING|ARRAY

=item lock_wait => SECONDS

=item locker => OBJECT

=item log => LEVEL

=item manager => MANAGER

=item message_type => CLASS

=item multipart_type => CLASS

=item password => STRING

=item pop_client => OBJECT

=item remove_when_empty => BOOLEAN

=item save_on_exit => BOOLEAN

=item server_name => HOSTNAME

=item server_port => INTEGER

=item trace => LEVEL

=item trusted => BOOLEAN

=item username => STRING

=back

=back

=head2 The folder

=over 4

=item $obj-E<gt>B<addMessage>(MESSAGE)

See L<Mail::Box::POP3/"METHODS">

=item $obj-E<gt>B<addMessages>(MESSAGES)

See L<Mail::Box::POP3/"METHODS">

=item Mail::Box::POP3s-E<gt>B<appendMessages>(OPTIONS)

See L<Mail::Box/"The folder">

=item $obj-E<gt>B<close>(OPTIONS)

See L<Mail::Box/"The folder">

=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)

See L<Mail::Box/"The folder">

=item $obj-E<gt>B<delete>(OPTIONS)

See L<Mail::Box::POP3/"METHODS">

=item $obj-E<gt>B<folderdir>([DIRECTORY])

See L<Mail::Box::Net/"METHODS">

=item $obj-E<gt>B<name>

See L<Mail::Box/"The folder">

=item $obj-E<gt>B<organization>

See L<Mail::Box/"The folder">

=item $obj-E<gt>B<size>

See L<Mail::Box/"The folder">

=item $obj-E<gt>B<type>

See L<Mail::Box/"The folder">

=item $obj-E<gt>B<update>

See L<Mail::Box::POP3/"METHODS">

=item $obj-E<gt>B<url>

See L<Mail::Box/"The folder">

=back

=head2 Folder flags

=over 4

=item $obj-E<gt>B<access>

See L<Mail::Box/"Folder flags">

=item $obj-E<gt>B<isModified>

See L<Mail::Box/"Folder flags">

=item $obj-E<gt>B<modified>([BOOLEAN])

See L<Mail::Box/"Folder flags">

=item $obj-E<gt>B<writable>

See L<Mail::Box/"Folder flags">

=back

=head2 The messages

=over 4

=item $obj-E<gt>B<current>([NUMBER|MESSAGE|MESSAGE-ID])

See L<Mail::Box/"The messages">

=item $obj-E<gt>B<find>(MESSAGE-ID)

See L<Mail::Box/"The messages">

=item $obj-E<gt>B<findFirstLabeled>(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])

See L<Mail::Box/"The messages">

=item $obj-E<gt>B<message>(INDEX [,MESSAGE])

See L<Mail::Box/"The messages">

=item $obj-E<gt>B<messageId>(MESSAGE-ID [,MESSAGE])

See L<Mail::Box/"The messages">

=item $obj-E<gt>B<messageIds>

See L<Mail::Box/"The messages">

=item $obj-E<gt>B<messages>(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])

See L<Mail::Box/"The messages">

=item $obj-E<gt>B<nrMessages>(OPTIONS)

See L<Mail::Box/"The messages">

=item $obj-E<gt>B<scanForMessages>(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)

See L<Mail::Box/"The messages">

=back

=head2 Sub-folders

=over 4

=item $obj-E<gt>B<listSubFolders>(OPTIONS)

=item Mail::Box::POP3s-E<gt>B<listSubFolders>(OPTIONS)

See L<Mail::Box::POP3/"METHODS">

=item $obj-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])

=item Mail::Box::POP3s-E<gt>B<nameOfSubFolder>(SUBNAME, [PARENTNAME])

See L<Mail::Box/"Sub-folders">

=item $obj-E<gt>B<openRelatedFolder>(OPTIONS)

See L<Mail::Box/"Sub-folders">

=item $obj-E<gt>B<openSubFolder>(OPTIONS)

See L<Mail::Box::POP3/"METHODS">

=item $obj-E<gt>B<topFolderWithMessages>

=item Mail::Box::POP3s-E<gt>B<topFolderWithMessages>

See L<Mail::Box/"Sub-folders">

=back

=head2 Internals

=over 4

=item $obj-E<gt>B<coerce>(MESSAGE, OPTIONS)

See L<Mail::Box/"Internals">

=item $obj-E<gt>B<create>(FOLDER, OPTIONS)

=item Mail::Box::POP3s-E<gt>B<create>(FOLDER, OPTIONS)

See L<Mail::Box::POP3/"METHODS">

=item $obj-E<gt>B<determineBodyType>(MESSAGE, HEAD)

See L<Mail::Box/"Internals">

=item Mail::Box::POP3s-E<gt>B<foundIn>([FOLDERNAME], OPTIONS)

See L<Mail::Box/"Internals">

=item $obj-E<gt>B<getHead>(MESSAGE)

See L<Mail::Box::POP3/"Internals">

=item $obj-E<gt>B<getHeadAndBody>(MESSAGE)

See L<Mail::Box::POP3/"Internals">

=item $obj-E<gt>B<lineSeparator>([STRING|'CR'|'LF'|'CRLF'])

See L<Mail::Box/"Internals">

=item $obj-E<gt>B<locker>

See L<Mail::Box/"Internals">

=item $obj-E<gt>B<popClient>(OPTIONS)

See L<Mail::Box::POP3/"Internals">

=item $obj-E<gt>B<read>(OPTIONS)

See L<Mail::Box/"Internals">

=item $obj-E<gt>B<readMessages>(OPTIONS)

See L<Mail::Box/"Internals">

=item $obj-E<gt>B<storeMessage>(MESSAGE)

See L<Mail::Box/"Internals">

=item $obj-E<gt>B<toBeThreaded>(MESSAGES)

See L<Mail::Box/"Internals">

=item $obj-E<gt>B<toBeUnthreaded>(MESSAGES)

See L<Mail::Box/"Internals">

=item $obj-E<gt>B<updateMessages>(OPTIONS)

See L<Mail::Box/"Internals">

=item $obj-E<gt>B<write>(OPTIONS)

See L<Mail::Box/"Internals">

=item $obj-E<gt>B<writeMessages>(OPTIONS)

See L<Mail::Box::POP3/"Internals">

=back

=head2 Other methods

=over 4

=item $obj-E<gt>B<timespan2seconds>(TIME)

=item Mail::Box::POP3s-E<gt>B<timespan2seconds>(TIME)

See L<Mail::Box/"Other methods">

=back

=head2 Error handling

=over 4

=item $obj-E<gt>B<AUTOLOAD>

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<addReport>(OBJECT)

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

=item Mail::Box::POP3s-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<errors>

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])

=item Mail::Box::POP3s-E<gt>B<log>([LEVEL [,STRINGS]])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<logPriority>(LEVEL)

=item Mail::Box::POP3s-E<gt>B<logPriority>(LEVEL)

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<logSettings>

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<notImplemented>

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<report>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<reportAll>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<trace>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<warnings>

See L<Mail::Reporter/"Error handling">

=back

=head2 Cleanup

=over 4

=item $obj-E<gt>B<DESTROY>

See L<Mail::Box/"Cleanup">

=item $obj-E<gt>B<inGlobalDestruction>

See L<Mail::Reporter/"Cleanup">

=back

=head1 DIAGNOSTICS

=over 4

=item 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.

=item 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?

=item 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?

=item Warning: Changes not written to read-only folder $self.

You have opened the folder read-only --which is the default set
by L<new(access)|Mail::Box/"Constructors">--, made modifications, and now want to close it.
Set L<close(force)|Mail::Box/"The folder"> if you want to overrule the access mode, or close
the folder with L<close(write)|Mail::Box/"The folder"> set to C<NEVER>.

=item 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.

=item Error: Destination folder $name is not writable.

The folder where the messages are copied to is not opened with write
access (see L<new(access)|Mail::Box/"Constructors">).  This has no relation with write permission
to the folder which is controled by your operating system.

=item 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.

=item 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 L<new(access)|Mail::Box/"Constructors">, or the C<force> option is set true.

=item Error: Invalid timespan '$timespan' specified.

The string does not follow the strict rules of the time span syntax which
is permitted as parameter.

=item 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.

=item Warning: Message-id '$msgid' does not contain a domain.

According to the RFCs, message-ids need to contain a unique random part,
then an C<@>, and then a domain name.  This is made to avoid the creation
of two messages with the same id.  The warning emerges when the C<@> is
missing from the string.

=item 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.

=item 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.

=item 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.

=item 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.

=item 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.

=item 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.

=back

=head1 SEE ALSO

This module is part of Mail-Box distribution version 2.099,
built on July 07, 2011. Website: F<http://perl.overmeer.net/mailbox/>

=head1 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 F<http://www.perl.com/perl/misc/Artistic.html>