From: Alangi Derick <alangiderick@gmail.com>
Date: Mon, 3 Dec 2018 14:09:14 +0000 (+0100)
Subject: mail: Correct return value of sendPersonalised() method
X-Git-Tag: 1.34.0-rc.0~3356^2
X-Git-Url: http://git.cyclocoop.org/data/%24self?a=commitdiff_plain;h=b5ace113e7879a461c1886feeb4541eafbf6115f;p=lhc%2Fweb%2Fwiklou.git

mail: Correct return value of sendPersonalised() method

If email is not successfully sent, return Status (with appropriate
status error) and also, if successfully sent, return Status::newGood().

Change-Id: I602e30641b88614087d9aff83cf8c93e32af7b81
---

diff --git a/includes/mail/EmailNotification.php b/includes/mail/EmailNotification.php
index fa5ebfc93c..739dbec035 100644
--- a/includes/mail/EmailNotification.php
+++ b/includes/mail/EmailNotification.php
@@ -444,11 +444,12 @@ class EmailNotification {
 	/**
 	 * Does the per-user customizations to a notification e-mail (name,
 	 * timestamp in proper timezone, etc) and sends it out.
-	 * Returns true if the mail was sent successfully.
+	 * Returns Status if email was sent successfully or not (Status::newGood()
+	 * or Status::newFatal() respectively).
 	 *
 	 * @param User $watchingUser
 	 * @param string $source
-	 * @return bool
+	 * @return Status
 	 * @private
 	 */
 	function sendPersonalised( $watchingUser, $source ) {