1. sophistry
  2. peeker

Commits

sophistry  committed 58037f6

Added Documentation, Demo file and code, and fixed navigation. Also moving to GitHub.com (https://github.com/sophistry/peeker)

  • Participants
  • Parent commits 45a268f
  • Branches default

Comments (0)

Files changed (10)

File docs/peeker.html

View file
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td><h1>Peeker</h1></td>
-<td id="breadcrumb_right"><a href="#">Right Breadcrumb</a></td>
+<td id="breadcrumb_right"></td>
 </tr>
 </table>
 </div>
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td id="breadcrumb">
-<a href="http://example.com/">Project Home</a> &nbsp;&#8250;&nbsp;
-<a href="#">User Guide Home</a> &nbsp;&#8250;&nbsp;
+<a href="https://github.com/sophistry/peeker">Project Home</a> &nbsp;&#8250;&nbsp;
+<a href="peeker_toc.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
 Peeker Class
 </td>
-<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="example.com/user_guide/" />Search Peeker User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
+
 </tr>
 </table>
 <!-- END BREADCRUMB -->
 
 <div id="footer">
 <p>
-Previous Topic:&nbsp;&nbsp;<a href="#">Previous Class</a>
-&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
+
 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-<a href="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-Next Topic:&nbsp;&nbsp;<a href="#">Next Class</a>
+<a href="peeker_toc.html">User Guide Home</a>
 </p>
-<p>This documentation describes how to use this standalone library with<a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
+<p><a href="https://github.com/sophistry/peeker">Peeker</a> &nbsp;&middot;&nbsp; Copyright &#169; 2009-20xx &nbsp;&middot;&nbsp;</p>
 </div>
 
 </body>

File docs/peeker_body.html

View file
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td><h1>Peeker Body</h1></td>
-<td id="breadcrumb_right"><a href="#">Right Breadcrumb</a></td>
+<td id="breadcrumb_right"></td>
 </tr>
 </table>
 </div>
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td id="breadcrumb">
-<a href="http://example.com/">Project Home</a> &nbsp;&#8250;&nbsp;
-<a href="#">User Guide Home</a> &nbsp;&#8250;&nbsp;
+<a href="https://github.com/sophistry/peeker">Project Home</a> &nbsp;&#8250;&nbsp;
+<a href="peeker_toc.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
 Body Class
 </td>
-<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="example.com/user_guide/" />Search Project User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
+</td>
 </tr>
 </table>
 <!-- END BREADCRUMB -->
 
 <div id="footer">
 <p>
-Previous Topic:&nbsp;&nbsp;<a href="#">Previous Class</a>
-&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
+
 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-<a href="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-Next Topic:&nbsp;&nbsp;<a href="#">Next Class</a>
+<a href="peeker_toc.html">User Guide Home</a>
 </p>
-<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
+<p><a href="https://github.com/sophistry/peeker">Peeker</a> &nbsp;&middot;&nbsp; Copyright &#169; 2009-20xx &nbsp;&middot;&nbsp;</p>
 </div>
 
 </body>

File docs/peeker_connect.html

View file
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td><h1>Peeker Connect</h1></td>
-<td id="breadcrumb_right"><a href="#">Right Breadcrumb</a></td>
+<td id="breadcrumb_right"></td>
 </tr>
 </table>
 </div>
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td id="breadcrumb">
-<a href="http://example.com/">Project Home</a> &nbsp;&#8250;&nbsp;
-<a href="#">User Guide Home</a> &nbsp;&#8250;&nbsp;
+<a href="https://github.com/sophistry/peeker">Project Home</a> &nbsp;&#8250;&nbsp;
+<a href="peeker_toc.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
 Peeker Connect Class
 </td>
-<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="example.com/user_guide/" />Search Peeker User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
 </tr>
 </table>
 <!-- END BREADCRUMB -->
 
 <div id="footer">
 <p>
-Previous Topic:&nbsp;&nbsp;<a href="#">Previous Class</a>
-&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
+
 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-<a href="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-Next Topic:&nbsp;&nbsp;<a href="#">Next Class</a>
+<a href="peeker_toc.html">User Guide Home</a>
 </p>
-<p>This documentation describes how to use this standalone library with <a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
+<p><a href="https://github.com/sophistry/peeker">Peeker</a> &nbsp;&middot;&nbsp; Copyright &#169; 2009-20xx &nbsp;&middot;&nbsp;</p>
 </div>
 
 </body>

File docs/peeker_detector.html

View file
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td><h1>Peeker Detector</h1></td>
-<td id="breadcrumb_right"><a href="#">Right Breadcrumb</a></td>
+<td id="breadcrumb_right"></td>
 </tr>
 </table>
 </div>
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td id="breadcrumb">
-<a href="http://example.com/">Project Home</a> &nbsp;&#8250;&nbsp;
-<a href="#">User Guide Home</a> &nbsp;&#8250;&nbsp;
+<a href="https://github.com/sophistry/peeker">Project Home</a> &nbsp;&#8250;&nbsp;
+<a href="peeker_toc.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
 Detector Class
 </td>
-<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="example.com/user_guide/" />Search Project User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
+</td>
 </tr>
 </table>
 <!-- END BREADCRUMB -->
 
 <div id="footer">
 <p>
-Previous Topic:&nbsp;&nbsp;<a href="#">Previous Class</a>
-&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
+
 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-<a href="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-Next Topic:&nbsp;&nbsp;<a href="#">Next Class</a>
+<a href="peeker_toc.html">User Guide Home</a>
 </p>
-<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
+<p><a href="https://github.com/sophistry/peeker">Peeker</a> &nbsp;&middot;&nbsp; Copyright &#169; 2009-20xx &nbsp;&middot;&nbsp;</p>
 </div>
 
 </body>

File docs/peeker_detector_set.html

View file
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td><h1>Peeker</h1></td>
-<td id="breadcrumb_right"><a href="#">Right Breadcrumb</a></td>
+<td id="breadcrumb_right"></td>
 </tr>
 </table>
 </div>
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td id="breadcrumb">
-<a href="http://example.com/">Project Home</a> &nbsp;&#8250;&nbsp;
-<a href="#">User Guide Home</a> &nbsp;&#8250;&nbsp;
+<a href="https://github.com/sophistry/peeker">Project Home</a> &nbsp;&#8250;&nbsp;
+<a href="peeker_toc.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
 Peeker Class
 </td>
-<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="example.com/user_guide/" />Search Peeker User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
 </tr>
 </table>
 <!-- END BREADCRUMB -->
 
 <div id="footer">
 <p>
-Previous Topic:&nbsp;&nbsp;<a href="#">Previous Class</a>
-&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
+
 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-<a href="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-Next Topic:&nbsp;&nbsp;<a href="#">Next Class</a>
+<a href="peeker_toc.html">User Guide Home</a>
 </p>
-<p>This documentation describes how to use this standalone library with<a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
+<p><a href="https://github.com/sophistry/peeker">Peeker</a> &nbsp;&middot;&nbsp; Copyright &#169; 2009-20xx &nbsp;&middot;&nbsp;</p>
 </div>
 
 </body>

File docs/peeker_file.html

View file
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td><h1>Peeker File</h1></td>
-<td id="breadcrumb_right"><a href="#">Right Breadcrumb</a></td>
+<td id="breadcrumb_right"></td>
 </tr>
 </table>
 </div>
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td id="breadcrumb">
-<a href="http://example.com/">Project Home</a> &nbsp;&#8250;&nbsp;
-<a href="#">User Guide Home</a> &nbsp;&#8250;&nbsp;
+<a href="https://github.com/sophistry/peeker">Project Home</a> &nbsp;&#8250;&nbsp;
+<a href="peeker_toc.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
 File Class
 </td>
-<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="example.com/user_guide/" />Search Project User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
+</td>
 </tr>
 </table>
 <!-- END BREADCRUMB -->
 
 <div id="footer">
 <p>
-Previous Topic:&nbsp;&nbsp;<a href="#">Previous Class</a>
-&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
+
 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-<a href="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-Next Topic:&nbsp;&nbsp;<a href="#">Next Class</a>
+<a href="peeker_toc.html">User Guide Home</a>
 </p>
-<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
+<p><a href="https://github.com/sophistry/peeker">Peeker</a> &nbsp;&middot;&nbsp; Copyright &#169; 2009-20xx &nbsp;&middot;&nbsp;</p>
 </div>
 
 </body>

File docs/peeker_header.html

View file
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td><h1>Peeker Header</h1></td>
-<td id="breadcrumb_right"><a href="#">Right Breadcrumb</a></td>
+<td id="breadcrumb_right"></td>
 </tr>
 </table>
 </div>
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td id="breadcrumb">
-<a href="http://example.com/">Project Home</a> &nbsp;&#8250;&nbsp;
-<a href="#">User Guide Home</a> &nbsp;&#8250;&nbsp;
+<a href="https://github.com/sophistry/peeker">Project Home</a> &nbsp;&#8250;&nbsp;
+<a href="peeker_toc.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
 Header Class
 </td>
-<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="example.com/user_guide/" />Search Project User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
+</td>
 </tr>
 </table>
 <!-- END BREADCRUMB -->
 
 <div id="footer">
 <p>
-Previous Topic:&nbsp;&nbsp;<a href="#">Previous Class</a>
-&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
+
 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-<a href="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-Next Topic:&nbsp;&nbsp;<a href="#">Next Class</a>
+<a href="peeker_toc.html">User Guide Home</a>
 </p>
-<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
+<p><a href="https://github.com/sophistry/peeker">Peeker</a> &nbsp;&middot;&nbsp; Copyright &#169; 2009-20xx &nbsp;&middot;&nbsp;</p>
 </div>
 
 </body>

File docs/peeker_parts.html

View file
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td><h1>Peeker Parts</h1></td>
-<td id="breadcrumb_right"><a href="#">Right Breadcrumb</a></td>
+<td id="breadcrumb_right"></td>
 </tr>
 </table>
 </div>
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td id="breadcrumb">
-<a href="http://example.com/">Project Home</a> &nbsp;&#8250;&nbsp;
-<a href="#">User Guide Home</a> &nbsp;&#8250;&nbsp;
+<a href="https://github.com/sophistry/peeker">Project Home</a> &nbsp;&#8250;&nbsp;
+<a href="peeker_toc.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
 Parts Class
 </td>
-<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="example.com/user_guide/" />Search Project User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
+</td>
 </tr>
 </table>
 <!-- END BREADCRUMB -->
 
 <div id="footer">
 <p>
-Previous Topic:&nbsp;&nbsp;<a href="#">Previous Class</a>
-&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
+
 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-<a href="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-Next Topic:&nbsp;&nbsp;<a href="#">Next Class</a>
+<a href="peeker_toc.html">User Guide Home</a>
 </p>
-<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
+<p><a href="https://github.com/sophistry/peeker">Peeker</a> &nbsp;&middot;&nbsp; Copyright &#169; 2009-20xx &nbsp;&middot;&nbsp;</p>
 </div>
 
 </body>

File docs/peeker_quickstart.html

View file
 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
 <tr>
 <td id="breadcrumb">
-<a href="http://example.com/">Project Home</a> &nbsp;&#8250;&nbsp;
-<a href="#">User Guide Home</a> &nbsp;&#8250;&nbsp;
+<a href="https://github.com/sophistry/peeker">Project Home</a> &nbsp;&#8250;&nbsp;
+<a href="peeker_toc.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
 Quickstart
 </td>
-<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="example.com/user_guide/" />Search Project User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
+</td>
 </tr>
 </table>
 <!-- END BREADCRUMB -->
 <h1>Peeker Quickstart</h1>
 
 <h2>IMAP examples</h2>
-<p>First, make sure your PHP install has the imap extension (run phpinfo() and search for imap). Place all the Peeker files in the application/libraries directory.</p>
-<p>Create a new controller function with this code (change login info to your IMAP login).</p>
+<p>First, make sure your PHP install has the imap extension (run phpinfo() and search for imap).</p>
+<p>Note: this Quick Start assumes you are using Peeker as a <a href="http://codeigniter.com">CodeIgniter</a> library.  If you are using Codeigniter, just place all the Peeker files in the application/libraries directory and load the library using CI's $this->load->library('peeker') method.</p> 
+<p>However, Peeker <em>can</em> work as a standalone set of classes. Just use the PHP "include" command like this: <code>include('peeker.php');</code> and modify the syntax for the examples below to use regular PHP Object Oriented coding.</p> 
+<p>So, instead of <code>$this->load->library('peeker', $config);<br />
+// call a method on the CI peeker object <br />
+$this->peeker->somefunction();</code> just do 
+<code>$peeker = new peeker($config); <br />
+// call method on the regular PHP peeker object <br />
+$peeker->somefunction();
+</code></p>
+<p>First, create a new controller function with this code (change login info to match your IMAP login).</p>
 
 <code>
 	// this shows basic IMAP, no TLS required<br />
 
 <h2>Some Message Object Functions</h2>
 
-<p>This is a selection of Peeker Message Object functions (available in the message object) - it is not a complete listing, but it shows enough to let you get a lot of stuff done.</p>
+<p>This is a selection of Peeker Message Object functions (available in the message object) - it is not a complete listing, but it shows enough to let you get a taste of what's possible. A complete listing is available in the <a href="peeker_header.html">Peeker Header</a>, the <a href="peeker_body.html">Peeker Body</a>, the <a href="peeker_parts.html">Peeker Parts</a>, or the <a href="peeker_file.html">Peeker File</a> documentation.</p>
 
 <p class="important"><strong>Important:</strong>&nbsp; Call the following functions using the message object returned by <dfn>$this->peeker->get_message()</dfn>. In these examples it is called <var>$e</var>.</p>
 
 
 <div id="footer">
 <p>
-Previous Topic:&nbsp;&nbsp;<a href="#">TOC</a>
-&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-<a href="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
-Next Topic:&nbsp;&nbsp;<a href="#">Next</a>
+<a href="peeker_toc.html">User Guide Home</a>
 </p>
-<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
+<p><a href="https://github.com/sophistry/peeker">Peeker</a> &nbsp;&middot;&nbsp; Copyright &#169; 2009-20xx &nbsp;&middot;&nbsp;</p>
 </div>
 
 </body>

File peeker_body.php

View file
 	*/
 	function has_PLAIN_not_HTML()
 	{
-		return $this->PLAIN!='' && $this->HTML == '';
+		return $this->PLAIN != '' && $this->HTML == '';
 	}