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)

METHODS

Constructors

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

$obj->inBody(PART, BODY)

See Mail::Box::Search/"Searching"

$obj->inHead(PART, HEAD)

See Mail::Box::Search/"Searching"

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

See Mail::Box::Search/"Searching"

$obj->searchPart(PART)

See Mail::Box::Search/"Searching"

The Results

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

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

Error handling

$obj->AUTOLOAD

See Mail::Reporter/"Error handling"

$obj->addReport(OBJECT)

See Mail::Reporter/"Error handling"

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Server::IMAP4::Search->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See Mail::Reporter/"Error handling"

$obj->errors

See Mail::Reporter/"Error handling"

$obj->log([LEVEL [,STRINGS]])

Mail::Server::IMAP4::Search->log([LEVEL [,STRINGS]])

See Mail::Reporter/"Error handling"

$obj->logPriority(LEVEL)

Mail::Server::IMAP4::Search->logPriority(LEVEL)

See Mail::Reporter/"Error handling"

$obj->logSettings

See Mail::Reporter/"Error handling"

$obj->notImplemented

See Mail::Reporter/"Error handling"

$obj->report([LEVEL])

See Mail::Reporter/"Error handling"

$obj->reportAll([LEVEL])

See Mail::Reporter/"Error handling"

$obj->trace([LEVEL])

See Mail::Reporter/"Error handling"

$obj->warnings

See Mail::Reporter/"Error handling"

Cleanup

$obj->DESTROY

See Mail::Reporter/"Cleanup"

$obj->inGlobalDestruction

See Mail::Reporter/"Cleanup"

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.

LICENSE

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