message/output/email/message_output_email.php

   1 <?php
   2
   3 ///////////////////////////////////////////////////////////////////////////
   4 //                                                                       //
   5 // NOTICE OF COPYRIGHT                                                   //
   6 //                                                                       //
   7 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
   8 //          http://moodle.com                                            //
   9 //                                                                       //
  10 // Copyright (C) 1999 onwards  Martin Dougiamas  http://moodle.com       //
  11 //                                                                       //
  12 // This program is free software; you can redistribute it and/or modify  //
  13 // it under the terms of the GNU General Public License as published by  //
  14 // the Free Software Foundation; either version 2 of the License, or     //
  15 // (at your option) any later version.                                   //
  16 //                                                                       //
  17 // This program is distributed in the hope that it will be useful,       //
  18 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
  20 // GNU General Public License for more details:                          //
  21 //                                                                       //
  22 //          http://www.gnu.org/copyleft/gpl.html                         //
  23 //                                                                       //
  24 ///////////////////////////////////////////////////////////////////////////
  25
  26 /**
  27  * Email message processor - send a given message by email
  28  *
  29  * @author Luis Rodrigues
  30  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  31  * @package
  32  */
  33 require_once($CFG->dirroot.'/message/output/lib.php');
  34
  35 class message_output_email extends message_output {
  36     /**
  37      * Processes the message (sends by email).
  38      * @param object $message the message to be sent
  39      */
  40     function send_message($message) {
  41         global $DB, $SITE;
  42
  43         $userto = $DB->get_record('user', array('id' => $message->useridto));
  44         $userfrom = $DB->get_record('user', array('id' => $message->useridfrom));
  45
  46         //check user preference for where user wants email sent
  47         $usertoemailaddress = get_user_preferences('message_processor_email_email', '', $message->useridto);
  48
  49         if ( !empty($usertoemailaddress)) {
  50             $userto->email = $usertoemailaddress;
  51         }
  52
  53         $emailtagline = get_string('emailtagline', 'message', $SITE->shortname);
  54         if (!empty($message->fullmessage)) {
  55             $message->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
  56         }
  57         if (!empty($message->fullmessagehtml)) {
  58             //$message->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
  59         }
  60
  61         $result = email_to_user($userto, $userfrom,
  62             $message->subject, $message->fullmessage,
  63             $message->fullmessagehtml);
  64
  65         return $result===true; //email_to_user() can return true, false or "emailstop"
  66         //return true;//do we want to report an error if email sending fails?
  67     }
  68
  69     /**
  70      * Creates necessary fields in the messaging config form.
  71      * @param object $mform preferences form class
  72      */
  73     function config_form($preferences){
  74         global $USER;
  75         $string = get_string('email').': <input size="30" name="email_email" value="'.$preferences->email_email.'" />';
  76         if (empty($preferences->email_email)) {
  77             $string .= ' ('.get_string('default').': '.$USER->email.')';
  78         }
  79         return $string;
  80     }
  81
  82     /**
  83      * Parses the form submitted data and saves it into preferences array.
  84      * @param object $mform preferences form class
  85      * @param array $preferences preferences array
  86      */
  87     function process_form($form, &$preferences){
  88         $preferences['message_processor_email_email'] = $form->email_email;
  89     }
  90
  91     /**
  92      * Loads the config data from database to put on the form (initial load)
  93      * @param array $preferences preferences array
  94      * @param int $userid the user id
  95      */
  96     function load_data(&$preferences, $userid){
  97         $preferences->email_email = get_user_preferences( 'message_processor_email_email', '', $userid);
  98     }
  99 }