2 |
3 | Local eMailTest plugin for Moodle
4 | =================================
5 | 
6 | 
7 | [](https://github.com/michael-milette/moodle-local_mailtest/issues)
8 | [](#contributing)
9 | [](#license)
10 |
11 | # Table of Contents
12 |
13 | - [Basic Overview](#basic-overview)
14 | - [Requirements](#requirements)
15 | - [Download eMail Test for Moodle](#download-email-test-for-moodle)
16 | - [Installation](#installation)
17 | - [Usage](#usage)
18 | - [Updating](#updating)
19 | - [Uninstallation](#uninstallation)
20 | - [Limitations](#limitations)
21 | - [Language Support](#language-support)
22 | - [Frequently Asked Questions (FAQ)](#faq)
23 | - [Contributing](#contributing)
24 | - [Motivation for this plugin](#motivation-for-this-plugin)
25 | - [Further information](#further-information)
26 | - [License](#license)
27 |
28 | # Basic Overview
29 |
30 | The eMailTest module for Moodle allows administrators to test Moodle's email system. A trace of the SMTP dialogue will be displayed if the email message cannot be sent for any reason.
31 |
32 | Once the test email has been sent, you will need to check your email in-box to confirm that the email message was successfully delivered. This plugin will not do that for you.
33 |
34 | [(Back to top)](#table-of-contents)
35 |
36 | # Requirements
37 |
38 | This plugin requires Moodle 2.5+, 3.x+, 4.x+ or 5.x+ from https://moodle.org
39 |
40 | [(Back to top)](#table-of-contents)
41 |
42 | # Download eMail Test for Moodle
43 |
44 | The most recent STABLE release of eMail Test for Moodle is available from:
45 | https://moodle.org/plugins/local_mailtest
46 |
47 | The most development release can be found at:
48 | https://github.com/michael-milette/moodle-local_mailtest
49 |
50 | [(Back to top)](#table-of-contents)
51 |
52 | # Installation
53 |
54 | Install the plugin, like any other plugin, to the following folder:
55 |
56 | /local/mailtest
57 |
58 | See https://docs.moodle.org/en/Installing_plugins for details on installing Moodle plugins.
59 |
60 | There are no special considerations required for updating the plugin.
61 |
62 | [(Back to top)](#table-of-contents)
63 |
64 | # Usage
65 |
66 | There are no configurable settings for this plugin at this time.
67 |
68 | The local_mailtest plugin is designed allow administrators to test Moodle to ensure the email message system is correctly configured.
69 |
70 | Once installed, login as a Moodle administrator and then click:
71 |
72 | Home > Site Administration > Server > eMail Test
73 |
74 | Enter the email address of the recipient where you want to send the message and click the [Send a test message] button.
75 |
76 | If the email message was successfully sent by Moodle, you will see a message that says "Success - The test message was successfully delivered to the SMTP server.". If it fails to send the email, a dialogue between the Moodle and the SMTP server will be displayed.
77 |
78 | [(Back to top)](#table-of-contents)
79 |
80 | # Updating
81 |
82 | There are no special considerations required for updating the plugin.
83 |
84 | The first public BETA version was released on 2015-11-01. This plugin is now considered STABLE.
85 |
86 | For more information on releases since then, see
87 | [CHANGELOG.md](https://github.com/michael-milette/moodle-local_mailtest/blob/master/CHANGELOG.md).
88 |
89 | [(Back to top)](#table-of-contents)
90 |
91 | # Uninstallation
92 |
93 | Uninstalling the plugin by going into the following:
94 |
95 | Home > Administration > Site Administration > Plugins > Manage plugins > eMail Test
96 |
97 | ...and click Uninstall. You may also need to manually delete the following folder:
98 |
99 | /local/mailtest
100 |
101 | [(Back to top)](#table-of-contents)
102 |
103 | # Limitations
104 |
105 | There are no known limitations at this time.
106 |
107 | [(Back to top)](#table-of-contents)
108 |
109 | # Language Support
110 |
111 | This plugin includes support for the English language. Additional languages including French are supported if you've installed one or more additional Moodle language packs.
112 |
113 | If you need a different language that is not yet supported, please feel free to contribute using the Moodle AMOS Translation Toolkit for Moodle at https://lang.moodle.org/
114 |
115 | This plugin has not been tested for right-to-left (RTL) language support. If you want to use this plugin with a RTL language and it doesn't work as-is, feel free to prepare a pull request and submit it to the project page at:
116 |
117 | https://github.com/michael-milette/moodle-local_mailtest
118 |
119 | [(Back to top)](#table-of-contents)
120 |
121 | # FAQ
122 |
123 | ## Frequently Asked Questions
124 |
125 | ### Why do I get a 500 server error when I use eMailTest?
126 |
127 | This plugin has been extensively tested and used on hundreds of sites. If you are getting this error, it is likely that you have a file owner/group permissions issue on your server which needs to be resolved.
128 |
129 | ### Why does it say that Moodle sent the test message successfully yet I did not receive the email?
130 |
131 | This could be due to a number of reasons including but not limited to:
132 |
133 | * Incorrect PHP Mail settings in your php.ini file (if you have not configured Moodle's SMTP settings).
134 | * You may have an anti-virus or firewall blocking email communications.
135 | * The mail server receiving your email may be discarding emails received from your site.
136 | * The test email may be blocked by anti-spam filters. Check your junk mail folder.
137 |
138 | ### How do I find out the correct email settings I should be using?
139 |
140 | Contact your network administrator or your web hosting provider. These are typically the same settings as you would use for an email client but the administrator may need to add special settings to allow emails to be sent from your `support` and `no-reply` email addresses.
141 |
142 | ### Why is the test emails not being sent successfully?
143 |
144 | Your SMTP email settings are incorrect or the mail server is refusing emails coming from your Moodle site. Read the whole communications dialogue that is displayed when you send a test message. It will often provide some hint of where the problem might be.
145 |
146 | ### What is the difference between PHP Mail and Moodle SMTP Mail?
147 |
148 | If you don't configure the mail settings in Moodle, Moodle will hand off the delivery of email to PHP's built-in mail system. Its settings are typically in your server's PHP.INI file. If you do configure the SMTP settings in Moodle, it will attempt to deliver emails directly to the local SMTP server.
149 |
150 | ### How can I use this tool to send emails from other email addresses?
151 |
152 | You can't. This is to prevent the tool from being used to send spam. If you really must, you can temporarily test the email address of one of the following "From" addresses:
153 |
154 | * Your user account
155 | * Support
156 | * No-reply
157 | * Primary admin
158 |
159 | ### My email used to work in Moodle previous to 3.2. After upgrading to Moodle 3.2 or later, why can't my site send emails?
160 |
161 | As of Moodle 3.2, use of the no-reply email address is no longer optional in many cases. You will need to make sure it is now configured correctly. Some mail server may even only permit connections if this is actually a valid email address.
162 |
163 | ### Why do I see a message about cron not having run for at least 24 hours?
164 |
165 | IMPORTANT - See https://docs.moodle.org/en/Cron . If a link is included within the message, clicking it will cause Moodle to try sending queued messages immediately. However, future message will still not be sent automatically. Clicking the link instead of configuring cron will just hide the notice for 24 hours after which it will return until you fix this issue.
166 |
167 | If for some reason you are unable to setup an automated cron job and don't see the link, you can enable the link and allow remote running of the cron job by going to Site administration >Security > Site Policies and unchecking **Cron execution via command line only**. For a little extra security, also set a **Cron password for remote access**.
168 |
169 | ### Why do I see some debugging code in the communications log even though debugging is turned off?
170 |
171 | Moodle does some validation before sending an email and can display some useful information so we've enabled some minimal display of debugging information. Informative lines start with **email_to_user**. You can ignore the line number references that follow the information line.
172 |
173 | ### Regardless of which "from" email address I use, the test email always arrives from the same email address. Why?
174 |
175 | This is likely a setting in your mail server. To confirm which email address was used to send the email, look at the bottom of the status message after you try to send the email. If the test email was successfully delivered, you can also try to reply to the test message and take a look at the To email address. There is no need to actually send the reply.
176 |
177 | ### I am not sure if the problem is with Moodle, my mail server or my firewall. What should I do?
178 |
179 | First, the problem is very unlikely to be Moodle. Moodle is used by organization in virtually every country of the world. If there was a problem, someone would have spoken up by now. That said, it could be your email settings. To find out if it is potentially your Moodle settings or firewall, or if it is you mail server, try setting Moodle up to use Gmail as your email server. If it works, it is very likely your email settings. If it doesn't, you might have a firewall blocking email traffic or your email server is incorrectly configured.
180 |
181 | ### How can I use Gmail to send SMTP emails from Moodle?
182 |
183 | Gmail requires that you create an [App Password](https://support.google.com/mail/answer/185833?hl=en) to send email for Moodle.
184 |
185 | For more details as well as some of the limitations, see the Moodle documentation on [Email Setup Gmail](https://docs.moodle.org/en/Email_setup_gmail).-
186 |
187 | ### All the settings seem to be correct. What else can I try?
188 |
189 | Despite your best efforts, sometimes you will find that a :port Number needs to be added after the address of the SMTP server. Example: smtp.example.com:587
190 |
191 | ### Are there any security considerations?
192 |
193 | Use of this plugin is restricted to Moodle Site Administrators and allows them to submit an email through a restricted web form that only they can access.
194 |
195 | ## Other questions
196 |
197 | Got a burning question that is not covered here? If you still can't find your answer, submit your question in the Moodle forums or open a new issue on Github at:
198 |
199 | https://github.com/michael-milette/moodle-local_mailtest/issues
200 |
201 | [(Back to top)](#table-of-contents)
202 |
203 | # Contributing
204 |
205 | If you are interested in helping, please take a look at our [contributing](https://github.com/michael-milette/moodle-local_mailtest/blob/master/CONTRIBUTING.md) guidelines for details on our code of conduct and the process for submitting pull requests to us.
206 |
207 | ## Contributors
208 |
209 | Michael Milette - Author and Lead Developer
210 |
211 | Big thank you to the following contributors. (Please let me know if I forgot to include you in the list):
212 |
213 | * laurentdavid: Fixed deprecated strings in Moodle 4.4 (2024).
214 |
215 | ## Pending Features
216 |
217 | Let us know if you have any suggestions.
218 |
219 | [(Back to top)](#table-of-contents)
220 |
221 | # Motivation for this plugin
222 |
223 | The development of this plugin was motivated through our own experience in Moodle development and comments in the Moodle support forums and is supported by TNG Consulting Inc.
224 |
225 | [(Back to top)](#table-of-contents)
226 |
227 | # Further information
228 |
229 | For further information regarding the local_mailtest plugin, support or to report a bug, please visit the project page at:
230 |
231 | https://github.com/michael-milette/moodle-local_mailtest
232 |
233 | [(Back to top)](#table-of-contents)
234 |
235 | # License
236 |
237 | Copyright © 2015-2025 TNG Consulting Inc. - https://www.tngconsulting.ca/
238 |
239 | This file is part of MailTest/eMailTest for Moodle - https://moodle.org/
240 |
241 | eMailTest is free software: you can redistribute it and/or modify
242 | it under the terms of the GNU General Public License as published by
243 | the Free Software Foundation, either version 3 of the License, or
244 | (at your option) any later version.
245 |
246 | eMailTest is distributed in the hope that it will be useful,
247 | but WITHOUT ANY WARRANTY; without even the implied warranty of
248 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
249 | GNU General Public License for more details.
250 |
251 | You should have received a copy of the GNU General Public License
252 | along with eMailTest. If not, see ' . get_string('pluginname_help', 'local_mailtest') . '
'); 45 | 46 | // Send method. 47 | 48 | if (empty($CFG->smtphosts)) { 49 | $sendmethod = get_string('phpmethod', 'local_mailtest'); 50 | } else { 51 | $sendmethod = get_string('smtpmethod', 'local_mailtest', $CFG->smtphosts); 52 | } 53 | if ($CFG->branch >= 32) { 54 | $sendmethod .= ' (' . 55 | get_string('change', 'admin') . ')'; 56 | } else { 57 | $sendmethod .= ' (' . 58 | get_string('change', 'admin') . ')'; 59 | } 60 | $mform->addElement('static', 'sendmethod', get_string('sendmethod', 'local_mailtest'), $sendmethod); 61 | 62 | // Sender. 63 | 64 | $senderarray = []; 65 | $a = new stdClass(); 66 | $a->label = get_string('change', 'admin'); 67 | 68 | // Current user's email address. 69 | $a->email = $USER->email; 70 | if ($CFG->branch >= 32) { 71 | $a->url = '../../user/editadvanced.php?course=1#id_email'; 72 | } else { 73 | $a->url = '../../user/editadvanced.php?course=1#fitem_id_email'; 74 | } 75 | $a->type = get_string('youremail', 'local_mailtest'); 76 | $senderarray[] = $mform->createElement('radio', 'sender', '', get_string('from', 'local_mailtest', $a) 77 | . local_mailtest_checkdns(explode('@', $a->email)[1]), $a->email); 78 | if (!validate_email($a->email)) { 79 | $senderarray[] = $mform->CreateElement( 80 | 'static', 81 | 'error', 82 | '', 83 | html_writer::span(get_string('invalidemail'), 'statuswarning') 84 | ); 85 | } 86 | 87 | // Support email address. 88 | $primaryadmin = get_admin(); 89 | $a->email = empty($CFG->supportemail) ? $primaryadmin->email : $CFG->supportemail; 90 | $a->url = '../../admin/settings.php?section=supportcontact'; 91 | $a->type = get_string('supportemail', 'admin'); 92 | $senderarray[] = $mform->createElement('radio', 'sender', '', get_string('from', 'local_mailtest', $a) 93 | . local_mailtest_checkdns(explode('@', $a->email)[1]), $a->email); 94 | if (!validate_email($a->email)) { 95 | $senderarray[] = $mform->CreateElement( 96 | 'static', 97 | 'error', 98 | '', 99 | html_writer::span(get_string('invalidemail'), 'statuswarning') 100 | ); 101 | } 102 | 103 | // No Reply address. 104 | $a->email = empty($CFG->noreplyaddress) ? 'noreply@' . get_host_from_url($CFG->wwwroot) : $CFG->noreplyaddress; 105 | if ($CFG->branch >= 32) { 106 | $a->url = '../../admin/settings.php?section=outgoingmailconfig#admin-noreplyaddress'; 107 | $a->type = get_string('noreplyaddress', 'admin'); 108 | } else { 109 | $a->url = '../../admin/settings.php?section=messagesettingemail#noreplyaddress'; 110 | $a->type = get_string('noreplyaddress', 'message_email'); 111 | } 112 | $senderarray[] = $mform->createElement('radio', 'sender', '', get_string('from', 'local_mailtest', $a) 113 | . local_mailtest_checkdns(explode('@', $a->email)[1]), $a->email); 114 | if (!validate_email($a->email)) { 115 | $senderarray[] = $mform->CreateElement( 116 | 'static', 117 | 'error', 118 | '', 119 | html_writer::span(get_string('invalidemail'), 'statuswarning') 120 | ); 121 | } 122 | 123 | // Primary admin email address. 124 | $primaryadmin = get_admin(); 125 | $a->email = $primaryadmin->email; 126 | $a->url = '../../user/editadvanced.php?id=' . $primaryadmin->id; 127 | $a->type = get_string('primaryadminemail', 'local_mailtest'); 128 | $senderarray[] = $mform->createElement('radio', 'sender', '', get_string('from', 'local_mailtest', $a) 129 | . local_mailtest_checkdns(explode('@', $a->email)[1]), $a->email); 130 | if (!validate_email($a->email)) { 131 | $senderarray[] = $mform->CreateElement( 132 | 'static', 133 | 'error', 134 | '', 135 | html_writer::span(get_string('invalidemail'), 'statuswarning') 136 | ); 137 | } 138 | 139 | // Add group of sender radio buttons to form. 140 | $mform->setDefault('sender', $this->_customdata['fromdefault']); 141 | $mform->addGroup($senderarray, 'senderar', get_string('fromemail', 'local_mailtest'), [''], false); 142 | $mform->setType('sender', PARAM_EMAIL); 143 | $mform->addRule('senderar', get_string('required'), 'required'); 144 | 145 | // Recipient. 146 | 147 | $mform->addElement('text', 'recipient', get_string('toemail', 'local_mailtest'), 'maxlength="100" size="25" '); 148 | $mform->setType('recipient', PARAM_EMAIL); 149 | $mform->addRule('recipient', get_string('required'), 'required'); 150 | 151 | // Divert all emails. 152 | 153 | if (empty($CFG->divertallemailsto)) { 154 | $divertstatus = get_string('functiondisabled'); 155 | } else { 156 | $divertstatus = get_string('divertedto', 'local_mailtest', $CFG->divertallemailsto); 157 | } 158 | if ($CFG->branch >= 310) { 159 | // Only configurable in UI as of Moodle 3.10. 160 | $divertstatus .= ' (' . 161 | get_string('change', 'admin') . ')'; 162 | } 163 | if (!empty($CFG->divertallemailsto)) { 164 | $divertstatus .= local_mailtest_checkdns(explode('@', $CFG->divertallemailsto)[1]); 165 | } 166 | $mform->addElement('static', 'divertemails', get_string('divertallemails', 'local_mailtest'), $divertstatus); 167 | 168 | // Always show communications log - even on success. 169 | 170 | $mform->addElement('checkbox', 'alwaysshowlog', '', get_string('alwaysshowlog', 'local_mailtest')); 171 | $mform->setDefault('alwaysshowlog', ($CFG->debugdisplay && isset($CFG->debugsmtp) && $CFG->debugsmtp)); 172 | 173 | // Buttons. 174 | 175 | if ($disabled = !empty($CFG->noemailever)) { 176 | $mform->addElement( 177 | 'static', 178 | 'noemailever', 179 | html_writer::div(get_string('messagingdisable', 'error'), 'alert alert-danger'), 180 | html_writer::div(get_string('noemaileverset', 'message_airnotifier'), 'alert alert-danger') 181 | ); 182 | } 183 | $buttonarray = []; 184 | if (!$disabled) { 185 | $buttonarray[] = $mform->createElement('submit', 'send', get_string('sendtest', 'local_mailtest')); 186 | } 187 | $buttonarray[] = $mform->createElement('cancel'); 188 | 189 | $mform->addGroup($buttonarray, 'buttonar', '', [' '], false); 190 | $mform->closeHeaderBefore('buttonar'); 191 | } 192 | 193 | /** 194 | * Validate submitted form data, recipient in this case, and returns list of errors if it fails. 195 | * 196 | * @param array $data The data fields submitted from the form. 197 | * @param array $files Files submitted from the form (not used) 198 | * 199 | * @return array List of errors to be displayed on the form if validation fails. 200 | */ 201 | public function validation($data, $files) { 202 | $errors = parent::validation($data, $files); 203 | 204 | if (empty($data['recipient'])) { 205 | $errors['recipient'] = get_string('err_email', 'form'); 206 | } 207 | 208 | return $errors; 209 | } 210 | } 211 | -------------------------------------------------------------------------------- /classes/privacy/provider.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Privacy Subsystem implementation for local_mailtest. 19 | * 20 | * @package local_mailtest 21 | * @copyright 2015-2025 TNG Consulting Inc. - www.tngcosulting.ca 22 | * @author Michael Milette 23 | * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | namespace local_mailtest\privacy; 27 | 28 | /** 29 | * Privacy Subsystem for local_mailtest implementing null_provider. 30 | * 31 | * @copyright 2018 TNG Consulting Inc.
' . get_string('warning') . '
'; 141 | $msg .= $cronwarning; 142 | $msg .= '' . get_string('cron_help', 'admin'); 143 | if (!empty($CFG->branch)) { 144 | $icon = $OUTPUT->pix_icon('help', get_string('moreinfo')); 145 | $link = $CFG->docroot . '/' . $CFG->branch . '/' . substr(current_language(), 0, 2) . '/Cron'; 146 | $msg .= html_writer::link($link, $icon, ['class' => 'helplink', 'target' => '_blank', 'rel' => 'external']); 147 | } 148 | $msg .= '
'; 149 | $msg .= ''; 151 | local_mailtest_msgbox($msg, null, 3, 'alert alert-danger alert-block alert-dismissible fade show'); 152 | } 153 | 154 | // Display the form. ============================================. 155 | 156 | $form->display(); 157 | } else { 158 | // Send test email. 159 | if (!isset($data->sender)) { 160 | $data->sender = $CFG->noreplyaddress; 161 | } 162 | $fromemail = local_mailtest_generate_email_user($data->sender); 163 | 164 | if ($CFG->branch >= 26) { 165 | $toemail = core_text::strtolower($data->recipient); 166 | } else { 167 | $toemail = textlib::strtolower($data->recipient); 168 | } 169 | if ($toemail !== clean_param($toemail, PARAM_EMAIL)) { 170 | local_mailtest_msgbox(get_string('invalidemail'), get_string('error'), 2, 'errorbox', $url->out()); 171 | } 172 | $toemail = local_mailtest_generate_email_user($toemail, ''); 173 | if (email_should_be_diverted($toemail->email)) { 174 | $toemail->email = $toemail->email . ' (' . 175 | get_string('divertedto', 'local_' . $pluginname, $CFG->divertallemailsto) . ')'; 176 | } 177 | 178 | $subject = format_string($SITE->fullname, true, ['escape' => false]); 179 | 180 | // Add some system information. 181 | $a = new stdClass(); 182 | if (isloggedin()) { 183 | $a->regstatus = get_string('registered', 'local_' . $pluginname, $USER->username); 184 | } else { 185 | $a->regstatus = get_string('notregistered', 'local_' . $pluginname); 186 | } 187 | $a->lang = current_language(); 188 | $a->browser = $_SERVER['HTTP_USER_AGENT']; 189 | $a->referer = $_SERVER['HTTP_REFERER']; 190 | $a->release = $CFG->release; 191 | $a->ip = local_mailtest_getuserip(); 192 | $messagehtml = get_string('message', 'local_' . $pluginname, $a); 193 | $messagetext = html_to_text($messagehtml); 194 | 195 | if ($CFG->branch >= 404) { 196 | $fromsender = get_string('fromsender'); 197 | $torecipient = get_string('torecipient'); 198 | } else { 199 | $fromsender = get_string('from'); 200 | $torecipient = get_string('to'); 201 | } 202 | 203 | ob_end_flush(); 204 | ob_implicit_flush(true); 205 | echo '' . get_string('testing', 'local_' . $pluginname) . '
'; 206 | echo '' . $fromsender . ' : ' . $fromemail->email . '
207 | 🡇 🡇 🡇
208 | ' . get_string('server', 'local_' . $pluginname, (empty($CFG->smtphosts) ? 'PHPMailer' : $CFG->smtphosts)) . '
209 | 🡇 🡇 🡇
210 | ' . $torecipient . ' : ' . $toemail->email . '
mail.log : ' . get_string('winsyslog', 'local_' . $pluginname) . '';
230 | } else {
231 | $smtplog .= 'mail.log : ' . $phplog . ''; 232 | } 233 | } 234 | } else { 235 | ob_start(); 236 | $success = email_to_user($toemail, $fromemail, $subject, $messagetext, $messagehtml, '', '', true, $fromemail->email); 237 | $smtplog = ob_get_contents(); 238 | ob_end_clean(); 239 | $smtplog = '
'; 249 | if (empty($CFG->smtphosts)) { 250 | $msg .= get_string('sentmailphp', 'local_' . $pluginname); 251 | } else { 252 | $msg .= get_string('sentmail', 'local_' . $pluginname); 253 | } 254 | 255 | // Display a list of common reasons the email may not have been delivered. 256 | if (empty($CFG->smtphosts)) { 257 | $extrainfo = '
' . get_string('connectionlog', 'local_' . $pluginname) . '
' . $smtplog; 363 | 364 | $continuelink = ($CFG->branch >= 32) ? 'outgoingmailconfig' : 'messagesettingemail'; 365 | $msg = get_string($errtype, 'local_' . $pluginname, '../../admin/settings.php?section=' . $continuelink); 366 | 367 | // Display diagnostic information, if available. 368 | if (!empty($issues)) { 369 | $title = get_string('additionalinfo', 'local_' . $pluginname); 370 | $msg .= '' . $title . '
- ' . $issues . '
-
44 |
- Ensure that the TO email address is correct. 45 |
- Check the recipients spam/junk mail. 46 |
- Check the recipients mailbox to make sure it is not full. 47 |
- Check the mailbox of your no-reply email address to see if the message bounced (was not delivered) for any reason. 48 |
- Check that your email content is not being flagged as spam/junk by any filter on your mail server or on the recipient\'s mail server. 49 |
- Make sure that the IP address of your mail server is not blacklisted by any mail providers. 50 | {$a} 51 |
Moodle could not communicate with your mail server.
Recommendations:
Start by checking your Moodle SMTP mail settings.
If they look correct, check your SMTP Server and/or firewall settings to ensure that they are configured to accept SMTP connections from your Moodle web server and your no-reply email address. For more help, see the FAQ section in the documentation.
'; 71 | $string['errorsend'] = 'The test email message could not be delivered to the mail server.
Recommendations:
Check your Moodle Email settings. For more help, see the FAQ section in the documentation. You may also wish to reference the list of SMTP codes in RFC 5321 and RFC 4954.
'; 72 | $string['errorunknown'] = 'An undiagnosed error occured.
Recommendations:
Refer to the communications log below. You may find it useful to reference the list of SMTP codes in RFC 5321 and RFC 4954.
'; 73 | $string['failaccessdenied'] = 'This is a test message. Please disregard.
89 |If you received this email, it means that you have successfully configured your Moodle site\'s email settings.
90 |Additional User Information
91 |-
92 |
- Registration status : {$a->regstatus} 93 |
- Preferred language : {$a->lang} 94 |
- User\'s web browser : {$a->browser} 95 |
- Message submitted from : {$a->referer} 96 |
- Moodle version : {$a->release} 97 |
- User\'s IP address : {$a->ip} 98 |
Email on this site has been disabled by way of $CFG->noemailever = true;.
'; 100 | $string['nologavailable'] = 'Logging is not available when using PHP mail() function. However, may find logs on your server. Most common locations on Linux include:
101 |-
102 |
- /var/log/maillog 103 |
- /var/log/mail.log 104 |
- /var/adm/maillog 105 |
- /var/adm/syslog/mail.log 106 |
Alernatively, a custom location may be specified using the mail.log setting in php.ini.
'; 108 | $string['notregistered'] = 'Not registered or not logged in.'; 109 | $string['phpmethod'] = 'PHP default method'; 110 | $string['pluginname'] = 'eMail Test'; 111 | $string['pluginname_help'] = 'eMail Test will verify the email settings for this Moodle site by sending a test email message to the address you specify. For Site Administrators only.'; 112 | $string['primaryadminemail'] = 'Primary admin email'; 113 | $string['privacy:metadata'] = 'The eMail Test plugin does not store any personal data about any user.'; 114 | $string['registered'] = 'Registered user ({$a}).'; 115 | $string['sendmethod'] = 'Email send method'; 116 | $string['sendtest'] = 'Send a test message'; 117 | $string['sentmail'] = 'Moodle successfully delivered the test message to the SMTP mail server.'; 118 | $string['sentmailphp'] = 'The Moodle test message was successfully accepted by PHP Mail.'; 119 | $string['server'] = 'Server: {$a}'; 120 | $string['smtpmethod'] = 'SMTP hosts: {$a}'; 121 | $string['spfinvalidrecord'] = 'SPF record must contains at least one mechanism.'; 122 | $string['spfnorecordfound'] = 'SPF record is missing.'; 123 | $string['spfrecordfound'] = 'SPF record found.'; 124 | $string['spfvalidrecord'] = 'SPF record format is valid.'; 125 | $string['testing'] = 'Testing email configuration'; 126 | $string['toemail'] = 'To email address'; 127 | $string['winsyslog'] = 'Event Log on Windows'; 128 | $string['youremail'] = 'Your email address'; 129 | -------------------------------------------------------------------------------- /locallib.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Library of functions for MailTest. 19 | * 20 | * @package local_mailtest 21 | * @copyright 2015-2025 TNG Consulting Inc. - www.tngconsulting.ca 22 | * @author Michael Milette 23 | * @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | /** 27 | * Generate a user info object based on provided parameters. 28 | * 29 | * @param string $email plain text email address. 30 | * @param string $name (optional) plain text real name. 31 | * @param int $id (optional) user ID 32 | * 33 | * @return object user info. 34 | */ 35 | function local_mailtest_generate_email_user($email, $name = '', $id = -99) { 36 | $emailuser = new stdClass(); 37 | $emailuser->email = trim(filter_var($email, FILTER_SANITIZE_EMAIL)); 38 | if (!filter_var($email, FILTER_VALIDATE_EMAIL)) { 39 | $emailuser->email = ''; 40 | } 41 | $name = format_text($name, FORMAT_HTML, ['trusted' => false, 'noclean' => false]); 42 | $emailuser->firstname = trim(htmlspecialchars($name, ENT_COMPAT)); 43 | $emailuser->lastname = ''; 44 | $emailuser->maildisplay = true; 45 | $emailuser->mailformat = 1; // 0 (zero) text-only emails, 1 (one) for HTML emails. 46 | $emailuser->id = $id; 47 | $emailuser->firstnamephonetic = ''; 48 | $emailuser->lastnamephonetic = ''; 49 | $emailuser->middlename = ''; 50 | $emailuser->alternatename = ''; 51 | return $emailuser; 52 | } 53 | 54 | /** 55 | * Outputs a message box. 56 | * 57 | * @param string $text The text of the message. 58 | * @param string $heading (optional) The text of the heading. 59 | * @param int $level (optional) The level of importance of the 60 | * heading. Default: 2. 61 | * @param string $classes (optional) A space-separated list of CSS 62 | * classes. 63 | * @param string $link (optional) The link where you want the Continue 64 | * button to take the user. Only displays the 65 | * continue button if the link URL was specified. 66 | * @param string $id (optional) An optional ID. Is applied to body 67 | * instead of heading if no heading. 68 | */ 69 | function local_mailtest_msgbox($text, $heading = null, $level = 2, $classes = null, $link = null, $id = null) { 70 | global $OUTPUT; 71 | echo $OUTPUT->box_start(trim('box ' . $classes)); 72 | if (!is_null($heading)) { 73 | echo $OUTPUT->heading($heading, $level, $id); 74 | echo "$text
" . PHP_EOL;
75 | } else {
76 | echo "$text
" . PHP_EOL;
77 | }
78 | if (!is_null($link)) {
79 | echo $OUTPUT->continue_button($link);
80 | }
81 | echo $OUTPUT->box_end();
82 | }
83 |
84 | /**
85 | * Get the user's public or private IP address.
86 | *
87 | * @return string Public IP address or the private IP address if the public address cannot be identified.
88 | */
89 | function local_mailtest_getuserip() {
90 | $fieldlist = [
91 | 'HTTP_CLIENT_IP',
92 | 'HTTP_X_FORWARDED_FOR',
93 | 'HTTP_X_FORWARDED',
94 | 'HTTP_FORWARDED_FOR',
95 | 'HTTP_FORWARDED',
96 | 'REMOTE_ADDR',
97 | 'HTTP_CF_CONNECTING_IP',
98 | 'HTTP_X_CLUSTER_CLIENT_IP',
99 | ];
100 |
101 | // Public range first.
102 | $filterlist = [
103 | FILTER_FLAG_IPV4 | FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE,
104 | FILTER_FLAG_IPV6 | FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE,
105 | ];
106 |
107 | foreach ($filterlist as $filter) {
108 | foreach ($fieldlist as $field) {
109 | if (!array_key_exists($field, $_SERVER) || empty($_SERVER[$field])) {
110 | continue;
111 | }
112 |
113 | $iplist = explode(',', $_SERVER[$field]);
114 | foreach ($iplist as $ip) {
115 | // Strips off port number if it exists.
116 | if (substr_count($ip, ':') == 1) {
117 | // IPv4 with a port.
118 | $ip = explode(':', $ip)[0];
119 | } else if ($start = (substr($ip, 0, 1) == '[') && $end = strpos($ip, ']:') !== false) {
120 | // IPv6 with a port.
121 | $ip = substr($ip, $start + 1, $end - 2);
122 | }
123 | // Sanitize so that we only get public addresses.
124 | $lastip = $ip; // But save other address just in case.
125 | $ip = filter_var(trim($ip), FILTER_VALIDATE_IP, $filter);
126 | if ($ip !== false) {
127 | return($ip);
128 | }
129 | }
130 | }
131 | }
132 | // Private or restricted range.
133 | return $lastip;
134 | }
135 |
136 | /**
137 | * Check DNS records for a given domain.
138 | *
139 | * This function checks the DKIM, SPF, DMARC, and BIMI records for a given domain.
140 | * It returns an array with a success flag and a message string.
141 | *
142 | * @param string $domain The domain to check DNS records for.
143 | * @return string Message string.
144 | */
145 | function local_mailtest_checkdns($domain) {
146 | global $CFG;
147 |
148 | $message = '';
149 | $success = true;
150 |
151 | $xmark = ' ';
152 | $checkmark = ' ';
153 | $exclamation = ' ';
154 |
155 | // Check SPF records.
156 |
157 | $regex = '/^v=spf1( +([-+?~]?(all|include:(%\{[CDHILOPR-Tcdhilopr-t]'
158 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}|%%|%_|%-|[!-$&-~])*(\.([A-Za-z]'
159 | . '|[A-Za-z]([-0-9A-Za-z]?)*[0-9A-Za-z])|%\{[CDHILOPR-Tcdhilopr-t]'
160 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\})|a(:(%\{[CDHILOPR-Tcdhilopr-t]'
161 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}|%%|%_|%-|[!-$&-~])*(\.([A-Za-z]'
162 | . '|[A-Za-z]([-0-9A-Za-z]?)*[0-9A-Za-z])|%\{[CDHILOPR-Tcdhilopr-t]'
163 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}))?((\/(\d|1\d|2\d|3[0-2]))?(\/\/'
164 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8]))?)?|mx(:(%\{[CDHILOPR-Tcdhilopr-t]'
165 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}|%%|%_|%-|[!-$&-~])*(\.([A-Za-z]'
166 | . '|[A-Za-z]([-0-9A-Za-z]?)*[0-9A-Za-z])|%\{[CDHILOPR-Tcdhilopr-t]'
167 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}))?((\/(\d|1\d|2\d|3[0-2]))?'
168 | . '(\/\/([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8]))?)?|ptr(:(%\{[CDHILOPR-Tcdhilopr-t]'
169 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}|%%|%_|%-|[!-$&-~])*(\.([A-Za-z]'
170 | . '|[A-Za-z]([-0-9A-Za-z]?)*[0-9A-Za-z])|%\{[CDHILOPR-Tcdhilopr-t]'
171 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}))?|ip4:([0-9]|[1-9][0-9]|1[0-9]{2}'
172 | . '|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]'
173 | . '|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]'
174 | . '|25[0-5])(\/([0-9]|1[0-9]|2[0-9]|3[0-2]))?|ip6:(::|([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|'
175 | . '([0-9A-Fa-f]{1,4}:){1,8}:|([0-9A-Fa-f]{1,4}:){7}:[0-9A-Fa-f]{1,4}|([0-9A-Fa-f]{1,4}:){6}(:'
176 | . '[0-9A-Fa-f]{1,4}){1,2}|([0-9A-Fa-f]{1,4}:){5}(:[0-9A-Fa-f]{1,4}){1,3}|([0-9A-Fa-f]{1,4}:){4}'
177 | . '(:[0-9A-Fa-f]{1,4}){1,4}|([0-9A-Fa-f]{1,4}:){3}(:[0-9A-Fa-f]{1,4}){1,5}|([0-9A-Fa-f]{1,4}:){2}'
178 | . '(:[0-9A-Fa-f]{1,4}){1,6}|[0-9A-Fa-f]{1,4}:(:[0-9A-Fa-f]{1,4}){1,7}|:(:[0-9A-Fa-f]{1,4}){1,8}|'
179 | . '([0-9A-Fa-f]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|'
180 | . '[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]'
181 | . '|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])|([0-9A-Fa-f]{1,4}:){6}:'
182 | . '([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}'
183 | . '|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]'
184 | . '|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])|([0-9A-Fa-f]{1,4}:){5}:([0-9A-Fa-f]{1,4}:)?'
185 | . '([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]'
186 | . '|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}'
187 | . '|2[0-4][0-9]|25[0-5])|([0-9A-Fa-f]{1,4}:){4}:([0-9A-Fa-f]{1,4}:){0,2}([0-9]|[1-9][0-9]'
188 | . '|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])'
189 | . '\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}'
190 | . '|2[0-4][0-9]|25[0-5])|([0-9A-Fa-f]{1,4}:){3}:([0-9A-Fa-f]{1,4}:){0,3}([0-9]|[1-9][0-9]'
191 | . '|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])'
192 | . '\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}'
193 | . '|2[0-4][0-9]|25[0-5])|([0-9A-Fa-f]{1,4}:){2}:([0-9A-Fa-f]{1,4}:){0,4}([0-9]|[1-9][0-9]'
194 | . '|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])'
195 | . '\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}'
196 | . '|2[0-4][0-9]|25[0-5])|[0-9A-Fa-f]{1,4}::([0-9A-Fa-f]{1,4}:){0,5}([0-9]|[1-9][0-9]'
197 | . '|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])'
198 | . '\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}'
199 | . '|2[0-4][0-9]|25[0-5])|::([0-9A-Fa-f]{1,4}:){0,6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]'
200 | . '|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]'
201 | . '|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))'
202 | . '(\/(\d{1,2}|10[0-9]|11[0-9]|12[0-8]))?|exists:(%\{[CDHILOPR-Tcdhilopr-t]'
203 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}|%%|%_|%-|[!-$&-~])*(\.([A-Za-z]'
204 | . '|[A-Za-z]([-0-9A-Za-z]?)*[0-9A-Za-z])|%\{[CDHILOPR-Tcdhilopr-t]'
205 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}))|redirect=(%\{[CDHILOPR-Tcdhilopr-t]'
206 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}|%%|%_|%-|[!-$&-~])*(\.([A-Za-z]'
207 | . '|[A-Za-z]([-0-9A-Za-z]?)*[0-9A-Za-z])|%\{[CDHILOPR-Tcdhilopr-t]'
208 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\})|exp=(%\{[CDHILOPR-Tcdhilopr-t]'
209 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}|%%|%_|%-|[!-$&-~])*(\.([A-Za-z]'
210 | . '|[A-Za-z]([-0-9A-Za-z]?)*[0-9A-Za-z])|%\{[CDHILOPR-Tcdhilopr-t]'
211 | . '([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\})|[A-Za-z][-.0-9A-Z_a-z]*='
212 | . '(%\{[CDHILOPR-Tcdhilopr-t]([1-9][0-9]?|10[0-9]|11[0-9]|12[0-8])?r?[+-\/=_]*\}|%%|%_|%-|'
213 | . '[!-$&-~])*))* *$/';
214 |
215 | // Perform DNS query for SPF TXT records.
216 | $spf = false;
217 | $txtrecords = @dns_get_record($domain, DNS_TXT);
218 | // If a TXT records is found, check if it contains SPF record.
219 | if (!empty($txtrecords)) {
220 | // Check if any have the required tags.
221 | foreach ($txtrecords as $record) {
222 | if (strpos($record['txt'], 'v=spf1') !== false) {
223 | // SPF record found.
224 | $message .= $checkmark . get_string('spfrecordfound', 'local_mailtest') . ''; 225 | 226 | // Extract found SPF record data. 227 | $spfdata = $record['txt']; 228 | 229 | // Check if the SPF record contains at least one mechanism (mandatory). 230 | if (preg_match($regex, $spfdata)) { 231 | // SPF record contains at least one mechanism, it's valid. 232 | $message .= $checkmark . get_string('spfvalidrecord', 'local_mailtest') . '
'; 233 | $spf = true; 234 | break; 235 | } 236 | if (!$spf) { 237 | $message .= $xmark . get_string('spfinvalidrecord', 'local_mailtest') . '
'; 238 | } 239 | } 240 | } 241 | } 242 | // No SPF record was found. 243 | if (!$spf && empty($message)) { 244 | $message .= $exclamation . get_string('spfnorecordfound', 'local_mailtest') . '
'; 245 | } 246 | 247 | // Check DKIM record. 248 | 249 | $dkim = false; 250 | if (empty($emaildkimselector = $CFG->emaildkimselector)) { 251 | $message .= $exclamation . get_string('dkimmissingselector', 'local_mailtest') . '
'; 252 | } else { 253 | $txtrecords = @dns_get_record($emaildkimselector . '._domainkey.' . $domain, DNS_TXT); 254 | 255 | // If TXT records are found named *_domainkey, check if it contains DKIM record. 256 | if (!empty($txtrecords)) { 257 | // DKIM records found. 258 | $message .= $checkmark . get_string('dkimrecordfound', 'local_mailtest') . '
'; 259 | 260 | // Check if it has the required tags. 261 | foreach ($txtrecords as $record) { 262 | // Extract DKIM record data. 263 | $dkimdata = $record['txt']; 264 | 265 | // Check if the DKIM record contains all mandatory tags. 266 | if ( 267 | strpos($dkimdata, 'v=DKIM1') !== false && 268 | strpos($dkimdata, 'k=') !== false && 269 | strpos($dkimdata, 'p=') !== false 270 | ) { 271 | // DKIM record contains all mandatory tags, it's valid. 272 | $message .= $checkmark . get_string('dkimvalidrecord', 'local_mailtest') . '
'; 273 | $dkim = true; 274 | break; 275 | } 276 | } 277 | if (!$dkim) { 278 | $message .= $xmark . get_string('dkiminvalidrecord', 'local_mailtest') . '
'; 279 | } else { 280 | if (empty($CFG->emaildkimselector)) { 281 | $message .= $exclamation . get_string('dkimmissingselector', 'local_mailtest') . '
'; 282 | } else { 283 | $message .= $checkmark . get_string('dkimselectorconfigured', 'local_mailtest') . '
'; 284 | } 285 | } 286 | } else { 287 | // Check to see if there might be a CNAME record instead. 288 | $records = @dns_get_record($emaildkimselector . '._domainkey.' . $domain, DNS_CNAME); 289 | $dkim = !empty($records); 290 | if ($dkim) { 291 | // DKIM CNAME type records can points to a DKIM key stored on another server. 292 | $message .= $checkmark . get_string('dkimrecordfound', 'local_mailtest') . '
'; 293 | } 294 | } 295 | 296 | if (!$dkim) { 297 | // No DKIM record was found. 298 | $message .= $exclamation . get_string('dkimnorecordfound', 'local_mailtest') . '
'; 299 | } 300 | } 301 | 302 | // Check DMARC records. 303 | 304 | $txtrecords = @dns_get_record('_dmarc.' . $domain, DNS_TXT); 305 | if (empty($txtrecords)) { 306 | // No DMARC records found. 307 | $message .= $xmark . get_string('dmarcnorecordfound', 'local_mailtest') . '
'; 308 | $success = false; 309 | } else { 310 | // DMARC records found. 311 | $message .= $checkmark . get_string('dmarcrecordfound', 'local_mailtest') . '
'; 312 | 313 | // Check if it has the required tags. 314 | foreach ($txtrecords as $record) { 315 | if ( 316 | preg_match('/v=DMARC1;/', $record['txt']) 317 | && preg_match('/p=(none|quarantine|reject);/', $record['txt']) 318 | ) { 319 | // Required DMARC tags are present and valid. 320 | $message .= $checkmark . get_string('dmarctagsfound', 'local_mailtest') . '
'; 321 | 322 | // Check rua tag if present. 323 | $ruavalue = false; 324 | if (preg_match('/rua=([^;]+)/', $record['txt'], $matches)) { 325 | $ruavalue = $matches[1]; 326 | // Validate rua value format (should be a valid URI). 327 | if (!filter_var($ruavalue, FILTER_VALIDATE_URL) && !filter_var("mailto:" . $ruavalue, FILTER_VALIDATE_EMAIL)) { 328 | // The rua value is not formatted correctly. 329 | $message .= $xmark . get_string('dmarcruainvalid', 'local_mailtest') . '
'; 330 | $success = false; 331 | } 332 | } 333 | 334 | // Check ruf tag if present. 335 | $rufvalue = false; 336 | if (preg_match('/ruf=([^;]+)/', $record['txt'], $matches)) { 337 | $rufvalue = $matches[1]; 338 | // Validate ruf value format (should be a valid URI). 339 | if (!filter_var($rufvalue, FILTER_VALIDATE_URL) && !filter_var("mailto:" . $rufvalue, FILTER_VALIDATE_EMAIL)) { 340 | // The ruf value is not formatted correctly. 341 | $message .= $xmark . get_string('dmarcrufinvalid', 'local_mailtest') . '
'; 342 | $success = false; 343 | } 344 | } 345 | 346 | // Check pct tag if present. 347 | $pctvalue = false; 348 | if (preg_match('/pct=([0-9]+)/', $record['txt'], $matches)) { 349 | $pctvalue = intval($matches[1]); 350 | // Validate pct value range (should be between 0 and 100). 351 | if ($pctvalue < 0 || $pctvalue > 100) { 352 | // The pct value is not within the valid range. 353 | $message .= $xmark . get_string('dmarcpctinvalid', 'local_mailtest') . '
'; 354 | $success = false; 355 | } 356 | } 357 | break; 358 | } else { 359 | // Required tags not found in any of the DMARC records. 360 | $message .= $checkmark . get_string('dmarctagsfound', 'local_mailtest') . '
'; 361 | $success = false; 362 | } 363 | } 364 | } 365 | 366 | // Check to ensure that either DKIM or SPF is configured. 367 | if (!$dkim && !$spf) { 368 | $message .= $xmark . get_string('dkimspffailed', 'local_mailtest') . '
'; 369 | $success = false; 370 | } 371 | 372 | // Check BIMI record. 373 | 374 | // Perform DNS query for BIMI TXT records. 375 | $txtrecords = @dns_get_record('_bimi.' . $domain, DNS_TXT); 376 | if (empty($txtrecords)) { 377 | // Required tags not found in any of the DMARC records. 378 | $message .= $xmark . get_string('biminorecordfound', 'local_mailtest') . '
'; 379 | $success = false; 380 | } else { 381 | // Records found. Check if it has the required tags. 382 | $message .= $checkmark . get_string('bimirecordfound', 'local_mailtest') . '
'; 383 | 384 | // Loop through each BIMI record. 385 | foreach ($txtrecords as $record) { 386 | // Extract BIMI record data. 387 | $bimidata = $record['txt']; 388 | 389 | // Check if BIMI record contains both v and l tags. 390 | if (strpos($bimidata, 'v=BIMI1') !== false && strpos($bimidata, 'l=') !== false) { 391 | // Required DMARC tags are present and valid. 392 | $message .= $checkmark . get_string('bimitagsfound', 'local_mailtest') . '
'; 393 | 394 | // Extract logo URL from the BIMI record. 395 | preg_match('/l=([^;]+)/', $bimidata, $matches); 396 | $logourl = $matches[1]; 397 | 398 | // Validate existence of logo URL. 399 | $headers = @get_headers($logourl); 400 | if ($headers && strpos($headers[0], '200')) { 401 | // Logo URL exists, BIMI record is valid. 402 | $message .= $checkmark . get_string('bimiinvalidlogo', 'local_mailtest', $logourl) . '
'; 403 | break; 404 | } 405 | } 406 | } 407 | if (!$success) { 408 | // Required tags not found in any of the DMARC records. 409 | $message .= $xmark . get_string('bimidmarcfailure', 'local_mailtest') . '
'; 410 | $success = false; 411 | } 412 | if ($pctvalue != 100) { 413 | $message .= $xmark . get_string('bimipctinvalid', 'local_mailtest') . '
'; 414 | $success = false; 415 | } 416 | } 417 | 418 | $icon = $success ? 'fa-info-circle text-info' : 'fa-exclamation-triangle text-warning'; 419 | $title = get_string('iconlabel', 'local_mailtest', $domain); 420 | $bs = ($CFG->branch >= 500 ? 'bs-' : ''); 421 | $popupicon = '' 424 | . ''; 425 | $message = '
' . get_string('checkingdomain', 'local_mailtest', $domain) . '
' . $message; 426 | $message = str_replace('{message}', str_replace('"', '"', $message), $popupicon); 427 | 428 | return $message; 429 | } 430 | -------------------------------------------------------------------------------- /phpcs.xml.dist: -------------------------------------------------------------------------------- 1 | 2 |