Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Testing outgoing mail configuration form
 *
 * @package    core
 * @copyright  2019 Victor Deniz <victor@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace core_admin\form;

defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir.'/formslib.php');

/**
 * Test mail form
 *
 * @package    core
 * @copyright 2019 Victor Deniz <victor@moodle.com>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class testoutgoingmailconf_form extends \moodleform {
    /**
     * Add elements to form
     */
    public function definition() {
        $mform = $this->_form;

        // Recipient.
        $options = ['maxlength' => '100', 'size' => '25', 'autocomplete' => 'email'];
        $mform->addElement('text', 'recipient', get_string('testoutgoingmailconf_toemail', 'admin'), $options);
        $mform->setType('recipient', PARAM_EMAIL);
        $mform->addRule('recipient', get_string('required'), 'required');

> // From user. $buttonarray = array(); > $options = ['maxlength' => '100', 'size' => '25']; $buttonarray[] = $mform->createElement('submit', 'send', get_string('testoutgoingmailconf_sendtest', 'admin')); > $mform->addElement('text', 'from', get_string('testoutgoingmailconf_fromemail', 'admin'), $options); $buttonarray[] = $mform->createElement('cancel'); > $mform->setType('from', PARAM_TEXT); > $mform->addHelpButton('from', 'testoutgoingmailconf_fromemail', 'admin'); $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false); > $mform->closeHeaderBefore('buttonar'); > // Additional subject text. > $options = ['size' => '25']; } > $mform->addElement('text', 'additionalsubject', get_string('testoutgoingmailconf_subjectadditional', 'admin'), $options); } > $mform->setType('additionalsubject', PARAM_TEXT); >
> } > > /** > * Validate Form field, should be a valid email format or a username that matches with a Moodle user. > * > * @param array $data > * @param array $files > * @return array > * @throws \dml_exception|\coding_exception > */ > public function validation($data, $files): array { > $errors = parent::validation($data, $files); > > if (isset($data['from']) && $data['from']) { > $userfrom = \core_user::get_user_by_username($data['from']); > > if (!$userfrom && !validate_email($data['from'])) { > $errors['from'] = get_string('testoutgoingmailconf_fromemail_invalid', 'admin'); > } > } > > return $errors;