=encoding utf8

=head1 NAME

Mail::Box::IMAP4s - handle IMAP4 folders as client, with ssl connection

=head1 INHERITANCE

 Mail::Box::IMAP4s
   is a Mail::Box::IMAP4
   is a Mail::Box::Net
   is a Mail::Box
   is a Mail::Reporter

=head1 SYNOPSIS

  my $url = 'imap4s://user:passwd@host:port/INBOX';
  my $url = 'imaps://user:passwd@host:port/INBOX';

  use Mail::Box::IMAP4s;
  my $folder = Mail::Box::IMAP4s->new(folder => $url, ...);

  my $mgr    = Mail::Box::Manager->new;
  my $folder = $msg->open($url, retry => 3, interval => 5);

=head1 DESCRIPTION

See L<Mail::Box::IMAP4|Mail::Box::IMAP4>.

Extends L<"DESCRIPTION" in Mail::Box::IMAP4|Mail::Box::IMAP4/"DESCRIPTION">.

=head1 OVERLOADED

Extends L<"OVERLOADED" in Mail::Box::IMAP4|Mail::Box::IMAP4/"OVERLOADED">.

=over 4

=item overload: B<""> stringification

Inherited, see L<Mail::Box/"OVERLOADED">

=item overload: B<@{}> use as ARRAY

Inherited, see L<Mail::Box/"OVERLOADED">

=item overload: B<cmp> string comparison

Inherited, see L<Mail::Box/"OVERLOADED">

=back

=head1 METHODS

Extends L<"METHODS" in Mail::Box::IMAP4|Mail::Box::IMAP4/"METHODS">.

=head2 Constructors

Extends L<"Constructors" in Mail::Box::IMAP4|Mail::Box::IMAP4/"Constructors">.

=over 4

=item $class-E<gt>B<new>(%options)

Inherited, see L<Mail::Box::IMAP4/"METHODS">

 -Option           --Defined in      --Default
  access             Mail::Box         'r'
  body_delayed_type  Mail::Box         Mail::Message::Body::Delayed
  body_type          Mail::Box         Mail::Message::Body::Lines
  cache_body         Mail::Box::IMAP4  NO
  cache_head         Mail::Box::IMAP4  NO or DELAY
  cache_labels       Mail::Box::IMAP4  NO or DELAY
  coerce_options     Mail::Box         +[]
  create             Mail::Box         false
  extract            Mail::Box         10240
  field_type         Mail::Box         undef
  fix_headers        Mail::Box         false
  folder             Mail::Box         /
  folderdir          Mail::Box         <network location>
  head_delayed_type  Mail::Box         Mail::Message::Head::Delayed
  head_type          Mail::Box         Mail::Box::IMAP4::Head or Mail::Message::Head::Complete
  join_connection    Mail::Box::IMAP4  true
  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
  manager            Mail::Box         undef
  message_type       Mail::Box         Mail::Box::IMAP4::Message
  multipart_type     Mail::Box         Mail::Message::Body::Multipart
  password           Mail::Box::Net    undef
  remove_when_empty  Mail::Box         <false>
  save_on_exit       Mail::Box         true
  server_name        Mail::Box::Net    undef
  server_port        Mail::Box::Net    993
  ssl                                  { SSL_verify_mode => SSL_VERIFY_NONE }
  starttls                             false
  transporter        Mail::Box::IMAP4  Mail::Transport::IMAP4
  trusted            Mail::Box         <false>
  username           Mail::Box::Net    undef

=over 2

=item access => $mode

=item body_delayed_type => CLASS

=item body_type => CLASS|CODE

=item cache_body => 'NO'|'YES'|'DELAY'

=item cache_head => 'NO'|'PARTIAL'|'DELAY'

=item cache_labels => 'NO'|'WRITE'|'DELAY'

=item coerce_options => ARRAY

=item create => BOOLEAN

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

=item field_type => CLASS

=item fix_headers => BOOLEAN

=item folder => $name

=item folderdir => $directory

=item head_delayed_type => CLASS

=item head_type => CLASS

=item join_connection => BOOLEAN

=item keep_dups => BOOLEAN

=item lock_file => $file

=item lock_timeout => $seconds

=item lock_type => CLASS|STRING|ARRAY

=item lock_wait => $seconds

=item locker => OBJECT

=item manager => $manager

=item message_type => CLASS

=item multipart_type => CLASS

=item password => $password

=item remove_when_empty => BOOLEAN

=item save_on_exit => BOOLEAN

=item server_name => $host

=item server_port => $number

=item ssl => \%config|\@pairs

Parameters to initialize the SSL connection.

=item starttls => BOOLEAN

=item transporter => $object|$class

=item trusted => BOOLEAN

=item username => $username

=back

=back

=head2 Attributes

Extends L<"Attributes" in Mail::Box::IMAP4|Mail::Box::IMAP4/"Attributes">.

=over 4

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

Inherited, see L<Mail::Box/"Attributes">

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

Inherited, see L<Mail::Box/"Attributes">

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

Inherited, see L<Mail::Box/"Attributes">

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

Inherited, see L<Mail::Box/"Attributes">

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

Inherited, see L<Mail::Box/"Attributes">

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

Inherited, see L<Mail::Box/"Attributes">

=back

=head2 The folder

Extends L<"The folder" in Mail::Box::IMAP4|Mail::Box::IMAP4/"The folder">.

=over 4

=item $obj-E<gt>B<addMessage>($message, %options)

Inherited, see L<Mail::Box/"The folder">

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

Inherited, see L<Mail::Box/"The folder">

=item $class-E<gt>B<appendMessages>(%options)

Inherited, see L<Mail::Box/"The folder">

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

Inherited, see L<Mail::Box::IMAP4/"METHODS">

=item $obj-E<gt>B<copyTo>($folder, %options)

Inherited, see L<Mail::Box/"The folder">

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

Inherited, see L<Mail::Box/"The folder">

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

Inherited, see L<Mail::Box/"The folder">

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

Inherited, see L<Mail::Box/"The folder">

=item $obj-E<gt>B<update>(%options)

Inherited, see L<Mail::Box/"The folder">

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

Inherited, see L<Mail::Box/"The folder">

=back

=head2 Folder flags

Extends L<"Folder flags" in Mail::Box::IMAP4|Mail::Box::IMAP4/"Folder flags">.

=over 4

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

Inherited, see L<Mail::Box/"Folder flags">

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

Inherited, see L<Mail::Box/"Folder flags">

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

Inherited, see L<Mail::Box/"Folder flags">

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

Inherited, see L<Mail::Box/"Folder flags">

=back

=head2 The messages

Extends L<"The messages" in Mail::Box::IMAP4|Mail::Box::IMAP4/"The messages">.

=over 4

=item $obj-E<gt>B<current>( [$number|$message|$message_id] )

Inherited, see L<Mail::Box/"The messages">

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

Inherited, see L<Mail::Box/"The messages">

=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [\@msgs]] )

Inherited, see L<Mail::Box/"The messages">

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

Inherited, see L<Mail::Box/"The messages">

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

Inherited, see L<Mail::Box/"The messages">

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

Inherited, see L<Mail::Box/"The messages">

=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )

Inherited, see L<Mail::Box/"The messages">

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

Inherited, see L<Mail::Box/"The messages">

=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)

Inherited, see L<Mail::Box/"The messages">

=back

=head2 Sub-folders

Extends L<"Sub-folders" in Mail::Box::IMAP4|Mail::Box::IMAP4/"Sub-folders">.

=over 4

=item $any-E<gt>B<listSubFolders>(%options)

Inherited, see L<Mail::Box/"Sub-folders">

=item $any-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )

Inherited, see L<Mail::Box/"Sub-folders">

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

Inherited, see L<Mail::Box/"Sub-folders">

=item $obj-E<gt>B<openSubFolder>($subname, %options)

Inherited, see L<Mail::Box/"Sub-folders">

=item $any-E<gt>B<topFolderWithMessages>()

Inherited, see L<Mail::Box/"Sub-folders">

=back

=head2 Internals

Extends L<"Internals" in Mail::Box::IMAP4|Mail::Box::IMAP4/"Internals">.

=over 4

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

Inherited, see L<Mail::Box::IMAP4/"Internals">

=item $obj-E<gt>B<coerce>($message, %options)

Inherited, see L<Mail::Box/"Internals">

=item $any-E<gt>B<create>($folder, %options)

Inherited, see L<Mail::Box::Net/"METHODS">

=item $obj-E<gt>B<createTransporter>($class, %options)

Inherited, see L<Mail::Box::IMAP4/"Internals">

=item $obj-E<gt>B<determineBodyType>($message, $head)

Inherited, see L<Mail::Box/"Internals">

=item $obj-E<gt>B<fetch>( <$messages|$selection>, $info )

Inherited, see L<Mail::Box::IMAP4/"Internals">

=item $class-E<gt>B<foundIn>( [$foldername], %options )

Inherited, see L<Mail::Box/"Internals">

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

Inherited, see L<Mail::Box::IMAP4/"Internals">

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

Inherited, see L<Mail::Box::IMAP4/"Internals">

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

Inherited, see L<Mail::Box/"Internals">

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

Inherited, see L<Mail::Box/"Internals">

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

Inherited, see L<Mail::Box/"Internals">

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

Inherited, see L<Mail::Box/"Internals">

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

Inherited, see L<Mail::Box/"Internals">

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

Inherited, see L<Mail::Box/"Internals">

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

Inherited, see L<Mail::Box/"Internals">

=item $obj-E<gt>B<transporter>( [$object] )

Inherited, see L<Mail::Box::IMAP4/"Internals">

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

Inherited, see L<Mail::Box/"Internals">

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

Inherited, see L<Mail::Box::IMAP4/"Internals">

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

Inherited, see L<Mail::Box::IMAP4/"Internals">

=back

=head2 Other methods

Extends L<"Other methods" in Mail::Box::IMAP4|Mail::Box::IMAP4/"Other methods">.

=over 4

=item $any-E<gt>B<timespan2seconds>($time)

Inherited, see L<Mail::Box/"Other methods">

=back

=head2 Error handling

Extends L<"Error handling" in Mail::Box::IMAP4|Mail::Box::IMAP4/"Error handling">.

=over 4

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

Inherited, see L<Mail::Reporter/"Error handling">

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

Inherited, see L<Mail::Reporter/"Error handling">

=back

=head2 Cleanup

Extends L<"Cleanup" in Mail::Box::IMAP4|Mail::Box::IMAP4/"Cleanup">.

=over 4

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

Inherited, see L<Mail::Box/"Cleanup">

=back

=head1 DETAILS

Extends L<"DETAILS" in Mail::Box::IMAP4|Mail::Box::IMAP4/"DETAILS">.

=head1 DIAGNOSTICS

=over 4

=item Warning: cannot find head back for $id in $folder.

The header was read before, but now seems empty: the IMAP4 server does
not produce the header lines anymore.
Cast by C<getHeadAndBody()>

=item Warning: cannot read body for $id in $folder.

The header of the message was retrieved from the IMAP4 server, but the
body is not read, for an unknown reason.
Cast by C<getHeadAndBody()>

=item Error: class $package does not implement method $method.

Fatal error: the specific C<$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.
Cast by C<notImplemented()>

=item Error: copying failed for one message.

For some reason, for instance disk full, removed by external process, or
read-protection, it is impossible to copy one of the messages.  Copying will
proceed for the other messages.
Cast by C<copyTo()>

=item Error: couldn't select IMAP4 folder $name.

Cast by C<transporter()>

=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 controlled by your operating system.
Cast by C<copyTo()>

=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.
Cast by C<messageId()>

=item Warning: folder $name not deleted: not writable.

The folder must be opened with write access via L<new(access)|Mail::Box/"Constructors">, 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
C<delete> method permits you to.  The reverse remark is valid as well.
Cast by C<delete()>

=item Notice: impossible to keep deleted messages in IMAP folder $name.

Some folder type have a 'deleted' flag which can be stored in the folder to
be performed later.  The folder keeps that knowledge even when the folder
is rewritten.  Well, IMAP4 cannot play that trick.
Cast by C<write()>

=item Error: invalid timespan '$span'.

The string does not follow the strict rules of the time span syntax which
is permitted as parameter.
Cast by C<timespan2seconds()>

=item Warning: message $id disappeared from $folder.

Trying to get the specific message from the server, but it appears to be
gone.
Cast by C<getHeadAndBody()>

=item Warning: message {id} disappeared from {folder}.

Trying to get the specific message from the server, but it appears to be gone.
Cast by C<getHead()>

=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.
Cast by C<messageId()>

=item Error: no IMAP4 transporter configured.

Cast by C<transporter()>

=item Error: you cannot add a message which is already part of a folder to a new one.  Please use moveTo or copyTo.

Cast by C<addMessage()>

=back

=head1 SEE ALSO

This module is part of Mail-Box-IMAP4 version 4.01,
built on December 13, 2025. Website: F<http://perl.overmeer.net/CPAN/>

=head1 LICENSE

For contributors see file ChangeLog.

This software is copyright (c) 2001-2025 by Mark Overmeer.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

