summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
Diffstat (limited to 'lib')
-rw-r--r--lib/composer/composer/autoload_classmap.php1
-rw-r--r--lib/composer/composer/autoload_static.php1
-rw-r--r--lib/private/Mail/EMailTemplate.php20
-rw-r--r--lib/private/Mail/Mailer.php7
-rw-r--r--lib/private/Mail/Message.php15
-rw-r--r--lib/private/Share20/Manager.php6
-rw-r--r--lib/public/Mail/IEMailTemplate.php18
-rw-r--r--lib/public/Mail/IMailer.php9
-rw-r--r--lib/public/Mail/IMessage.php84
9 files changed, 148 insertions, 13 deletions
diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index 9341bd1a762..489b9b3dc14 100644
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -226,6 +226,7 @@ return array(
'OCP\\Lockdown\\ILockdownManager' => $baseDir . '/lib/public/Lockdown/ILockdownManager.php',
'OCP\\Mail\\IEMailTemplate' => $baseDir . '/lib/public/Mail/IEMailTemplate.php',
'OCP\\Mail\\IMailer' => $baseDir . '/lib/public/Mail/IMailer.php',
+ 'OCP\\Mail\\IMessage' => $baseDir . '/lib/public/Mail/IMessage.php',
'OCP\\Migration\\BigIntMigration' => $baseDir . '/lib/public/Migration/BigIntMigration.php',
'OCP\\Migration\\IMigrationStep' => $baseDir . '/lib/public/Migration/IMigrationStep.php',
'OCP\\Migration\\IOutput' => $baseDir . '/lib/public/Migration/IOutput.php',
diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index 5715ff6ed05..1297f4606f6 100644
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -256,6 +256,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
'OCP\\Lockdown\\ILockdownManager' => __DIR__ . '/../../..' . '/lib/public/Lockdown/ILockdownManager.php',
'OCP\\Mail\\IEMailTemplate' => __DIR__ . '/../../..' . '/lib/public/Mail/IEMailTemplate.php',
'OCP\\Mail\\IMailer' => __DIR__ . '/../../..' . '/lib/public/Mail/IMailer.php',
+ 'OCP\\Mail\\IMessage' => __DIR__ . '/../../..' . '/lib/public/Mail/IMessage.php',
'OCP\\Migration\\BigIntMigration' => __DIR__ . '/../../..' . '/lib/public/Migration/BigIntMigration.php',
'OCP\\Migration\\IMigrationStep' => __DIR__ . '/../../..' . '/lib/public/Migration/IMigrationStep.php',
'OCP\\Migration\\IOutput' => __DIR__ . '/../../..' . '/lib/public/Migration/IOutput.php',
diff --git a/lib/private/Mail/EMailTemplate.php b/lib/private/Mail/EMailTemplate.php
index da3341b6709..e4e28a9294e 100644
--- a/lib/private/Mail/EMailTemplate.php
+++ b/lib/private/Mail/EMailTemplate.php
@@ -51,6 +51,8 @@ class EMailTemplate implements IEMailTemplate {
protected $data;
/** @var string */
+ protected $subject = '';
+ /** @var string */
protected $htmlBody = '';
/** @var string */
protected $plainBody = '';
@@ -359,6 +361,15 @@ EOF;
}
/**
+ * Sets the subject of the email
+ *
+ * @param string $subject
+ */
+ public function setSubject($subject) {
+ $this->subject = $subject;
+ }
+
+ /**
* Adds a header to the email
*/
public function addHeader() {
@@ -596,6 +607,15 @@ EOF;
}
/**
+ * Returns the rendered email subject as string
+ *
+ * @return string
+ */
+ public function renderSubject() {
+ return $this->subject;
+ }
+
+ /**
* Returns the rendered HTML email as string
*
* @return string
diff --git a/lib/private/Mail/Mailer.php b/lib/private/Mail/Mailer.php
index 45405157d26..43fdb07b810 100644
--- a/lib/private/Mail/Mailer.php
+++ b/lib/private/Mail/Mailer.php
@@ -29,6 +29,7 @@ use OCP\IURLGenerator;
use OCP\Mail\IEMailTemplate;
use OCP\Mail\IMailer;
use OCP\ILogger;
+use OCP\Mail\IMessage;
/**
* Class Mailer provides some basic functions to create a mail message that can be used in combination with
@@ -84,7 +85,7 @@ class Mailer implements IMailer {
/**
* Creates a new message object that can be passed to send()
*
- * @return Message
+ * @return IMessage
*/
public function createMessage() {
return new Message(new \Swift_Message());
@@ -124,13 +125,13 @@ class Mailer implements IMailer {
* Send the specified message. Also sets the from address to the value defined in config.php
* if no-one has been passed.
*
- * @param Message $message Message to send
+ * @param IMessage|Message $message Message to send
* @return string[] Array with failed recipients. Be aware that this depends on the used mail backend and
* therefore should be considered
* @throws \Exception In case it was not possible to send the message. (for example if an invalid mail address
* has been supplied.)
*/
- public function send(Message $message) {
+ public function send(IMessage $message) {
$debugMode = $this->config->getSystemValue('mail_smtpdebug', false);
if (empty($message->getFrom())) {
diff --git a/lib/private/Mail/Message.php b/lib/private/Mail/Message.php
index 2d3c49d0ce1..b4d1e4dbe7a 100644
--- a/lib/private/Mail/Message.php
+++ b/lib/private/Mail/Message.php
@@ -23,6 +23,8 @@
namespace OC\Mail;
+use OCP\Mail\IEMailTemplate;
+use OCP\Mail\IMessage;
use Swift_Message;
/**
@@ -30,7 +32,7 @@ use Swift_Message;
*
* @package OC\Mail
*/
-class Message {
+class Message implements IMessage {
/** @var Swift_Message */
private $swiftMessage;
@@ -250,4 +252,15 @@ class Message {
$this->swiftMessage->setBody($body, $contentType);
return $this;
}
+
+ /**
+ * @param IEMailTemplate $emailTemplate
+ * @return $this
+ */
+ public function useTemplate(IEMailTemplate $emailTemplate) {
+ $this->setSubject($emailTemplate->renderSubject());
+ $this->setPlainBody($emailTemplate->renderText());
+ $this->setHtmlBody($emailTemplate->renderHtml());
+ return $this;
+ }
}
diff --git a/lib/private/Share20/Manager.php b/lib/private/Share20/Manager.php
index b2e192b8309..42f2170122e 100644
--- a/lib/private/Share20/Manager.php
+++ b/lib/private/Share20/Manager.php
@@ -702,7 +702,6 @@ class Manager implements IManager {
\DateTime $expiration = null) {
$initiatorUser = $this->userManager->get($initiator);
$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
- $subject = $l->t('%s shared »%s« with you', array($initiatorDisplayName, $filename));
$message = $this->mailer->createMessage();
@@ -714,6 +713,7 @@ class Manager implements IManager {
'shareWith' => $shareWith,
]);
+ $emailTemplate->setSubject($l->t('%s shared »%s« with you', array($initiatorDisplayName, $filename)));
$emailTemplate->addHeader();
$emailTemplate->addHeading($l->t('%s shared »%s« with you', [$initiatorDisplayName, $filename]), false);
$text = $l->t('%s shared »%s« with you.', [$initiatorDisplayName, $filename]);
@@ -750,9 +750,7 @@ class Manager implements IManager {
$emailTemplate->addFooter();
}
- $message->setSubject($subject);
- $message->setPlainBody($emailTemplate->renderText());
- $message->setHtmlBody($emailTemplate->renderHtml());
+ $message->useTemplate($emailTemplate);
$this->mailer->send($message);
}
diff --git a/lib/public/Mail/IEMailTemplate.php b/lib/public/Mail/IEMailTemplate.php
index 04a3905c2e3..c1766076c44 100644
--- a/lib/public/Mail/IEMailTemplate.php
+++ b/lib/public/Mail/IEMailTemplate.php
@@ -53,6 +53,15 @@ namespace OCP\Mail;
interface IEMailTemplate {
/**
+ * Sets the subject of the email
+ *
+ * @param string $subject
+ *
+ * @since 13.0.0
+ */
+ public function setSubject($subject);
+
+ /**
* Adds a header to the email
*
* @since 12.0.0
@@ -131,6 +140,15 @@ interface IEMailTemplate {
public function addFooter($text = '');
/**
+ * Returns the rendered email subject as string
+ *
+ * @return string
+ *
+ * @since 13.0.0
+ */
+ public function renderSubject();
+
+ /**
* Returns the rendered HTML email as string
*
* @return string
diff --git a/lib/public/Mail/IMailer.php b/lib/public/Mail/IMailer.php
index c283d346745..35189c22a69 100644
--- a/lib/public/Mail/IMailer.php
+++ b/lib/public/Mail/IMailer.php
@@ -23,7 +23,6 @@
*/
namespace OCP\Mail;
-use OC\Mail\Message;
/**
* Class IMailer provides some basic functions to create a mail message that can be used in combination with
@@ -34,7 +33,7 @@ use OC\Mail\Message;
* $mailer = \OC::$server->getMailer();
* $message = $mailer->createMessage();
* $message->setSubject('Your Subject');
- * $message->setFrom(['cloud@domain.org' => 'ownCloud Notifier']);
+ * $message->setFrom(['cloud@domain.org' => 'Nextcloud Notifier']);
* $message->setTo(['recipient@domain.org' => 'Recipient']);
* $message->setPlainBody('The message text');
* $message->setHtmlBody('The <strong>message</strong> text');
@@ -49,7 +48,7 @@ interface IMailer {
/**
* Creates a new message object that can be passed to send()
*
- * @return Message
+ * @return IMessage
* @since 8.1.0
*/
public function createMessage();
@@ -68,14 +67,14 @@ interface IMailer {
* Send the specified message. Also sets the from address to the value defined in config.php
* if no-one has been passed.
*
- * @param Message $message Message to send
+ * @param IMessage $message Message to send
* @return string[] Array with failed recipients. Be aware that this depends on the used mail backend and
* therefore should be considered
* @throws \Exception In case it was not possible to send the message. (for example if an invalid mail address
* has been supplied.)
* @since 8.1.0
*/
- public function send(Message $message);
+ public function send(IMessage $message);
/**
* Checks if an e-mail address is valid
diff --git a/lib/public/Mail/IMessage.php b/lib/public/Mail/IMessage.php
new file mode 100644
index 00000000000..20e4ea19c4c
--- /dev/null
+++ b/lib/public/Mail/IMessage.php
@@ -0,0 +1,84 @@
+<?php
+/**
+ * @copyright Copyright (c) 2017 Joas Schilling <coding@schilljs.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Mail;
+
+/**
+ * Class Message
+ *
+ * @package OCP\Mail
+ * @since 13.0.0
+ */
+interface IMessage {
+ /**
+ * Set the from address of this message.
+ *
+ * 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
+ * @since 13.0.0
+ */
+ public function setFrom(array $addresses);
+
+ /**
+ * Set the Reply-To address of this message
+ *
+ * @param array $addresses
+ * @return $this
+ * @since 13.0.0
+ */
+ public function setReplyTo(array $addresses);
+
+ /**
+ * Set the to addresses of this message.
+ *
+ * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
+ * @return $this
+ * @since 13.0.0
+ */
+ public function setTo(array $recipients);
+
+ /**
+ * Set the CC recipients of this message.
+ *
+ * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
+ * @return $this
+ * @since 13.0.0
+ */
+ public function setCc(array $recipients);
+
+ /**
+ * Set the BCC recipients of this message.
+ *
+ * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
+ * @return $this
+ * @since 13.0.0
+ */
+ public function setBcc(array $recipients);
+
+ /**
+ * @param IEMailTemplate $emailTemplate
+ * @return $this
+ * @since 13.0.0
+ */
+ public function useTemplate(IEMailTemplate $emailTemplate);
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-02 16:18:58 +0000