Mark Overmeer > Mail-Box-2.109 > Mail::Server::IMAP4::Search

Download:
Mail-Box-2.109.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  13
View/Report Bugs
Module Version: 2.109   Source   Latest Release: Mail-Box-2.115

NAME ^

Mail::Server::IMAP4::Search - select messages within a IMAP folder (not completed)

INHERITANCE ^

 Mail::Server::IMAP4::Search
   is a Mail::Box::Search
   is a Mail::Reporter

SYNOPSIS ^

 use Mail::Box::Manager;
 my $mgr    = Mail::Box::Manager->new;
 my $folder = $mgr->open('imap4:Inbox');

 my $filter = Mail::Server::IMAP4::Search->new
    (  ...to be defined...
    );

 my @msgs   = $filter->search($folder);
 if($filter->search($message)) {...}

DESCRIPTION ^

THIS PACKAGES IS NOT IMPLEMENTED YET... (it's waiting for a volunteer)

See documentation in the base class.

METHODS ^

See documentation in the base class.

Constructors

See documentation in the base class.

Mail::Server::IMAP4::Search->new(OPTIONS)
 -Option    --Defined in       --Default
  binaries    Mail::Box::Search  <false>
  decode      Mail::Box::Search  <true>
  delayed     Mail::Box::Search  <true>
  deleted     Mail::Box::Search  <false>
  deliver     Mail::Box::Search  undef
  in          Mail::Box::Search  'BODY'
  label       Mail::Box::Search  undef
  limit       Mail::Box::Search  0
  log         Mail::Reporter     'WARNINGS'
  logical     Mail::Box::Search  'REPLACE'
  multiparts  Mail::Box::Search  <true>
  trace       Mail::Reporter     'WARNINGS'
binaries => BOOLEAN
decode => BOOLEAN
delayed => BOOLEAN
deleted => BOOLEAN
deliver => undef|CODE|'DELETE'
in => 'HEAD'|'BODY'|'MESSAGE'
label => STRING
limit => NUMBER
log => LEVEL
logical => 'REPLACE'|'AND'|'OR'|'NOT'|'AND NOT'|'OR NOT'
multiparts => BOOLEAN
trace => LEVEL

Searching

See documentation in the base class.

$obj->inBody(PART, BODY)

See "Searching" in Mail::Box::Search

$obj->inHead(PART, HEAD)

See "Searching" in Mail::Box::Search

$obj->search(FOLDER|THREAD|MESSAGE|ARRAY-OF-MESSAGES)

See "Searching" in Mail::Box::Search

$obj->searchPart(PART)

See "Searching" in Mail::Box::Search

The Results

See documentation in the base class.

$obj->printMatch([FILEHANDLE], HASH)

See "The Results" in Mail::Box::Search

Error handling

See documentation in the base class.

$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::Server::IMAP4::Search->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::Server::IMAP4::Search->log([LEVEL [,STRINGS]])

See "Error handling" in Mail::Reporter

$obj->logPriority(LEVEL)
Mail::Server::IMAP4::Search->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

See documentation in the base class.

$obj->DESTROY()

See "Cleanup" in Mail::Reporter

DIAGNOSTICS ^

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.

SEE ALSO ^

This module is part of Mail-Box distribution version 2.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE ^

Copyrights 2001-2013 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

syntax highlighting: