d10fb8c94a60ab79ee389b49b24c1115c7cd606d
[moodle.git] / admin / tool / messageinbound / classes / task / pickup_task.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * A scheduled task to handle Inbound Message e-mail pickup.
19  *
20  * @package    tool_messageinbound
21  * @copyright  2014 Andrew Nicols
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace tool_messageinbound\task;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * A scheduled task to handle Inbound Message e-mail pickup.
31  *
32  * @copyright  2014 Andrew Nicols
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class pickup_task extends \core\task\scheduled_task {
37     /**
38      * Get a descriptive name for this task (shown to admins).
39      *
40      * @return string
41      */
42     public function get_name() {
43         return get_string('taskpickup', 'tool_messageinbound');
44     }
46     /**
47      * Execute the main Inbound Message pickup task.
48      */
49     public function execute() {
50         $manager = new \tool_messageinbound\manager();
51         return $manager->pickup_messages();
52     }
53 }