Add meta information to emails for better customisation

Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Joas Schilling 2017-08-24 17:54:22 +02:00 committed by Morris Jobke
parent eb71c1288d
commit 7df1ddcf2c
No known key found for this signature in database
GPG Key ID: FE03C3A163FEDE68
4 changed files with 45 additions and 4 deletions

View File

@ -346,7 +346,8 @@ class ShareByMailProvider implements IShareProvider {
$share->getNode()->getName(),
$link,
$share->getSharedBy(),
$share->getSharedWith()
$share->getSharedWith(),
$share->getExpirationDate()
);
} catch (HintException $hintException) {
$this->logger->error('Failed to send share by mail: ' . $hintException->getMessage());
@ -368,12 +369,14 @@ class ShareByMailProvider implements IShareProvider {
* @param string $link
* @param string $initiator
* @param string $shareWith
* @param \DateTime $expiration
* @throws \Exception If mail couldn't be sent
*/
protected function sendMailNotification($filename,
$link,
$initiator,
$shareWith) {
$shareWith,
\DateTime $expiration) {
$initiatorUser = $this->userManager->get($initiator);
$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
$subject = (string)$this->l->t('%s shared »%s« with you', array($initiatorDisplayName, $filename));
@ -381,6 +384,12 @@ class ShareByMailProvider implements IShareProvider {
$message = $this->mailer->createMessage();
$emailTemplate = $this->mailer->createEMailTemplate();
$emailTemplate->setMetaData('sharebymail.RecipientNotification', [
'filename' => $filename,
'link' => $link,
'initiator' => $initiatorDisplayName,
'expiration' => $expiration,
]);
$emailTemplate->addHeader();
$emailTemplate->addHeading($this->l->t('%s shared »%s« with you', [$initiatorDisplayName, $filename]), false);

View File

@ -45,6 +45,10 @@ class EMailTemplate implements IEMailTemplate {
protected $urlGenerator;
/** @var IL10N */
protected $l10n;
/** @var string */
protected $emailId;
/** @var array */
protected $data;
/** @var string */
protected $htmlBody = '';
@ -348,6 +352,18 @@ EOF;
$this->htmlBody .= $this->head;
}
/**
* Set meta data of an email
*
* @param string $emailId
* @param array $data
* @since 12.0.3
*/
public function setMetaData($emailId, array $data = []) {
$this->emailId = $emailId;
$this->data = $data;
}
/**
* Adds a header to the email
*/

View File

@ -693,7 +693,8 @@ class Manager implements IManager {
$share->getNode()->getName(),
$this->urlGenerator->linkToRouteAbsolute('files.viewcontroller.showFile', [ 'fileid' => $share->getNode()->getId() ]),
$share->getSharedBy(),
$emailAddress
$emailAddress,
$share->getExpirationDate()
);
$this->logger->debug('Send share notification to ' . $emailAddress . ' for share with ID ' . $share->getId(), ['app' => 'share']);
} else {
@ -712,12 +713,14 @@ class Manager implements IManager {
* @param string $link link to the file/folder
* @param string $initiator user ID of share sender
* @param string $shareWith email address of share receiver
* @param \DateTime $expiration
* @throws \Exception If mail couldn't be sent
*/
protected function sendMailNotification($filename,
$link,
$initiator,
$shareWith) {
$shareWith,
\DateTime $expiration) {
$initiatorUser = $this->userManager->get($initiator);
$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
$subject = (string)$this->l->t('%s shared »%s« with you', array($initiatorDisplayName, $filename));
@ -725,6 +728,12 @@ class Manager implements IManager {
$message = $this->mailer->createMessage();
$emailTemplate = $this->mailer->createEMailTemplate();
$emailTemplate->setMetaData('files_sharing.RecipientNotification', [
'filename' => $filename,
'link' => $link,
'initiator' => $initiatorDisplayName,
'expiration' => $expiration,
]);
$emailTemplate->addHeader();
$emailTemplate->addHeading($this->l->t('%s shared »%s« with you', [$initiatorDisplayName, $filename]), false);

View File

@ -51,6 +51,13 @@ namespace OCP\Mail;
* @since 12.0.0
*/
interface IEMailTemplate {
/**
* Set meta data of an email
*
* @since 12.0.3
*/
public function setMetaData($emailId, array $data = []);
/**
* Adds a header to the email
*