plugins/Imap/ImapPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to add a StatusNet Facebook application
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * IMAP plugin to allow StatusNet to grab incoming emails and handle them as new user posts
  36  *
  37  * @category Plugin
  38  * @package  StatusNet
  39  * @author   Craig Andrews <candrews@integralblue.com
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  */
  43 class ImapPlugin extends Plugin
  44 {
  45     public $mailbox;
  46     public $user;
  47     public $password;
  48     public $poll_frequency = 60;
  49
  50     function initialize(){
  51         if(!isset($this->mailbox)){
  52             throw new Exception("must specify a mailbox");
  53         }
  54         if(!isset($this->user)){
  55             throw new Exception("must specify a user");
  56         }
  57         if(!isset($this->password)){
  58             throw new Exception("must specify a password");
  59         }
  60         if(!isset($this->poll_frequency)){
  61             throw new Exception("must specify a poll_frequency");
  62         }
  63
  64         return true;
  65     }
  66
  67     /**
  68      * Load related modules when needed
  69      *
  70      * @param string $cls Name of the class to be loaded
  71      *
  72      * @return boolean hook value; true means continue processing, false means stop.
  73      */
  74     function onAutoload($cls)
  75     {
  76         $dir = dirname(__FILE__);
  77
  78         switch ($cls)
  79         {
  80         case 'ImapManager':
  81         case 'IMAPMailHandler':
  82             include_once $dir . '/'.strtolower($cls).'.php';
  83             return false;
  84         default:
  85             return true;
  86         }
  87     }
  88
  89     function onStartIoManagerClasses(&$classes)
  90     {
  91         $classes[] = new ImapManager($this);
  92     }
  93
  94     function onPluginVersion(&$versions)
  95     {
  96         $versions[] = array('name' => 'IMAP',
  97                             'version' => STATUSNET_VERSION,
  98                             'author' => 'Craig Andrews',
  99                             'homepage' => 'http://status.net/wiki/Plugin:IMAP',
 100                             'rawdescription' =>
 101                             _m('The IMAP plugin allows for StatusNet to check a POP or IMAP mailbox for incoming mail containing user posts.'));
 102         return true;
 103     }
 104 }