dev/mail#2141 - MailSettings - Add button+API for testing a connection

[totten]

Overview

When an administrator creates inbound mail settings (Administer => CiviMail => Mail Accounts), it asks for a number of picky details -- like username, password, server, protocol, etc. This patch makes it easier to validate those details.

Before

There is no option to test a connection. You would have to configure a cron-worker for that connection, run it, and check its output. (Or, you have to figure out some complicated cv php:eval commands... which is what I was doing before...)

After

The "Edit Mail Account" presents a button "Save & Test" (inspired by the similar button used on "Outbound Mail" settings).

If it succeeds, then it shows a happy message:

And if it fails, then it shows a sad message:

Technical Details

The logic of the test is wrapped in a APIv4 action (MailSettings.testConnection) to make it easier to use in more contexts (eg CLI).

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[totten]

jenkins, test this please

[eileenmcnaughton]

Looks good - @stesi561 any chance you could do an r-run on this?

[totten]

@demeritcowboy It sounds like you used the "Save & Test" option as part a run-through?

Then later when you set up the mail account, when you click the save and test, the success alerts don't have the usual green icon.

FWIW, I've had this problem too, but I think it's a separate issue -- for me, at different times, I've had either (a) all alert icons work or (b) no alert icons. Haven't tracked it down. I figured maybe it was a blip of some independent work going on in master? Or maybe an issue with my local deployment? But I saw it on other screens, and it cleared up after some rebuild, so I figured it wasn't an issue with this.

[demeritcowboy]

Yes I used "save and test" as part of run-through - I didn't fully test this PR specifically but yes I ended up clicking it and so have done a minimal r-run of the button.

Will keep an eye out for other missing alert icons.

[demeritcowboy]

Maybe I can blame composer for the missing icons. It's been at least a day since I blamed composer for something.

[stesi561]

This sounds great. Ping me if you need additional r-run beyond what @demeritcowboy has done.