crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/packages/ezc/Mail/src/parser/interfaces/parser_set.php

   1 <?php
   2 /**
   3  * File containing the ezcMailParserSet interface
   4  *
   5  * @package Mail
   6  * @version 1.7beta1
   7  * @copyright Copyright (C) 2005-2009 eZ Systems AS. All rights reserved.
   8  * @license http://ez.no/licenses/new_bsd New BSD License
   9  */
  10
  11 /**
  12  * Interface common to all parser sets.
  13  *
  14  * A parser set provides a simple interface to fetch mail data line by
  15  * line from a set of mail.
  16  *
  17  * @package Mail
  18  * @version 1.7beta1
  19  */
  20 interface ezcMailParserSet
  21 {
  22     /**
  23      * Returns one line of data from the current mail in the set
  24      * including the ending linebreak.
  25      *
  26      * Null is returned if there is no current mail in the set or
  27      * the end of the mail is reached,
  28      *
  29      * @return string
  30      */
  31     public function getNextLine();
  32
  33     /**
  34      * Moves the set to the next mail and returns true upon success.
  35      *
  36      * False is returned if there are no more mail in the set.
  37      *
  38      * @return bool
  39      */
  40     public function nextMail();
  41
  42     /**
  43      * Returns true if mail data is available for parsing.
  44      *
  45      * @return bool
  46      */
  47     public function hasData();
  48 }
  49 ?>