File: docs/structure.xml

<?xml version="1.0" encoding="utf-8"?>
<project version="2.0.0a11" title="">
  <file path="Imap.php" hash="5cd9d4f664d60e8c0bf49f6989c9a446" package="Imap">
    <docblock line="2">
      <description>Imap classes for retrieving an inbox, messages, and attachments</description>
      <long-description>&lt;p&gt;Optimized Imap classes allow you to browse through an inbox quickly without
hogging resources or physically downloading every message.  You can specify
sorting order, limits, and even search capabilities.  If a message has
attachments, those are viewed, but not downloaded until requested to save
time.  In a trial run, a non-local, 200-email inbox with 50 attachments was
sorted by date descending, and looped through echo-ing out the subject of the
email, all in under 20 seconds.&lt;/p&gt;

&lt;p&gt;PHP version 5.3&lt;/p&gt;

&lt;p&gt;LICENSE: This source file is subject to version 3.01 of the PHP license
that is available through the world-wide-web at the following URI:
http://www.php.net/license/3_01.txt.  If you did not receive a copy of
the PHP License and are unable to obtain it through the web, please
send a note to license@php.net so we can mail you a copy immediately.&lt;/p&gt;</long-description>
      <tag line="2" name="category" description="Email"/>
      <tag line="2" name="package" description="Imap"/>
      <tag line="2" name="author" description="Tim Withers &lt;pyr0t3chnician@gmail.com&gt;"/>
      <tag line="2" name="copyright" description="2012 Tim Withers"/>
      <tag line="2" name="license" description="http://www.php.net/license/3_01.txt  PHP License 3.01"/>
      <tag line="2" name="version" description="1.0"/>
    </docblock>
    <include line="28" type="Require" package="Default">
      <name>Imap_Base.php</name>
    </include>
    <include line="29" type="Require" package="Default">
      <name>Imap_Message.php</name>
    </include>
    <include line="30" type="Require" package="Default">
      <name>Imap_Attachment.php</name>
    </include>
    <class final="false" abstract="false" namespace="global" line="46" package="Imap">
      <extends>\Imap_Base</extends>
      <name>Imap</name>
      <full_name>\Imap</full_name>
      <docblock line="31">
        <description>Imap class that connects to the mailbox and retrieves messages</description>
        <long-description>&lt;p&gt;Use this class to initiate a connection and then retrieve the data needed.
Messages can be retrieved based on flags, limits, offsets, and sorted.  Not
all data is instantly downloaded, just the basic information to speed up
usage where needed.&lt;/p&gt;</long-description>
        <tag line="31" name="category" description="Email"/>
        <tag line="31" name="package" description="Imap"/>
        <tag line="31" name="author" description="Tim Withers &lt;pyr0t3chnician@gmail.com&gt;"/>
        <tag line="31" name="copyright" description="2012 Tim Withers"/>
        <tag line="31" name="license" description="http://www.php.net/license/3_01.txt  PHP License 3.01"/>
        <tag line="31" name="version" description="1.0"/>
      </docblock>
      <property final="false" static="false" visibility="private" line="53" namespace="global" package="Default">
        <name>$host</name>
        <default>'localhost'</default>
        <docblock line="48">
          <description>Connection host.</description>
          <long-description>&lt;p&gt;Set in __construct()&lt;/p&gt;</long-description>
          <tag line="48" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="60" namespace="global" package="Default">
        <name>$username</name>
        <default>false</default>
        <docblock line="55">
          <description>Connection username.</description>
          <long-description>&lt;p&gt;Set in __construct()&lt;/p&gt;</long-description>
          <tag line="55" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="67" namespace="global" package="Default">
        <name>$password</name>
        <default>false</default>
        <docblock line="62">
          <description>Connection password.</description>
          <long-description>&lt;p&gt;Set in __construct()&lt;/p&gt;</long-description>
          <tag line="62" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="74" namespace="global" package="Default">
        <name>$port</name>
        <default>143</default>
        <docblock line="69">
          <description>Connection port.</description>
          <long-description>&lt;p&gt;Set in __construct()&lt;/p&gt;</long-description>
          <tag line="69" name="var" description="" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="81" namespace="global" package="Default">
        <name>$ssl</name>
        <default>false</default>
        <docblock line="76">
          <description>Connection ssl.</description>
          <long-description>&lt;p&gt;Set in __construct()&lt;/p&gt;</long-description>
          <tag line="76" name="var" description="Default is false, set to SSL or TLS in __construct()" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="88" namespace="global" package="Default">
        <name>$protocol</name>
        <default>'imap'</default>
        <docblock line="83">
          <description>Connection protocol.</description>
          <long-description>&lt;p&gt;Set in __construct()&lt;/p&gt;</long-description>
          <tag line="83" name="var" description="" type="\type">
            <type by_reference="false">\type</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="95" namespace="global" package="Default">
        <name>$folder</name>
        <default>'INBOX'</default>
        <docblock line="90">
          <description>Connection folder.</description>
          <long-description>&lt;p&gt;Set in __construct()&lt;/p&gt;</long-description>
          <tag line="90" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="102" namespace="global" package="Default">
        <name>$options</name>
        <default>NIL</default>
        <docblock line="97">
          <description>Connection options.</description>
          <long-description>&lt;p&gt;Set in __construct()&lt;/p&gt;</long-description>
          <tag line="97" name="var" description="" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="112" namespace="global" package="Default">
        <name>$filter</name>
        <default>array()</default>
        <docblock line="104">
          <description>Filter array.</description>
          <long-description>&lt;p&gt;Set to defaults upon __construct()&lt;/p&gt;

&lt;p&gt;Holds the variables needed to filter through a result set and return
the desired types of messages and in a particular order.&lt;/p&gt;</long-description>
          <tag line="104" name="var" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="119" namespace="global" package="Default">
        <name>$mail</name>
        <default>array()</default>
        <docblock line="114">
          <description>An array of all the Imap_Messages returned from a get() call</description>
          <long-description></long-description>
          <tag line="114" name="var" description="Imap_Message objects" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="126" namespace="global" package="Default">
        <name>$purge</name>
        <default>true</default>
        <docblock line="121">
          <description>Purge/Expunge deleted message on __destruct()</description>
          <long-description></long-description>
          <tag line="121" name="var" description="TRUE by default;" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="136" namespace="global" package="Default">
        <name>$info</name>
        <default></default>
        <docblock line="128">
          <description>Mailbox general info</description>
          <long-description>&lt;p&gt;Mailbox info contains information on the number of messages in the folder
and the number of unread messages, etc.&lt;/p&gt;</long-description>
          <tag line="128" name="var" description="" type="\StdClass">
            <type by_reference="false">\StdClass</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="154" package="Imap">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="138">
          <description>Opens a connection to an IMAP mailbox</description>
          <long-description>&lt;p&gt;Params are passed as an array when calling.  Possible $params keys are:
'host'
'port'
'ssl'
'folder'
'username'
'password'
'options'&lt;/p&gt;

&lt;p&gt;A parameter key not set will use the defaults from the class properties.&lt;/p&gt;</long-description>
          <tag line="138" name="param" description="" type="array" variable="$params">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="154">
          <name>$params</name>
          <default></default>
          <type>array</type>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="173" package="Imap">
        <name>__destruct</name>
        <full_name>__destruct</full_name>
        <docblock line="170">
          <description>Closes the connection and purges/expunges deleted messages if set</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="185" package="Imap">
        <name>__set</name>
        <full_name>__set</full_name>
        <docblock line="179">
          <description>Sets a variable to a value in the class</description>
          <long-description></long-description>
          <tag line="179" name="param" description="" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="179" name="param" description="" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="185">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
        <argument line="185">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="196" package="Imap">
        <name>__isset</name>
        <full_name>__isset</full_name>
        <docblock line="190">
          <description>Checks if variable is set in the class</description>
          <long-description></long-description>
          <tag line="190" name="param" description="" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="190" name="return" description="" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="196">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="205" package="Imap">
        <name>purgeOnExit</name>
        <full_name>purgeOnExit</full_name>
        <docblock line="200">
          <description>Indicates where to purge deleted items on __destruct()</description>
          <long-description></long-description>
          <tag line="200" name="param" description="Default is true" type="bool" variable="$bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
        <argument line="205">
          <name>$bool</name>
          <default>true</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="214" package="Imap">
        <name>get</name>
        <full_name>get</full_name>
        <docblock line="209">
          <description>Retrieves all messages based on filter set</description>
          <long-description></long-description>
          <tag line="209" name="return" description="Messages are Imap_Messages" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="231" package="Imap">
        <name>getCriteria</name>
        <full_name>getCriteria</full_name>
        <docblock line="226">
          <description>Creates a criteria string for searching through messages</description>
          <long-description>&lt;p&gt;Data is from the filter array and can be set using functions or manually&lt;/p&gt;</long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="251" package="Imap">
        <name>doSearch</name>
        <full_name>doSearch</full_name>
        <docblock line="246">
          <description>Called from get() and does a search based on criteria, no sorting needed</description>
          <long-description></long-description>
          <tag line="246" name="return" description="$results Array of message ids" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="261" package="Imap">
        <name>doSort</name>
        <full_name>doSort</full_name>
        <docblock line="256">
          <description>Called from get().</description>
          <long-description>&lt;p&gt;Does sort and search based on criteria in filter&lt;/p&gt;</long-description>
          <tag line="256" name="return" description="$results Array of message ids" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="276" package="Imap">
        <name>getLimited</name>
        <full_name>getLimited</full_name>
        <docblock line="270">
          <description>Returns a spliced array based on the limits set</description>
          <long-description></long-description>
          <tag line="270" name="param" description="Array of message ids" type="array" variable="$results">
            <type by_reference="false">array</type>
          </tag>
          <tag line="270" name="return" description="$results Array of message ids" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
        <argument line="276">
          <name>$results</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="286" package="Imap">
        <name>unread</name>
        <full_name>unread</full_name>
        <docblock line="281">
          <description>Sets filter to only pull unread messages</description>
          <long-description></long-description>
          <tag line="281" name="return" description="For method chaining" type="\Imap">
            <type by_reference="false">\Imap</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="303" package="Imap">
        <name>where</name>
        <full_name>where</full_name>
        <docblock line="291">
          <description>Sets search criteria.</description>
          <long-description>&lt;p&gt;Searchable fields are listed in possibleCriteria().  Array must be
structured as below:
where(array('subject'=&gt;'My subject*'))&lt;/p&gt;</long-description>
          <tag line="291" name="see" description="\global\Imap::possibleCriteria()" refers="\global\Imap::possibleCriteria()"/>
          <tag line="291" name="link" description="6.4.4 deals with searching" link="http://www.faqs.org/rfcs/rfc2060.html"/>
          <tag line="291" name="param" description="" type="\type" variable="$array">
            <type by_reference="false">\type</type>
          </tag>
          <tag line="291" name="return" description="For method chaining" type="\Imap">
            <type by_reference="false">\Imap</type>
          </tag>
        </docblock>
        <argument line="303">
          <name>$array</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="317" package="Imap">
        <name>limit</name>
        <full_name>limit</full_name>
        <docblock line="308">
          <description>Sets the limit you want.</description>
          <long-description>&lt;p&gt;Emails start with 1, not 0.&lt;/p&gt;</long-description>
          <tag line="308" name="param" description="" type="int" variable="$start">
            <type by_reference="false">int</type>
          </tag>
          <tag line="308" name="param" description="If not set, will return everything after initial email" type="int" variable="$count">
            <type by_reference="false">int</type>
          </tag>
          <tag line="308" name="return" description="For method chaining" type="\Imap">
            <type by_reference="false">\Imap</type>
          </tag>
        </docblock>
        <argument line="317">
          <name>$start</name>
          <default></default>
          <type/>
        </argument>
        <argument line="317">
          <name>$count</name>
          <default>null</default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="332" package="Imap">
        <name>sort</name>
        <full_name>sort</full_name>
        <docblock line="322">
          <description>Sets sort by filter.</description>
          <long-description>&lt;p&gt;Sortable fields are listed in possibleSort().&lt;/p&gt;</long-description>
          <tag line="322" name="see" description="\global\Imap::possibleSort()" refers="\global\Imap::possibleSort()"/>
          <tag line="322" name="param" description="" type="string" variable="$field">
            <type by_reference="false">string</type>
          </tag>
          <tag line="322" name="param" description="Like MySQL ('ASC', 'DESC')" type="string" variable="$dir">
            <type by_reference="false">string</type>
          </tag>
          <tag line="322" name="return" description="For method chaining" type="\Imap">
            <type by_reference="false">\Imap</type>
          </tag>
        </docblock>
        <argument line="332">
          <name>$field</name>
          <default></default>
          <type/>
        </argument>
        <argument line="332">
          <name>$dir</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="342" package="Imap">
        <name>possibleCriteria</name>
        <full_name>possibleCriteria</full_name>
        <docblock line="337">
          <description>Returns array of valid criteria for searching</description>
          <long-description></long-description>
          <tag line="337" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="376" package="Imap">
        <name>possibleSort</name>
        <full_name>possibleSort</full_name>
        <docblock line="371">
          <description>Returns array of valid criteria for sorting</description>
          <long-description></long-description>
          <tag line="371" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="393" package="Imap">
        <name>possibleReverseSort</name>
        <full_name>possibleReverseSort</full_name>
        <docblock line="388">
          <description>Returns array of valid reverse sort commands</description>
          <long-description></long-description>
          <tag line="388" name="return" description="" type="array">
            <type by_reference="false">array</type>
          </tag>
        </docblock>
      </method>
    </class>
  </file>
  <file path="Imap_Attachment.php" hash="d0479c01a5295807d4a09b854373b92c" package="Default">
    <class final="false" abstract="false" namespace="global" line="16" package="Imap">
      <extends>\Imap_Base</extends>
      <name>Imap_Attachment</name>
      <full_name>\Imap_Attachment</full_name>
      <docblock line="2">
        <description>Imap_Attachment object handles messages attachments from Imap_Message class</description>
        <long-description>&lt;p&gt;Attachment objects are automatically generated when found in the Imap_Message
class in the Imap_Message::getParts() function.  Attachments are identified,
but not downloaded until requested, similar to the Imap_Message class.&lt;/p&gt;</long-description>
        <tag line="2" name="category" description="Email"/>
        <tag line="2" name="package" description="Imap"/>
        <tag line="2" name="author" description="Tim Withers &lt;pyr0t3chnician@gmail.com&gt;"/>
        <tag line="2" name="copyright" description="2012 Tim Withers"/>
        <tag line="2" name="license" description="http://www.php.net/license/3_01.txt  PHP License 3.01"/>
        <tag line="2" name="version" description="1.0"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="23" namespace="global" package="Default">
        <name>$part</name>
        <default></default>
        <docblock line="18">
          <description>Part id of the parent message</description>
          <long-description></long-description>
          <tag line="18" name="var" description="" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="30" namespace="global" package="Default">
        <name>$data</name>
        <default></default>
        <docblock line="25">
          <description>Object containing all the data related to the attachment</description>
          <long-description></long-description>
          <tag line="25" name="var" description="StdClass" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="37" namespace="global" package="Default">
        <name>$content</name>
        <default></default>
        <docblock line="32">
          <description>Content of the attachment.</description>
          <long-description>&lt;p&gt;Not populated until requested.&lt;/p&gt;</long-description>
          <tag line="32" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="44" namespace="global" package="Default">
        <name>$parent</name>
        <default></default>
        <docblock line="39">
          <description>Imap_Message id.</description>
          <long-description>&lt;p&gt;Used in fetching attachment data.&lt;/p&gt;</long-description>
          <tag line="39" name="var" description="" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="private" line="51" namespace="global" package="Default">
        <name>$decodedData</name>
        <default>false</default>
        <docblock line="46">
          <description>Decoded content to echo to browser, or re-encoded as desired.</description>
          <long-description></long-description>
          <tag line="46" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="58" namespace="global" package="Default">
        <name>$attachmentFetched</name>
        <default>false</default>
        <docblock line="53">
          <description>Flag to ensure attachment is not fetched multiple times</description>
          <long-description></long-description>
          <tag line="53" name="var" description="FALSE by default. TRUE after initial loading of attachment." type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="69" package="Imap">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="60">
          <description>Construct populates basic info about the email attachment</description>
          <long-description>&lt;p&gt;Does not fetch the attachment at this point.&lt;/p&gt;</long-description>
          <tag line="60" name="param" description="" type="\id" variable="$parent">
            <type by_reference="false">\id</type>
          </tag>
          <tag line="60" name="param" description="" type="int" variable="$part">
            <type by_reference="false">int</type>
          </tag>
          <tag line="60" name="param" description="" type="object" variable="$data">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
        <argument line="69">
          <name>$parent</name>
          <default></default>
          <type/>
        </argument>
        <argument line="69">
          <name>$part</name>
          <default></default>
          <type/>
        </argument>
        <argument line="69">
          <name>$data</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="84" package="Imap">
        <name>__get</name>
        <full_name>__get</full_name>
        <docblock line="75">
          <description>Magic __get() returns requested data</description>
          <long-description>&lt;p&gt;Connection is fetched from base class.  Fetches attachment when content
or decoded content is requested. Content type can also be fetched.&lt;/p&gt;</long-description>
          <tag line="75" name="param" description="" type="\type" variable="$name">
            <type by_reference="false">\type</type>
          </tag>
          <tag line="75" name="return" description="FALSE if not found, else value of parameter requested" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="84">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="103" package="Imap">
        <name>download</name>
        <full_name>download</full_name>
        <docblock line="98">
          <description>Download the attachment</description>
          <long-description>&lt;p&gt;Modifies header information to output an email attachment.&lt;/p&gt;</long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="123" package="Imap">
        <name>checkFetched</name>
        <full_name>checkFetched</full_name>
        <docblock line="116">
          <description>Lazy loading check to see if attachment has been fetched</description>
          <long-description>&lt;p&gt;Attachment loaded if flag is false&lt;/p&gt;</long-description>
          <tag line="116" name="return" description="" type="null">
            <type by_reference="false">null</type>
          </tag>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="0" code="50007">No page-level DocBlock was found in file Imap_Attachment.php</error>
    </parse_markers>
  </file>
  <file path="Imap_Base.php" hash="3358b71d255a75d8dfd2c0bd9038780a" package="Default">
    <class final="false" abstract="false" namespace="global" line="13" package="Imap">
      <extends/>
      <name>Imap_Base</name>
      <full_name>\Imap_Base</full_name>
      <docblock line="3">
        <description>Base class that other Imap classes extend</description>
        <long-description></long-description>
        <tag line="3" name="category" description="Imap"/>
        <tag line="3" name="package" description="Imap"/>
        <tag line="3" name="author" description="Tim Withers &lt;pyr0t3chnician@gmail.com&gt;"/>
        <tag line="3" name="copyright" description="2012 Tim Withers"/>
        <tag line="3" name="license" description="http://www.php.net/license/3_01.txt  PHP License 3.01"/>
        <tag line="3" name="version" description="1.0"/>
      </docblock>
      <property final="false" static="true" visibility="private" line="22" namespace="global" package="Default">
        <name>$connection</name>
        <default></default>
        <docblock line="15">
          <description>Connection to Imap mailbox</description>
          <long-description>&lt;p&gt;This is set from the Imap class&lt;/p&gt;</long-description>
          <tag line="15" name="static" description="Connection to Imap server"/>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="29" package="Imap">
        <name>setConnection</name>
        <full_name>setConnection</full_name>
        <docblock line="24">
          <description>Sets the connection property</description>
          <long-description></long-description>
          <tag line="24" name="param" description="" type="resource" variable="$con">
            <type by_reference="false">resource</type>
          </tag>
        </docblock>
        <argument line="29">
          <name>$con</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="42" package="Imap">
        <name>getConnection</name>
        <full_name>getConnection</full_name>
        <docblock line="33">
          <description>Returns static connection resource</description>
          <long-description>&lt;p&gt;Since connection is static, all subclasses do not need to reconnect and
there is no need to pass the resource into the child classes from the
main Imap class&lt;/p&gt;</long-description>
          <tag line="33" name="return" description="Connection" type="resource">
            <type by_reference="false">resource</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="55" package="Imap">
        <name>__get</name>
        <full_name>__get</full_name>
        <docblock line="46">
          <description>Base magic method get</description>
          <long-description>&lt;p&gt;Only function is to return the resource connection when requested rather
than using the getConnection() function;&lt;/p&gt;</long-description>
          <tag line="46" name="param" description="" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="46" name="return" description="Connection resource.  FALSE if $name!='connection'" type="resource">
            <type by_reference="false">resource</type>
          </tag>
        </docblock>
        <argument line="55">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="71" package="Imap">
        <name>decode</name>
        <full_name>decode</full_name>
        <docblock line="61">
          <description>Decodes a string based on encoding types.</description>
          <long-description>&lt;p&gt;Types are declared in numeric format in the headers of each part.  Each
part has to be decoded for readability.&lt;/p&gt;</long-description>
          <tag line="61" name="param" description="To be decoded" type="string" variable="$string">
            <type by_reference="false">string</type>
          </tag>
          <tag line="61" name="param" description="" type="int" variable="$type">
            <type by_reference="false">int</type>
          </tag>
          <tag line="61" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="71">
          <name>$string</name>
          <default></default>
          <type/>
        </argument>
        <argument line="71">
          <name>$type</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="97" package="Imap">
        <name>getAttachmentType</name>
        <full_name>getAttachmentType</full_name>
        <docblock line="85">
          <description>Gets a literal version of the content type</description>
          <long-description>&lt;p&gt;Some examples would be:
'application/pdf'
'image/png'
'application/octet-stream'&lt;/p&gt;</long-description>
          <tag line="85" name="param" description="Integer representing 1 of 8 main types" type="int" variable="$type">
            <type by_reference="false">int</type>
          </tag>
          <tag line="85" name="param" description="Specified subtype" type="string" variable="$subtype">
            <type by_reference="false">string</type>
          </tag>
          <tag line="85" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="97">
          <name>$type</name>
          <default></default>
          <type/>
        </argument>
        <argument line="97">
          <name>$subtype</name>
          <default></default>
          <type/>
        </argument>
      </method>
    </class>
    <parse_markers>
      <error line="0" code="50007">No page-level DocBlock was found in file Imap_Base.php</error>
    </parse_markers>
  </file>
  <file path="Imap_Message.php" hash="111142f9acdc2821a1c845521abe32fb" package="Default">
    <class final="false" abstract="false" namespace="global" line="21" package="Imap">
      <extends>\Imap_Base</extends>
      <name>Imap_Message</name>
      <full_name>\Imap_Message</full_name>
      <docblock line="3">
        <description>Imap_Message object handles messages retrieved by Imap class</description>
        <long-description>&lt;p&gt;Message objects are automatically generated.  As with the messages, they are
very basic and lazily populated when you start to use them.  The basic info
is just the message number.  When you try to read the header info, it is
loaded.  The body will be loaded when you try to access the content.
Checking for attachments also loads up the body, but doesn't download the
attachment.  Any attachments found are automatically put into the
Imap_Attachment object.&lt;/p&gt;</long-description>
        <tag line="3" name="category" description="Email"/>
        <tag line="3" name="package" description="Imap"/>
        <tag line="3" name="author" description="Tim Withers &lt;pyr0t3chnician@gmail.com&gt;"/>
        <tag line="3" name="copyright" description="2012 Tim Withers"/>
        <tag line="3" name="license" description="http://www.php.net/license/3_01.txt  PHP License 3.01"/>
        <tag line="3" name="version" description="1.0"/>
      </docblock>
      <property final="false" static="false" visibility="public" line="28" namespace="global" package="Default">
        <name>$header</name>
        <default></default>
        <docblock line="23">
          <description>Header info is stored here</description>
          <long-description></long-description>
          <tag line="23" name="var" description="StdClass" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="35" namespace="global" package="Default">
        <name>$encoding</name>
        <default>'utf-8'</default>
        <docblock line="30">
          <description>Email encoding.</description>
          <long-description>&lt;p&gt;Not useful.&lt;/p&gt;</long-description>
          <tag line="30" name="var" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="42" namespace="global" package="Default">
        <name>$messageNumber</name>
        <default></default>
        <docblock line="37">
          <description>The message number in relation to the inbox.</description>
          <long-description></long-description>
          <tag line="37" name="var" description="" type="int">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="49" namespace="global" package="Default">
        <name>$structure</name>
        <default></default>
        <docblock line="44">
          <description>Email structure.</description>
          <long-description>&lt;p&gt;If multipart, will show the various parts.&lt;/p&gt;</long-description>
          <tag line="44" name="var" description="StdClass" type="object">
            <type by_reference="false">object</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="56" namespace="global" package="Default">
        <name>$plain</name>
        <default>false</default>
        <docblock line="51">
          <description>Plain text content.</description>
          <long-description>&lt;p&gt;Accessible with __get()&lt;/p&gt;</long-description>
          <tag line="51" name="var" description="FALSE by default, string when populated" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="63" namespace="global" package="Default">
        <name>$html</name>
        <default>false</default>
        <docblock line="58">
          <description>HTML content.</description>
          <long-description>&lt;p&gt;Accessible with __get()&lt;/p&gt;</long-description>
          <tag line="58" name="var" description="FALSE by default, string when populated" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="70" namespace="global" package="Default">
        <name>$attachments</name>
        <default>false</default>
        <docblock line="65">
          <description>Attachments array.</description>
          <long-description>&lt;p&gt;Populated with Imap_Attachment objects when fetched&lt;/p&gt;</long-description>
          <tag line="65" name="var" description="FALSE by default, array of objects when populated" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="77" namespace="global" package="Default">
        <name>$headersFetched</name>
        <default>false</default>
        <docblock line="72">
          <description>Flag to ensure headers are not fetched multiple times</description>
          <long-description></long-description>
          <tag line="72" name="var" description="FALSE by default. TRUE after initial loading of headers." type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <property final="false" static="false" visibility="public" line="84" namespace="global" package="Default">
        <name>$partsFetched</name>
        <default>false</default>
        <docblock line="79">
          <description>Flag to ensure email parts are not fetched multiple times</description>
          <long-description></long-description>
          <tag line="79" name="var" description="FALSE by default. TRUE after initial loading of email parts." type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </property>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="91" package="Imap">
        <name>__construct</name>
        <full_name>__construct</full_name>
        <docblock line="86">
          <description>Initially just assigns the message id to the object</description>
          <long-description></long-description>
          <tag line="86" name="param" description="" type="int" variable="$message">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="91">
          <name>$message</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="105" package="Imap">
        <name>__get</name>
        <full_name>__get</full_name>
        <docblock line="95">
          <description>Magic __get function for private variables</description>
          <long-description>&lt;p&gt;Returns the connection from parent class when needed.  Also loads the
header on the first time the header is accessed.  Will load the body as
well when the body is accessed.&lt;/p&gt;</long-description>
          <tag line="95" name="param" description="" type="string" variable="$name">
            <type by_reference="false">string</type>
          </tag>
          <tag line="95" name="return" description="FALSE if not found, otherwise the value of the parameter" type="boolean">
            <type by_reference="false">boolean</type>
          </tag>
        </docblock>
        <argument line="105">
          <name>$name</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="128" package="Imap">
        <name>markRead</name>
        <full_name>markRead</full_name>
        <docblock line="125">
          <description>Marks the email as read</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="135" package="Imap">
        <name>markNotRead</name>
        <full_name>markNotRead</full_name>
        <docblock line="132">
          <description>Marks the email as unread</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="142" package="Imap">
        <name>delete</name>
        <full_name>delete</full_name>
        <docblock line="139">
          <description>Deletes the email.</description>
          <long-description>&lt;p&gt;Does not purge.&lt;/p&gt;</long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="149" package="Imap">
        <name>undelete</name>
        <full_name>undelete</full_name>
        <docblock line="146">
          <description>Undeletes a deleted email that has not yet been purged.</description>
          <long-description></long-description>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="158" package="Imap">
        <name>utf8</name>
        <full_name>utf8</full_name>
        <docblock line="153">
          <description>Sets encoding to UTF-8</description>
          <long-description></long-description>
          <tag line="153" name="return" description="To allow chaining of methods" type="\Imap_Message">
            <type by_reference="false">\Imap_Message</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="169" package="Imap">
        <name>handleBase64</name>
        <full_name>handleBase64</full_name>
        <docblock line="163">
          <description>Decodes Base64 strings in the header fields when fetched.</description>
          <long-description></long-description>
          <tag line="163" name="param" description="" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="163" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="169">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="185" package="Imap">
        <name>handleQuotedPrintable</name>
        <full_name>handleQuotedPrintable</full_name>
        <docblock line="178">
          <description>Decodes QuotedPrintable strings in the header fields when fetched.</description>
          <long-description>&lt;p&gt;NOT TESTED&lt;/p&gt;</long-description>
          <tag line="178" name="param" description="" type="string" variable="$value">
            <type by_reference="false">string</type>
          </tag>
          <tag line="178" name="return" description="" type="string">
            <type by_reference="false">string</type>
          </tag>
        </docblock>
        <argument line="185">
          <name>$value</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="203" package="Imap">
        <name>getParts</name>
        <full_name>getParts</full_name>
        <docblock line="194">
          <description>Retrieves parts of the message.</description>
          <long-description>&lt;p&gt;If a message only has a single part, fetches info and returns.  If email
has multiple parts, loops through parts and parses those parts into the
message and attachments.&lt;/p&gt;</long-description>
          <tag line="194" name="return" description="" type="null">
            <type by_reference="false">null</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="229" package="Imap">
        <name>hasPlain</name>
        <full_name>hasPlain</full_name>
        <docblock line="224">
          <description>Checks if message has a plain text portion</description>
          <long-description></long-description>
          <tag line="224" name="return" description="FALSE if not plain-text found" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="239" package="Imap">
        <name>hasAttachments</name>
        <full_name>hasAttachments</full_name>
        <docblock line="234">
          <description>Checks if message has attachments</description>
          <long-description></long-description>
          <tag line="234" name="return" description="FALSE if no attachments found" type="bool">
            <type by_reference="false">bool</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="public" namespace="global" line="253" package="Imap">
        <name>downloadAttachment</name>
        <full_name>downloadAttachment</full_name>
        <docblock line="244">
          <description>Download a specific attachment</description>
          <long-description>&lt;p&gt;Modifies header information to output an email attachment.  Specify the
part that has the attachment you want, and it will be downloaded. The $id
is the $this-&gt;attachments[$id] of the message.&lt;/p&gt;</long-description>
          <tag line="244" name="param" description="Attachment part id" type="int" variable="$id">
            <type by_reference="false">int</type>
          </tag>
        </docblock>
        <argument line="253">
          <name>$id</name>
          <default></default>
          <type/>
        </argument>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="273" package="Imap">
        <name>checkFetchedHeader</name>
        <full_name>checkFetchedHeader</full_name>
        <docblock line="266">
          <description>Lazy loading check to see if headers loaded</description>
          <long-description>&lt;p&gt;Headers loaded if flag is false&lt;/p&gt;</long-description>
          <tag line="266" name="return" description="" type="null">
            <type by_reference="false">null</type>
          </tag>
        </docblock>
      </method>
      <method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="288" package="Imap">
        <name>checkFetchedParts</name>
        <full_name>checkFetchedParts</full_name>
        <docblock line="281">
          <description>Lazy loading check to see if email parts loaded</description>
          <long-description>&lt;p&gt;Email parts loaded if flag is false&lt;/p&gt;</long-description>
          <tag line="281" name="return" description="" type="null">
            <type by_reference="false">null</type>
          </tag>
        </docblock>
      </method>
    </class>
    <parse_markers>
      <error line="0" code="50007">No page-level DocBlock was found in file Imap_Message.php</error>
    </parse_markers>
  </file>
  <package name="Default" full_name="Default"/>
  <package name="Imap" full_name="Imap"/>
  <namespace name="global" full_name="global"/>
  <marker count="0">todo</marker>
  <marker count="0">fixme</marker>
  <deprecated count="0"/>
</project>