1873d1d8c7d4bc648856b39c7bcc12e221594d5b
[moodle.git] / message / output / email / message_output_email.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  * Contains the definiton of the email message processors (sends messages to users via email)
19  *
20  * @package   message_email
21  * @copyright 2008 Luis Rodrigues and Martin Dougiamas
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once($CFG->dirroot.'/message/output/lib.php');
27 /**
28  * The email message processor
29  *
30  * @package   message_email
31  * @copyright 2008 Luis Rodrigues and Martin Dougiamas
32  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
34 class message_output_email extends message_output {
35     /**
36      * Processes the message (sends by email).
37      * @param object $eventdata the event data submitted by the message sender plus $eventdata->savedmessageid
38      */
39     function send_message($eventdata) {
40         global $CFG;
42         if (!empty($CFG->noemailever)) {
43             // hidden setting for development sites, set in config.php if needed
44             debugging('$CFG->noemailever active, no email message sent.', DEBUG_MINIMAL);
45             return true;
46         }
48         // skip any messaging suspended and deleted users
49         if ($eventdata->userto->auth === 'nologin' or $eventdata->userto->suspended or $eventdata->userto->deleted) {
50             return true;
51         }
53         //the user the email is going to
54         $recipient = null;
56         //check if the recipient has a different email address specified in their messaging preferences Vs their user profile
57         $emailmessagingpreference = get_user_preferences('message_processor_email_email', null, $eventdata->userto);
58         $emailmessagingpreference = clean_param($emailmessagingpreference, PARAM_EMAIL);
60         // If the recipient has set an email address in their preferences use that instead of the one in their profile
61         // but only if overriding the notification email address is allowed
62         if (!empty($emailmessagingpreference) && !empty($CFG->messagingallowemailoverride)) {
63             //clone to avoid altering the actual user object
64             $recipient = clone($eventdata->userto);
65             $recipient->email = $emailmessagingpreference;
66         } else {
67             $recipient = $eventdata->userto;
68         }
69         $result = email_to_user($recipient, $eventdata->userfrom, $eventdata->subject, $eventdata->fullmessage, $eventdata->fullmessagehtml);
71         return $result;
72     }
74     /**
75      * Creates necessary fields in the messaging config form.
76      *
77      * @param array $preferences An array of user preferences
78      */
79     function config_form($preferences){
80         global $USER, $OUTPUT, $CFG;
82         if (empty($CFG->messagingallowemailoverride)) {
83             return null;
84         }
86         $inputattributes = array('size'=>'30', 'name'=>'email_email', 'value'=>$preferences->email_email);
87         $string = get_string('email','message_email') . ': ' . html_writer::empty_tag('input', $inputattributes);
89         if (empty($preferences->email_email) && !empty($preferences->userdefaultemail)) {
90             $string .= get_string('ifemailleftempty', 'message_email', $preferences->userdefaultemail);
91         }
93         if (!empty($preferences->email_email) && !validate_email($preferences->email_email)) {
94             $string .= $OUTPUT->container(get_string('invalidemail'), 'error');
95         }
97         return $string;
98     }
100     /**
101      * Parses the submitted form data and saves it into preferences array.
102      *
103      * @param stdClass $form preferences form class
104      * @param array $preferences preferences array
105      */
106     function process_form($form, &$preferences){
107         if (isset($form->email_email)) {
108             $preferences['message_processor_email_email'] = $form->email_email;
109         }
110     }
112     /**
113      * Returns the default message output settings for this output
114      *
115      * @return int The default settings
116      */
117     public function get_default_messaging_settings() {
118         return MESSAGE_PERMITTED + MESSAGE_DEFAULT_LOGGEDIN + MESSAGE_DEFAULT_LOGGEDOFF;
119     }
121     /**
122      * Loads the config data from database to put on the form during initial form display
123      *
124      * @param array $preferences preferences array
125      * @param int $userid the user id
126      */
127     function load_data(&$preferences, $userid){
128         $preferences->email_email = get_user_preferences( 'message_processor_email_email', '', $userid);
129     }
131     /**
132      * Returns true as message can be sent to internal support user.
133      *
134      * @return bool
135      */
136     public function can_send_to_any_users() {
137         return true;
138     }