Feature - Send Test Mail #8643

Kubik-Rubik · 2015-12-10T14:12:12Z

This PR adds a new button ("Send Test Mail") in the Global Configuration with which the email settings can be tested with one click!

After the click on the button, the email data is transferred via an Ajax request to the server and a test mail is created and sent to the specified email address. If the sending process fails, a message with the error is displayed (see screenshots).

You don't have to save the configuration first, because the sending process will always be executed with the current entered values. Once the email settings are right, you should save them with a click on the "Save" button.

How to test

Install patch, go to the Global Configuration and click on the button! :-)
Change some settings (e.g. enter wrong values) and try it again.

Important: You should also test on an online server from which you really can send emails to receive the test mail. For instance, on local environments the "PHP Mail" option does not throw an error even though the email was not sent (if not configured properly)!

brianteeman · 2015-12-10T14:19:30Z

administrator/language/en-GB/en-GB.com_config.ini

+COM_CONFIG_SENDMAIL_BODY="This is a test mail. If you receive it, then your email settings are correct!"
+COM_CONFIG_SENDMAIL_ERROR="Test mail could not be sent."
+COM_CONFIG_SENDMAIL_SUBJECT="Test mail from %s"
+COM_CONFIG_SENDMAIL_SUCCESS="Mail sending process executed properly. Additionally, you should check whether you've received the test mail!"


Can this be simplified into more basic english? Perhaps
"The email was sent successfully. You should check that you've received the test email."

Sure, I've expected a correction from you! :-P

brianteeman · 2015-12-10T14:27:48Z

I have tested this item ✅ successfully on bf8e351

Tested in localhost with phpmail, sendmail and smtp mail - all worked

I think its a little confusing (or not documented) that the test email is sent to the email address defined in the From email field

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

joomla-cms-bot · 2015-12-10T14:30:37Z

This PR has received new commits.

CC: @brianteeman

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

Kubik-Rubik · 2015-12-10T14:34:04Z

@brianteeman Thank you for testing it. Yes, this should be documented. Maybe directly in the success message? If yes, could you please send me the correct wording?

brianteeman · 2015-12-10T14:36:32Z

how about
+COM_CONFIG_SENDMAIL_SUCCESS="The email was sent successfully to %email. You should check that you've received the test email."

brianteeman · 2015-12-10T14:37:17Z

Or even better
+COM_CONFIG_SENDMAIL_SUCCESS="The email was sent successfully to %email using %method. You should check that you've received the test email."

Kubik-Rubik · 2015-12-10T14:37:35Z

@brianteeman Good idea!

brianteeman · 2015-12-10T14:41:40Z

Might be worth changing the email body message as well to show the settings
that were used to send the email

Perhaps
+COM_CONFIG_SENDMAIL_BODY="This is a test mail sent using %method. If you
receive it, then your email settings are correct!"

And even better if it could include all the options for that method

Otherwise when testing and receiving multiple emails you dont know which
method was successfully receieved

On 10 December 2015 at 14:37, Viktor Vogel notifications@github.com wrote:

@brianteeman https://github.com/brianteeman Good idea!

—
Reply to this email directly or view it on GitHub
#8643 (comment).

Brian Teeman
Co-founder Joomla! and OpenSourceMatters Inc.
http://brian.teeman.net/

joomla-cms-bot · 2015-12-10T16:13:50Z

This PR has received new commits.

CC: @brianteeman

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

Kubik-Rubik · 2015-12-10T16:15:33Z

@brianteeman PR updated with your suggestions. Could you please re-test? Thank you!

brianteeman · 2015-12-10T16:20:08Z

Completely stopped working now
I have a button but thats all - pressing it doesnt give a success OR a fail
message

On 10 December 2015 at 16:15, Viktor Vogel notifications@github.com wrote:

@brianteeman https://github.com/brianteeman PR updated with your
suggestions. Could you please re-test? Thank you!

—
Reply to this email directly or view it on GitHub
#8643 (comment).

Brian Teeman
Co-founder Joomla! and OpenSourceMatters Inc.
http://brian.teeman.net/

brianteeman · 2015-12-10T16:21:24Z

Correction - I received the emails with the updated message so it was just in the Joomla admin that I was not getting any messages

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

Kubik-Rubik · 2015-12-10T16:24:59Z

@brianteeman I've changed the JavaScript file, so you have first to clear your browser cache.

brianteeman · 2015-12-10T16:25:00Z

I have tested this item ✅ successfully on 43ba153

I just looked at the code and saw it was using some js - so my last problem was just a JS cache issue
All working well now.

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

joomla-cms-bot · 2015-12-10T16:30:12Z

This PR has received new commits.

CC: @brianteeman

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

Kubik-Rubik · 2015-12-10T16:31:57Z

Updated screenshot:

joomla-cms-bot · 2015-12-10T16:55:17Z

This PR has received new commits.

CC: @brianteeman

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

pe7er · 2015-12-10T16:57:16Z

I have tested this item ✅ successfully on a4000f2

Works good!

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

alikon · 2015-12-10T17:33:10Z

tested successfully

wilsonge · 2015-12-10T19:23:14Z

administrator/components/com_config/controller/application/sendtestmail.php

+
+		$model = new ConfigModelApplication;
+		$response = new JResponseJson($model->sendTestMail());
+		echo $response->__toString();


Noooope. __toString is a magic PHP method. echo (string) $response is what you need

Don't even need the (string) typecast. echo will automagically convert it. Take a look at https://github.com/joomla/joomla-cms/blob/staging/administrator/components/com_languages/controllers/strings.json.php and see how nice and simple it is.

Ooops, misunderstood it... :-) Thanks guys!

wilsonge · 2015-12-10T19:24:50Z

administrator/components/com_config/model/application.php

+		$conf->set('mailonline', $input->get('mailonline'));
+
+		// Prepare email and send try to send it
+		$mail_subject = JText::sprintf('COM_CONFIG_SENDMAIL_SUBJECT', $conf->get('sitename'));


Camelcase variable as per our code style guidelines please

RickR2H · 2015-12-10T19:52:15Z

Switching only to SMTP and not filling any SMTP settings activates the phpmail fallback on clicking the button. The message states "The email was sent successfully to rick@r2h.nl using SMTP. You should check that you've received the test email." But it should give a message that not all SMTP settings are filled ans mail cannot be sent. Also filling all the fields with false date ativates the fallback to phpmail and ther is also no error message.

brianteeman · 2015-12-10T20:07:55Z

But it should give a message that not all SMTP settings are filled ans mail cannot be sent. Also filling all the fields with false date ativates the fallback to phpmail and ther is also no error message.

When I put in invalid data I got a failed message

joomla-cms-bot · 2015-12-10T20:27:33Z

This PR has received new commits.

CC: @brianteeman, @pe7er

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

Gerlof · 2015-12-11T09:44:24Z

I have tested this item ✅ successfully on bf5ba5e

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

dwarkesh0204 · 2015-12-12T04:40:17Z

I have tested this item ✅ successfully on bf5ba5e

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

Fedik · 2015-12-12T14:00:01Z

Beside that the thing is working, I have the note to 😄

In suggested implementation sendTestMail() totally ignore the form application.xml, this could leed to "false" result (after changes in the form in the future), example sendTestMail say OK but after saving the form validation say FAIL

So my suggestion is to use "common routine" (form filtering and validation) instead of fancy stuff with $app->input in sendTestMail()

Take save.php as example, in Sendtestmail controller, do something like:

$form = $model->getForm();
$validatedData = $model->validate($form, $data);
$result = $model->sendTestMail($validatedData);

To make the form validate only Email params, in the model loadForm need to use $xpath for fieldset[@name="mail"]. So maybe can be need one more method for getEmailForm here or something.

Just suggestion 😄

brianteeman · 2016-01-20T00:40:56Z

Setting RTC- would be good to get this in 3.5 and not have to wait a year for 3.6 - there are no b/c issues

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8643.}

Feature - Send Test Mail

Feature - Send Test Mail

b0c9bd0

joomla-cms-bot added Language Change This is for Translators PR-staging labels Dec 10, 2015

Kubik-Rubik added this to the Joomla! 3.6.0 milestone Dec 10, 2015

Kubik-Rubik added the Feature label Dec 10, 2015

Code style

bf8e351

brianteeman reviewed Dec 10, 2015
View reviewed changes

Language improvement

52df305

More information + Code style

43ba153

Travis

9e7398b

$id not available / needed

a4000f2

wilsonge reviewed Dec 10, 2015
View reviewed changes

Code improvements

bf5ba5e

joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Jan 20, 2016

wilsonge modified the milestones: Joomla! 3.5.0, Joomla! 3.6.0 Jan 20, 2016

wilsonge added a commit that referenced this pull request Jan 20, 2016

Merge pull request #8643 from Kubik-Rubik/feature-sendtestmail

5d4a0ae

Feature - Send Test Mail

wilsonge merged commit 5d4a0ae into joomla:staging Jan 20, 2016

Kubik-Rubik deleted the feature-sendtestmail branch May 10, 2016 09:04

brianteeman removed the RTC This Pull Request is Ready To Commit label May 11, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature - Send Test Mail #8643

Feature - Send Test Mail #8643

Kubik-Rubik commented Dec 10, 2015

brianteeman Dec 10, 2015

Kubik-Rubik Dec 10, 2015

Kubik-Rubik Dec 10, 2015

brianteeman commented Dec 10, 2015

joomla-cms-bot commented Dec 10, 2015

Kubik-Rubik commented Dec 10, 2015

brianteeman commented Dec 10, 2015

brianteeman commented Dec 10, 2015

Kubik-Rubik commented Dec 10, 2015

brianteeman commented Dec 10, 2015

joomla-cms-bot commented Dec 10, 2015

Kubik-Rubik commented Dec 10, 2015

brianteeman commented Dec 10, 2015

brianteeman commented Dec 10, 2015

Kubik-Rubik commented Dec 10, 2015

brianteeman commented Dec 10, 2015

joomla-cms-bot commented Dec 10, 2015

Kubik-Rubik commented Dec 10, 2015

joomla-cms-bot commented Dec 10, 2015

pe7er commented Dec 10, 2015

alikon commented Dec 10, 2015

wilsonge Dec 10, 2015

mbabker Dec 10, 2015

Kubik-Rubik Dec 10, 2015

wilsonge Dec 10, 2015

RickR2H commented Dec 10, 2015

brianteeman commented Dec 10, 2015

joomla-cms-bot commented Dec 10, 2015

Gerlof commented Dec 11, 2015

dwarkesh0204 commented Dec 12, 2015

Fedik commented Dec 12, 2015

brianteeman commented Jan 20, 2016

Feature - Send Test Mail #8643

Feature - Send Test Mail #8643

Conversation

Kubik-Rubik commented Dec 10, 2015

brianteeman Dec 10, 2015

Choose a reason for hiding this comment

Kubik-Rubik Dec 10, 2015

Choose a reason for hiding this comment

Kubik-Rubik Dec 10, 2015

Choose a reason for hiding this comment

brianteeman commented Dec 10, 2015

joomla-cms-bot commented Dec 10, 2015

Kubik-Rubik commented Dec 10, 2015

brianteeman commented Dec 10, 2015

brianteeman commented Dec 10, 2015

Kubik-Rubik commented Dec 10, 2015

brianteeman commented Dec 10, 2015

joomla-cms-bot commented Dec 10, 2015

Kubik-Rubik commented Dec 10, 2015

brianteeman commented Dec 10, 2015

brianteeman commented Dec 10, 2015

Kubik-Rubik commented Dec 10, 2015

brianteeman commented Dec 10, 2015

joomla-cms-bot commented Dec 10, 2015

Kubik-Rubik commented Dec 10, 2015

joomla-cms-bot commented Dec 10, 2015

pe7er commented Dec 10, 2015

alikon commented Dec 10, 2015

wilsonge Dec 10, 2015

Choose a reason for hiding this comment

mbabker Dec 10, 2015

Choose a reason for hiding this comment

Kubik-Rubik Dec 10, 2015

Choose a reason for hiding this comment

wilsonge Dec 10, 2015

Choose a reason for hiding this comment

RickR2H commented Dec 10, 2015

brianteeman commented Dec 10, 2015

joomla-cms-bot commented Dec 10, 2015

Gerlof commented Dec 11, 2015

dwarkesh0204 commented Dec 12, 2015

Fedik commented Dec 12, 2015

brianteeman commented Jan 20, 2016