message MDLSITE-1042 added a footer to IM email notifications
[moodle.git] / message / output / email / message_output_email.php
CommitLineData
3b120e46 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
3b120e46 30 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
1d422980 31 * @package
3b120e46 32 */
33require_once($CFG->dirroot.'/message/output/lib.php');
34
35class 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) {
fe561379 41 global $DB, $SITE;
3b120e46 42
6d2e6936
AD
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);
3b120e46 48
6d2e6936
AD
49 if ( !empty($usertoemailaddress)) {
50 $userto->email = $usertoemailaddress;
3b120e46 51 }
6d2e6936 52
fe561379
AD
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
6d2e6936 61 $result = email_to_user($userto, $userfrom,
3b120e46 62 $message->subject, $message->fullmessage,
1560760f 63 $message->fullmessagehtml);
3b120e46 64
fe561379
AD
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?
3b120e46 67 }
68
1d422980 69 /**
3b120e46 70 * Creates necessary fields in the messaging config form.
71 * @param object $mform preferences form class
72 */
1d422980 73 function config_form($preferences){
366e4ec4 74 global $USER;
305a014f 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.')';
366e4ec4 78 }
305a014f 79 return $string;
3b120e46 80 }
81
82 /**
71666cf3 83 * Parses the form submitted data and saves it into preferences array.
3b120e46 84 * @param object $mform preferences form class
1d422980 85 * @param array $preferences preferences array
3b120e46 86 */
d18b1bbd 87 function process_form($form, &$preferences){
3b120e46 88 $preferences['message_processor_email_email'] = $form->email_email;
89 }
90
91 /**
1d422980
PS
92 * Loads the config data from database to put on the form (initial load)
93 * @param array $preferences preferences array
3b120e46 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}