XMPP URI and markdown are no friends (yet)

[friendica.git] / tests / Util / EmailerSpy.php

diff --git a/tests/Util/EmailerSpy.php b/tests/Util/EmailerSpy.php
index effd2ed08010a6611688a7e8a97261d79b490aa5..161e0f0db5ca730c331792fed7cad54565b72421 100644 (file)
--- a/tests/Util/EmailerSpy.php
+++ b/tests/Util/EmailerSpy.php
@@ -8,6 +8,18 @@ class EmailerSpy extends Emailer
 {
        public static $MAIL_DATA;
 
+       /**
+        * Wrapper around the mail() method (mainly used to overwrite for tests)
+        * @see mail()
+        *
+        * @param string $to         Recipient of this mail
+        * @param string $subject    Subject of this mail
+        * @param string $body       Message body of this mail
+        * @param string $headers    Headers of this mail
+        * @param string $parameters Additional (sendmail) parameters of this mail
+        *
+        * @return bool true if the mail was successfully accepted for delivery, false otherwise.
+        */
        protected function mail(string $to, string $subject, string $body, string $headers, string $parameters)
        {
                self::$MAIL_DATA = [