Add search test and docs

README.md

@@ -70,6 +70,23 @@ foreach ($messages as $message) {
 }
 ```
 
+#### Searching for Messages
+
+```php
+use Ddeboer\Imap\SearchExpression;
+use Ddeboer\Imap\Search\Email\To;
+use Ddeboer\Imap\Search\Text\Body;
+
+$search = new SearchExpression();
+$search->addCondition(new To('[email protected]'))
+    ->addCondition(new Body('contents'))
+;
+
+$messages = $mailbox->getMessages($search);
+```
+
+#### Message Properties and Operations
+
 Get message number and unique [message id](http://en.wikipedia.org/wiki/Message-ID)
 in the form <...>:
 

src/Search/Condition.php → src/Search/AbstractCondition.php

@@ -5,7 +5,7 @@
 /**
  * Represents a condition that can be used in a search expression.
  */
-abstract class Condition
+abstract class AbstractCondition
 {
     /**
      * Converts the condition to a string that can be sent to the IMAP server.

src/Search/Date.php → src/Search/Date/AbstractDate.php

@@ -1,13 +1,14 @@
 <?php
 
-namespace Ddeboer\Imap\Search;
+namespace Ddeboer\Imap\Search\Date;
 
 use DateTime;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents a date condition.
  */
-abstract class Date extends Condition
+abstract class AbstractDate extends AbstractCondition
 {
     /**
      * Format for dates to be sent to the IMAP server.

src/Search/Date/After.php

@@ -2,13 +2,11 @@
 
 namespace Ddeboer\Imap\Search\Date;
 
-use Ddeboer\Imap\Search\Date;
-
 /**
  * Represents a date after condition. Messages must have a date after the
  * specified date in order to match the condition.
  */
-class After extends Date
+class After extends AbstractDate
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Date/Before.php

@@ -2,13 +2,11 @@
 
 namespace Ddeboer\Imap\Search\Date;
 
-use Ddeboer\Imap\Search\Date;
-
 /**
  * Represents a date before condition. Messages must have a date before the
  * specified date in order to match the condition.
  */
-class Before extends Date
+class Before extends AbstractDate
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Date/On.php

@@ -2,13 +2,11 @@
 
 namespace Ddeboer\Imap\Search\Date;
 
-use Ddeboer\Imap\Search\Date;
-
 /**
  * Represents a date on condition. Messages must have a date matching the
  * specified date in order to match the condition.
  */
-class On extends Date
+class On extends AbstractDate
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Email.php → src/Search/Email/AbstractEmail.php

@@ -1,11 +1,13 @@
 <?php
 
-namespace Ddeboer\Imap\Search;
+namespace Ddeboer\Imap\Search\Email;
+
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents an email condition.
  */
-abstract class Email extends Condition
+abstract class AbstractEmail extends AbstractCondition
 {
     /**
      * Email address for the condition.

src/Search/Email/FromAddress.php

@@ -2,13 +2,11 @@
 
 namespace Ddeboer\Imap\Search\Email;
 
-use Ddeboer\Imap\Search\Email;
-
 /**
  * Represents a "From" email address condition. Messages must have been sent
  * from the specified email address in order to match the condition.
  */
-class FromAddress extends Email
+class FromAddress extends AbstractEmail
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Email/To.php

@@ -2,14 +2,12 @@
 
 namespace Ddeboer\Imap\Search\Email;
 
-use Ddeboer\Imap\Search\Email;
-
 /**
  * Represents a "To" email address condition. Messages must have been addressed
  * to the specified recipient (along with any others) in order to match the
  * condition.
  */
-class To extends Email
+class To extends AbstractEmail
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Flag/Answered.php

@@ -2,13 +2,13 @@
 
 namespace Ddeboer\Imap\Search\Flag;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents an ANSWERED flag condition. Messages must have the \\ANSWERED flag
  * set in order to match the condition.
  */
-class Answered extends Condition
+class Answered extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Flag/Flagged.php

@@ -2,13 +2,13 @@
 
 namespace Ddeboer\Imap\Search\Flag;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents a FLAGGED flag condition. Messages must have the \\FLAGGED flag
  * (i.e. urgent or important) set in order to match the condition.
  */
-class Flagged extends Condition
+class Flagged extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Flag/Recent.php

@@ -2,13 +2,13 @@
 
 namespace Ddeboer\Imap\Search\Flag;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents an RECENT flag condition. Messages must have the \\RECENT flag
  * set in order to match the condition.
  */
-class Recent extends Condition
+class Recent extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Flag/Seen.php

@@ -2,13 +2,13 @@
 
 namespace Ddeboer\Imap\Search\Flag;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents an SEEN flag condition. Messages must have the \\SEEN flag
  * set in order to match the condition.
  */
-class Seen extends Condition
+class Seen extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Flag/Unanswered.php

@@ -2,13 +2,13 @@
 
 namespace Ddeboer\Imap\Search\Flag;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents an UNANSWERED flag condition. Messages must not have the
  * \\ANSWERED flag set in order to match the condition.
  */
-class Unanswered extends Condition
+class Unanswered extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Flag/Unflagged.php

@@ -2,13 +2,13 @@
 
 namespace Ddeboer\Imap\Search\Flag;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents a UNFLAGGED flag condition. Messages must no have the \\FLAGGED
  * flag (i.e. urgent or important) set in order to match the condition.
  */
-class Unflagged extends Condition
+class Unflagged extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Flag/Unseen.php

@@ -2,13 +2,13 @@
 
 namespace Ddeboer\Imap\Search\Flag;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents an UNSEEN flag condition. Messages must not have the \\SEEN flag
  * set in order to match the condition.
  */
-class Unseen extends Condition
+class Unseen extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/LogicalOperator/All.php

@@ -2,13 +2,13 @@
 
 namespace Ddeboer\Imap\Search\LogicalOperator;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents an ALL operator. Messages must match all conditions following this
  * operator in order to match the expression.
  */
-class All extends Condition
+class All extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/LogicalOperator/OrConditions.php

@@ -2,13 +2,13 @@
 
 namespace Ddeboer\Imap\Search\LogicalOperator;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents an OR operator. Messages only need to match one of the conditions
  * after this operator to match the expression.
  */
-class OrConditions extends Condition
+class OrConditions extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/State/Deleted.php

@@ -2,13 +2,13 @@
 
 namespace Ddeboer\Imap\Search\State;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents a DELETED condition. Messages must have been marked for deletion
  * but not yet expunged in order to match the condition.
  */
-class Deleted extends Condition
+class Deleted extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/State/NewMessage.php

@@ -2,12 +2,12 @@
 
 namespace Ddeboer\Imap\Search\State;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents a NEW condition. Only new messages will match this condition.
  */
-class NewMessage extends Condition
+class NewMessage extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/State/Old.php

@@ -2,12 +2,12 @@
 
 namespace Ddeboer\Imap\Search\State;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents an OLD condition. Only old messages will match this condition.
  */
-class Old extends Condition
+class Old extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/State/Undeleted.php

@@ -2,13 +2,13 @@
 
 namespace Ddeboer\Imap\Search\State;
 
-use Ddeboer\Imap\Search\Condition;
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents a UNDELETED condition. Messages must not have been marked for
  * deletion in order to match the condition.
  */
-class Undeleted extends Condition
+class Undeleted extends AbstractCondition
 {
     /**
      * Returns the keyword that the condition represents.

src/Search/Text.php → src/Search/Text/AbstractText.php

@@ -1,12 +1,14 @@
 <?php
 
-namespace Ddeboer\Imap\Search;
+namespace Ddeboer\Imap\Search\Text;
+
+use Ddeboer\Imap\Search\AbstractCondition;
 
 /**
  * Represents a text based condition. Text based conditions use a contains
  * restriction.
  */
-abstract class Text extends Condition
+abstract class AbstractText extends AbstractCondition
 {
     /**
      * Text to be used for the condition.

src/Search/Text/Body.php

@@ -2,8 +2,6 @@
 
 namespace Ddeboer\Imap\Search\Text;
 
-use Ddeboer\Imap\Search\Text;
-
 /**
  * Represents a body text contains condition. Messages must have a body
  * containing the specified text in order to match the condition.

src/Search/Text/Keyword.php

@@ -2,8 +2,6 @@
 
 namespace Ddeboer\Imap\Search\Text;
 
-use Ddeboer\Imap\Search\Text;
-
 /**
  * Represents a keyword text contains condition. Messages must have a keyword
  * matching the specified text in order to match the condition.

src/Search/Text/Subject.php

@@ -2,8 +2,6 @@
 
 namespace Ddeboer\Imap\Search\Text;
 
-use Ddeboer\Imap\Search\Text;
-
 /**
  * Represents a subject contains condition. Messages must have a subject
  * containing the specified text in order to match the condition.