Mail::Box::IMAP4s(3pm)

User Contributed Perl Documentation

Mail::Box::IMAP4s(3pm)

NAME¶

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

INHERITANCE¶

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

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);

DESCRIPTION¶

See Mail::Box::IMAP4.

Extends "DESCRIPTION" in Mail::Box::IMAP4.

OVERLOADED¶

Extends "OVERLOADED" in Mail::Box::IMAP4.

overload: "" stringification: Inherited, see "OVERLOADED" in Mail::Box
overload: @{} use as ARRAY: Inherited, see "OVERLOADED" in Mail::Box
overload: cmp string comparison: Inherited, see "OVERLOADED" in Mail::Box

METHODS¶

Extends "METHODS" in Mail::Box::IMAP4.

Constructors¶

Extends "Constructors" in Mail::Box::IMAP4.

$class->new(%options)

Inherited, see "METHODS" in Mail::Box::IMAP4

 -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
  log                Mail::Reporter    'WARNINGS'
  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
  trace              Mail::Reporter    'WARNINGS'
  transporter        Mail::Box::IMAP4  Mail::Transport::IMAP4
  trusted            Mail::Box         <false>
  username           Mail::Box::Net    undef

access => $mode
body_delayed_type => CLASS
body_type => CLASS|CODE
cache_body => 'NO'|'YES'|'DELAY'
cache_head => 'NO'|'PARTIAL'|'DELAY'
cache_labels => 'NO'|'WRITE'|'DELAY'
coerce_options => ARRAY
create => BOOLEAN
extract => INTEGER | CODE | METHOD | 'LAZY'| 'ALWAYS'
field_type => CLASS
fix_headers => BOOLEAN
folder => $name
folderdir => $directory
head_delayed_type => CLASS
head_type => CLASS
join_connection => BOOLEAN
keep_dups => BOOLEAN
lock_file => $file
lock_timeout => $seconds
lock_type => CLASS|STRING|ARRAY
lock_wait => $seconds
locker => OBJECT
log => LEVEL
manager => $manager
message_type => CLASS
multipart_type => CLASS
password => $password
remove_when_empty => BOOLEAN
save_on_exit => BOOLEAN
server_name => $host
server_port => $number
ssl => HASH|ARRAY: Parameters to initialize the SSL connection.
starttls => BOOLEAN
trace => LEVEL
transporter => $object|$class
trusted => BOOLEAN
username => $username

Attributes¶

Extends "Attributes" in Mail::Box::IMAP4.

$obj->fixHeaders(): Inherited, see "Attributes" in Mail::Box
$obj->folderdir( [$directory] ): Inherited, see "Attributes" in Mail::Box
$obj->isTrusted(): Inherited, see "Attributes" in Mail::Box
$obj->logSettings(): Inherited, see "Attributes" in Mail::Reporter
$obj->name(): Inherited, see "Attributes" in Mail::Box
$obj->removeEmpty(): Inherited, see "Attributes" in Mail::Box
$obj->type(): Inherited, see "Attributes" in Mail::Box

The folder¶

Extends "The folder" in Mail::Box::IMAP4.

$obj->addMessage($message, %options): Inherited, see "The folder" in Mail::Box
$obj->addMessages(@messages): Inherited, see "The folder" in Mail::Box
$class->appendMessages(%options): Inherited, see "The folder" in Mail::Box
$obj->close(%options): Inherited, see "METHODS" in Mail::Box::IMAP4
$obj->copyTo($folder, %options): Inherited, see "The folder" in Mail::Box
$obj->delete(%options): 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->update(%options): Inherited, see "The folder" in Mail::Box
$obj->url(): Inherited, see "The folder" in Mail::Box

Folder flags¶

Extends "Folder flags" in Mail::Box::IMAP4.

$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::IMAP4.

$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::IMAP4.

$any->listSubFolders(%options): Inherited, see "Sub-folders" in Mail::Box
$any->nameOfSubFolder( $subname, [$parentname] ): Inherited, see "Sub-folders" in Mail::Box
$obj->openRelatedFolder(%options): Inherited, see "Sub-folders" in Mail::Box
$obj->openSubFolder($subname, %options): Inherited, see "Sub-folders" in Mail::Box
$any->topFolderWithMessages(): Inherited, see "Sub-folders" in Mail::Box

Internals¶

Extends "Internals" in Mail::Box::IMAP4.

$obj->body( [$body] ): Inherited, see "Internals" in Mail::Box::IMAP4
$obj->coerce($message, %options): Inherited, see "Internals" in Mail::Box
$any->create($folder, %options): Inherited, see "METHODS" in Mail::Box::Net
$obj->createTransporter($class, %options): Inherited, see "Internals" in Mail::Box::IMAP4
$obj->determineBodyType($message, $head): Inherited, see "Internals" in Mail::Box
$obj->fetch( <$messages|$selection>, $info ): Inherited, see "Internals" in Mail::Box::IMAP4
$class->foundIn( [$foldername], %options ): Inherited, see "Internals" in Mail::Box
$obj->getHead($message): Inherited, see "Internals" in Mail::Box::IMAP4
$obj->getHeadAndBody($message): Inherited, see "Internals" in Mail::Box::IMAP4
$obj->lineSeparator( [<STRING|'CR'|'LF'|'CRLF'>] ): Inherited, see "Internals" in Mail::Box
$obj->locker(): Inherited, see "Internals" in Mail::Box
$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->transporter( [$object] ): Inherited, see "Internals" in Mail::Box::IMAP4
$obj->updateMessages(%options): Inherited, see "Internals" in Mail::Box
$obj->write(%options): Inherited, see "Internals" in Mail::Box::IMAP4
$obj->writeMessages(%options): Inherited, see "Internals" in Mail::Box::IMAP4

Other methods¶

Extends "Other methods" in Mail::Box::IMAP4.

$any->timespan2seconds($time): Inherited, see "Other methods" in Mail::Box

Error handling¶

Extends "Error handling" in Mail::Box::IMAP4.

$obj->AUTOLOAD(): Inherited, see "Error handling" in Mail::Reporter
$obj->addReport($object): Inherited, see "Error handling" in Mail::Reporter
$any->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ): Inherited, see "Error handling" in Mail::Reporter
$obj->errors(): Inherited, see "Error handling" in Mail::Reporter
$any->log( [$level, [$strings]] ): Inherited, see "Error handling" in Mail::Reporter
$any->logPriority($level): 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::IMAP4.

$obj->DESTROY(): Inherited, see "Cleanup" in Mail::Box

DETAILS¶

Extends "DETAILS" in Mail::Box::IMAP4.

DIAGNOSTICS¶

Warning: Cannot find head back for $uidl in $folder.: The header was read before, but now seems empty: the IMAP4 server does not produce the header lines anymore. Cast by getHeadAndBody()
Warning: Cannot read body for $uidl 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 getHeadAndBody()
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. Cast by copyTo()
Error: Couldn't select IMAP4 folder $name: Cast by transporter()
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. Cast by copyTo()
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 messageId()
Error: Folder $name not deleted: not writable.: The folder must be opened with write access via new(access), 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 "delete" method permits you to. The reverse remark is valid as well. Cast by delete()
Notice: Impossible to keep deleted messages in IMAP: 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 write()
Error: Invalid timespan '$timespan' specified.: The string does not follow the strict rules of the time span syntax which is permitted as parameter. Cast by timespan2seconds()
Warning: Message $uidl disappeared from $folder.: Trying to get the specific message from the server, but it appears to be gone. Cast by getHead()
Warning: Message $uidl disappeared from $folder.: Trying to get the specific message from the server, but it appears to be gone. Cast by getHeadAndBody()
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. Cast by messageId()
Error: No IMAP4 transporter configured: Cast by transporter()
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. Cast by notImplemented()
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. Cast by copyTo()

LICENSE¶

For contributors see file ChangeLog.

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

2025-12-07

perl v5.40.1

Source file:	Mail::Box::IMAP4s.3pm.en.gz (from libmail-box-imap4-perl 3.010-1)
Source last updated:	2025-12-07T03:59:48Z
Converted to HTML:	2025-12-07T08:48:20Z