Class IMAP_Search_Query

Description

The IMAP_Search_Object:: class is used to formulate queries to be used with the IMAP_Search:: class.

Located in /IMAP/IMAP/Search.php (line 406)


	
			
Variable Summary
 mixed $_and
 mixed $_flags
 mixed $_not
 mixed $_or
 mixed $_query
 mixed $_size
 mixed $_sizeop
Method Summary
 void andSearch ()
 void answered ( $flag)
 void before ( $day,  $month,  $year)
 void body ( $query, [ $not = false])
 void build ()
 void deleted ( $flag)
 void extendedSearch ()
 void flagged ( $flag)
 void flags ()
 void header ( $header,  $query, [ $not = false])
 void imapAnd ( $ob)
 void imapNew ()
 void imapOr ( $ob)
 bool matches ( &$parsedMessage, object $parsedMessage)
 void on ( $day,  $month,  $year)
 void orSearch ()
 void recent ( $flag)
 void seen ( $flag)
 void since ( $day,  $month,  $year)
 void size ( $size,  $operator)
 void sizeSearch ()
 void text ( $query, [ $not = false])
 void _imapDate ( $day,  $month,  $year,  $cmd)
 void _imapFlags ( $flag,  $cmd)
 void _matchesQuery ( &$parsedMessage)
 void _modifiers ( $ob,  $cmd)
 void _recursiveMatch ( &$list,  $operator,  &$parsedMessage)
Variables
mixed $_and = array() (line 408)
mixed $_extendedSearch = array() (line 409)
mixed $_flags = array() (line 410)
mixed $_not = false (line 411)
mixed $_or = array() (line 412)
mixed $_query = null (line 413)
mixed $_size = null (line 414)
mixed $_sizeop = null (line 415)
Methods
andSearch (line 450)

Returns any AND searches.

void andSearch ()
answered (line 531)
void answered ( $flag)
  • $flag
before (line 586)
void before ( $day,  $month,  $year)
  • $day
  • $month
  • $year
body (line 604)

IMAP Text searches.

void body ( $query, [ $not = false])
  • $query
  • $not
build (line 474)

Builds the IMAP search query.

void build ()
deleted (line 536)
void deleted ( $flag)
  • $flag
extendedSearch (line 420)

Returns any extended searches.

void extendedSearch ()
flagged (line 541)
void flagged ( $flag)
  • $flag
flags (line 466)

Returns the flags.

void flags ()
header (line 564)

IMAP Header Search.

void header ( $header,  $query, [ $not = false])
  • $header
  • $query
  • $not
imapAnd (line 509)
void imapAnd ( $ob)
  • $ob
imapNew (line 556)
void imapNew ()
imapOr (line 514)
void imapOr ( $ob)
  • $ob
matches (line 634)

Determines whether this query matches a pre-parsed message

Note: This is not completely implemented.

  • return: whether the message matches
bool matches ( &$parsedMessage, object $parsedMessage)
  • object $parsedMessage: The return value from Mail_mimeDecode::decode()
  • &$parsedMessage
on (line 596)
void on ( $day,  $month,  $year)
  • $day
  • $month
  • $year
orSearch (line 458)

Returns any OR searches.

void orSearch ()
recent (line 551)
void recent ( $flag)
  • $flag
seen (line 546)
void seen ( $flag)
  • $flag
since (line 591)
void since ( $day,  $month,  $year)
  • $day
  • $month
  • $year
size (line 619)

IMAP Size searches.

void size ( $size,  $operator)
  • $size
  • $operator
sizeSearch (line 435)

Returns the parameters for a size search.

void sizeSearch ()
text (line 610)
void text ( $query, [ $not = false])
  • $query
  • $not
_imapDate (line 581)

IMAP Date Search.

void _imapDate ( $day,  $month,  $year,  $cmd)
  • $day
  • $month
  • $year
  • $cmd
_imapFlags (line 525)

IMAP Search Flags.

There is no need to support the KEYWORD/UNKEYWORD query since the individual keywords have identical functionality.

void _imapFlags ( $flag,  $cmd)
  • $flag
  • $cmd
_matchesQuery (line 680)
void _matchesQuery ( &$parsedMessage)
  • &$parsedMessage
_modifiers (line 501)

IMAP search modifiers.

void _modifiers ( $ob,  $cmd)
  • $ob
  • $cmd
_recursiveMatch (line 649)
void _recursiveMatch ( &$list,  $operator,  &$parsedMessage)
  • &$list
  • $operator
  • &$parsedMessage

Documentation generated on Sun, 30 Jan 2011 05:21:08 +0000 by phpDocumentor 1.4.3