aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFaraz Samapoor <f.samapoor@gmail.com>2023-06-26 21:19:14 +0330
committerLouis <6653109+artonge@users.noreply.github.com>2023-06-27 10:45:39 +0200
commita449bd1a0c45e57d6d3d0ecc44f9c955ac2f2ae9 (patch)
treea8da3b5a8e07b7de7c25e49976b3c1fb1561a16a
parent4cfab4b838ed40dec200f7673992009896c69f16 (diff)
downloadnextcloud-server-a449bd1a0c45e57d6d3d0ecc44f9c955ac2f2ae9.tar.gz
nextcloud-server-a449bd1a0c45e57d6d3d0ecc44f9c955ac2f2ae9.zip
Adds same object return annotations.
Based on: https://github.com/nextcloud/server/pull/38987#discussion_r1241866676 Co-authored-by: Côme Chilliet <91878298+come-nc@users.noreply.github.com> Signed-off-by: Faraz Samapoor <fsa@adlas.at>
-rw-r--r--lib/private/Mail/Attachment.php3
-rw-r--r--lib/private/Mail/Message.php21
2 files changed, 24 insertions, 0 deletions
diff --git a/lib/private/Mail/Attachment.php b/lib/private/Mail/Attachment.php
index 7500d0b6c98..a39161b2505 100644
--- a/lib/private/Mail/Attachment.php
+++ b/lib/private/Mail/Attachment.php
@@ -45,6 +45,7 @@ class Attachment implements IAttachment {
}
/**
+ * @return $this
* @since 13.0.0
*/
public function setFilename(string $filename): IAttachment {
@@ -53,6 +54,7 @@ class Attachment implements IAttachment {
}
/**
+ * @return $this
* @since 13.0.0
*/
public function setContentType(string $contentType): IAttachment {
@@ -61,6 +63,7 @@ class Attachment implements IAttachment {
}
/**
+ * @return $this
* @since 13.0.0
*/
public function setBody(string $body): IAttachment {
diff --git a/lib/private/Mail/Message.php b/lib/private/Mail/Message.php
index b0634a4754d..15d4da793dd 100644
--- a/lib/private/Mail/Message.php
+++ b/lib/private/Mail/Message.php
@@ -60,6 +60,7 @@ class Message implements IMessage {
/**
* @since 13.0.0
+ * @return $this
*/
public function attach(IAttachment $attachment): IMessage {
/** @var Attachment $attachment */
@@ -114,6 +115,7 @@ class Message implements IMessage {
* If no "From" address is used \OC\Mail\Mailer will use mail_from_address and mail_domain from config.php
*
* @param array $addresses Example: array('sender@domain.org', 'other@domain.org' => 'A name')
+ * @return $this
*/
public function setFrom(array $addresses): IMessage {
$this->from = $addresses;
@@ -129,6 +131,7 @@ class Message implements IMessage {
/**
* Set the Reply-To address of this message
+ * @return $this
*/
public function setReplyTo(array $addresses): IMessage {
$this->replyTo = $addresses;
@@ -146,6 +149,7 @@ class Message implements IMessage {
* Set the to addresses of this message.
*
* @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
+ * @return $this
*/
public function setTo(array $recipients): IMessage {
$this->to = $recipients;
@@ -163,6 +167,7 @@ class Message implements IMessage {
* Set the CC recipients of this message.
*
* @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
+ * @return $this
*/
public function setCc(array $recipients): IMessage {
$this->cc = $recipients;
@@ -180,6 +185,7 @@ class Message implements IMessage {
* Set the BCC recipients of this message.
*
* @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
+ * @return $this
*/
public function setBcc(array $recipients): IMessage {
$this->bcc = $recipients;
@@ -193,6 +199,9 @@ class Message implements IMessage {
return $this->bcc;
}
+ /**
+ * @return $this
+ */
public function setSubject(string $subject): IMessage {
$this->symfonyEmail->subject($subject);
return $this;
@@ -205,6 +214,9 @@ class Message implements IMessage {
return $this->symfonyEmail->getSubject() ?? '';
}
+ /**
+ * @return $this
+ */
public function setPlainBody(string $body): IMessage {
$this->symfonyEmail->text($body);
return $this;
@@ -219,6 +231,9 @@ class Message implements IMessage {
return $body;
}
+ /**
+ * @return $this
+ */
public function setHtmlBody(string $body): IMessage {
if (!$this->plainTextOnly) {
$this->symfonyEmail->html($body);
@@ -240,6 +255,9 @@ class Message implements IMessage {
return $this->symfonyEmail;
}
+ /**
+ * @return $this
+ */
public function setBody(string $body, string $contentType): IMessage {
if (!$this->plainTextOnly || $contentType !== 'text/html') {
if ($contentType === 'text/html') {
@@ -277,6 +295,9 @@ class Message implements IMessage {
$this->symfonyEmail->bcc(...$this->convertAddresses($this->getBcc()));
}
+ /**
+ * @return $this
+ */
public function useTemplate(IEMailTemplate $emailTemplate): IMessage {
$this->setSubject($emailTemplate->renderSubject());
$this->setPlainBody($emailTemplate->renderText());