2017-04-06 21:20:47 +03:00
|
|
|
<?php
|
2019-12-03 21:57:53 +03:00
|
|
|
|
2018-03-01 23:15:39 +03:00
|
|
|
declare(strict_types=1);
|
2019-12-03 21:57:53 +03:00
|
|
|
|
2017-04-06 21:20:47 +03:00
|
|
|
/**
|
|
|
|
* @copyright 2017, Morris Jobke <hey@morrisjobke.de>
|
|
|
|
*
|
2017-11-06 17:56:42 +03:00
|
|
|
* @author Joas Schilling <coding@schilljs.com>
|
|
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
2017-04-06 21:20:47 +03:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2019-12-03 21:57:53 +03:00
|
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
2017-04-06 21:20:47 +03:00
|
|
|
*
|
|
|
|
* @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
|
2019-12-03 21:57:53 +03:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2017-04-06 21:20:47 +03:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2017-04-11 17:35:46 +03:00
|
|
|
namespace OCP\Mail;
|
2017-04-07 23:42:43 +03:00
|
|
|
|
2017-04-06 21:20:47 +03:00
|
|
|
/**
|
|
|
|
* Interface IEMailTemplate
|
|
|
|
*
|
|
|
|
* Interface to a class that allows to build HTML emails
|
|
|
|
*
|
|
|
|
* Example:
|
|
|
|
*
|
|
|
|
* <?php
|
|
|
|
*
|
2017-04-07 23:42:43 +03:00
|
|
|
* $emailTemplate = new EMailTemplate($this->defaults, $this->urlGenerator, $this->l10n);
|
2017-04-06 21:20:47 +03:00
|
|
|
*
|
2017-04-07 15:51:05 +03:00
|
|
|
* $emailTemplate->addHeader();
|
2017-04-06 21:20:47 +03:00
|
|
|
* $emailTemplate->addHeading('Welcome aboard');
|
2017-11-09 11:24:35 +03:00
|
|
|
* $emailTemplate->addBodyText('Welcome to your Nextcloud account, you can add, protect, and share your data.');
|
2017-04-06 21:20:47 +03:00
|
|
|
*
|
|
|
|
* $emailTemplate->addBodyButtonGroup(
|
|
|
|
* 'Set your password', 'https://example.org/resetPassword/q1234567890qwertz',
|
|
|
|
* 'Install Client', 'https://nextcloud.com/install/#install-clients'
|
|
|
|
* );
|
|
|
|
*
|
2017-04-07 15:51:05 +03:00
|
|
|
* $emailTemplate->addFooter('Optional footer text');
|
2017-04-06 21:20:47 +03:00
|
|
|
*
|
2017-04-19 01:09:25 +03:00
|
|
|
* $htmlContent = $emailTemplate->renderHtml();
|
2017-04-06 21:20:47 +03:00
|
|
|
* $plainContent = $emailTemplate->renderText();
|
2017-04-11 17:35:46 +03:00
|
|
|
*
|
|
|
|
* @since 12.0.0
|
2017-04-06 21:20:47 +03:00
|
|
|
*/
|
|
|
|
interface IEMailTemplate {
|
2017-08-24 18:54:22 +03:00
|
|
|
|
2017-09-15 11:51:55 +03:00
|
|
|
/**
|
|
|
|
* Sets the subject of the email
|
|
|
|
*
|
|
|
|
* @param string $subject
|
|
|
|
*
|
|
|
|
* @since 13.0.0
|
|
|
|
*/
|
2018-03-01 23:15:39 +03:00
|
|
|
public function setSubject(string $subject);
|
2017-09-15 11:51:55 +03:00
|
|
|
|
2017-04-06 21:20:47 +03:00
|
|
|
/**
|
|
|
|
* Adds a header to the email
|
2017-04-11 17:35:46 +03:00
|
|
|
*
|
|
|
|
* @since 12.0.0
|
2017-04-06 21:20:47 +03:00
|
|
|
*/
|
2017-04-07 15:51:05 +03:00
|
|
|
public function addHeader();
|
2017-04-06 21:20:47 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds a heading to the email
|
|
|
|
*
|
|
|
|
* @param string $title
|
2017-07-19 16:37:03 +03:00
|
|
|
* @param string|bool $plainTitle Title that is used in the plain text email
|
2017-04-12 16:33:14 +03:00
|
|
|
* if empty the $title is used, if false none will be used
|
2017-04-11 17:35:46 +03:00
|
|
|
*
|
|
|
|
* @since 12.0.0
|
2017-04-06 21:20:47 +03:00
|
|
|
*/
|
2018-03-01 23:15:39 +03:00
|
|
|
public function addHeading(string $title, $plainTitle = '');
|
2017-04-06 21:20:47 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds a paragraph to the body of the email
|
|
|
|
*
|
2018-02-16 11:44:35 +03:00
|
|
|
* @param string $text; Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email
|
2017-04-12 12:52:33 +03:00
|
|
|
* @param string|bool $plainText Text that is used in the plain text email
|
|
|
|
* if empty the $text is used, if false none will be used
|
2017-04-11 17:35:46 +03:00
|
|
|
*
|
|
|
|
* @since 12.0.0
|
2017-04-06 21:20:47 +03:00
|
|
|
*/
|
2018-03-01 23:15:39 +03:00
|
|
|
public function addBodyText(string $text, $plainText = '');
|
2017-04-06 21:20:47 +03:00
|
|
|
|
2017-04-24 14:48:27 +03:00
|
|
|
/**
|
|
|
|
* Adds a list item to the body of the email
|
|
|
|
*
|
2018-02-16 11:44:35 +03:00
|
|
|
* @param string $text; Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email
|
|
|
|
* @param string $metaInfo; Note: When $plainMetaInfo falls back to this, HTML is automatically escaped in the HTML email
|
2017-04-25 15:31:21 +03:00
|
|
|
* @param string $icon Absolute path, must be 16*16 pixels
|
2018-03-05 11:06:40 +03:00
|
|
|
* @param string|bool $plainText Text that is used in the plain text email
|
2017-04-25 15:31:21 +03:00
|
|
|
* if empty the $text is used, if false none will be used
|
2018-03-05 11:06:40 +03:00
|
|
|
* @param string|bool $plainMetaInfo Meta info that is used in the plain text email
|
2017-04-25 15:31:21 +03:00
|
|
|
* if empty the $metaInfo is used, if false none will be used
|
2020-09-02 18:16:24 +03:00
|
|
|
* @param integer plainIndent If > 0, Indent plainText by this amount.
|
2017-04-24 14:48:27 +03:00
|
|
|
* @since 12.0.0
|
|
|
|
*/
|
2020-09-02 18:16:24 +03:00
|
|
|
public function addBodyListItem(string $text, string $metaInfo = '', string $icon = '', $plainText = '', $plainMetaInfo = '', $plainIndent = 0);
|
2017-04-24 14:48:27 +03:00
|
|
|
|
2017-04-06 21:20:47 +03:00
|
|
|
/**
|
|
|
|
* Adds a button group of two buttons to the body of the email
|
|
|
|
*
|
2018-02-16 11:44:35 +03:00
|
|
|
* @param string $textLeft Text of left button; Note: When $plainTextLeft falls back to this, HTML is automatically escaped in the HTML email
|
2017-04-06 21:20:47 +03:00
|
|
|
* @param string $urlLeft URL of left button
|
2018-02-16 11:44:35 +03:00
|
|
|
* @param string $textRight Text of right button; Note: When $plainTextRight falls back to this, HTML is automatically escaped in the HTML email
|
2017-04-06 21:20:47 +03:00
|
|
|
* @param string $urlRight URL of right button
|
2017-04-12 01:45:05 +03:00
|
|
|
* @param string $plainTextLeft Text of left button that is used in the plain text version - if empty the $textLeft is used
|
|
|
|
* @param string $plainTextRight Text of right button that is used in the plain text version - if empty the $textRight is used
|
2017-04-11 17:35:46 +03:00
|
|
|
*
|
|
|
|
* @since 12.0.0
|
2017-04-06 21:20:47 +03:00
|
|
|
*/
|
2018-03-01 23:15:39 +03:00
|
|
|
public function addBodyButtonGroup(string $textLeft, string $urlLeft, string $textRight, string $urlRight, string $plainTextLeft = '', string $plainTextRight = '');
|
2017-04-06 21:20:47 +03:00
|
|
|
|
2017-04-12 00:13:34 +03:00
|
|
|
/**
|
|
|
|
* Adds a button to the body of the email
|
|
|
|
*
|
2018-02-16 11:44:35 +03:00
|
|
|
* @param string $text Text of button; Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email
|
2017-04-12 00:13:34 +03:00
|
|
|
* @param string $url URL of button
|
2017-04-12 01:24:58 +03:00
|
|
|
* @param string $plainText Text of button in plain text version
|
|
|
|
* if empty the $text is used, if false none will be used
|
2017-04-12 00:13:34 +03:00
|
|
|
*
|
|
|
|
* @since 12.0.0
|
|
|
|
*/
|
2018-03-02 09:50:35 +03:00
|
|
|
public function addBodyButton(string $text, string $url, $plainText = '');
|
2017-04-12 00:13:34 +03:00
|
|
|
|
2017-04-06 21:20:47 +03:00
|
|
|
/**
|
|
|
|
* Adds a logo and a text to the footer. <br> in the text will be replaced by new lines in the plain text email
|
|
|
|
*
|
2017-04-18 10:53:02 +03:00
|
|
|
* @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically sent email" will be used
|
2020-03-31 15:02:39 +03:00
|
|
|
* @param string $lang Optional language to set the default footer in
|
2017-04-11 17:35:46 +03:00
|
|
|
*
|
|
|
|
* @since 12.0.0
|
2017-04-06 21:20:47 +03:00
|
|
|
*/
|
2020-03-31 15:02:39 +03:00
|
|
|
public function addFooter(string $text = '', ?string $lang = null);
|
2017-04-06 21:20:47 +03:00
|
|
|
|
2017-09-15 11:51:55 +03:00
|
|
|
/**
|
|
|
|
* Returns the rendered email subject as string
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*
|
|
|
|
* @since 13.0.0
|
|
|
|
*/
|
2018-03-01 23:15:39 +03:00
|
|
|
public function renderSubject(): string;
|
2017-09-15 11:51:55 +03:00
|
|
|
|
2017-04-06 21:20:47 +03:00
|
|
|
/**
|
|
|
|
* Returns the rendered HTML email as string
|
|
|
|
*
|
|
|
|
* @return string
|
2017-04-11 17:35:46 +03:00
|
|
|
*
|
|
|
|
* @since 12.0.0
|
2017-04-06 21:20:47 +03:00
|
|
|
*/
|
2018-03-01 23:15:39 +03:00
|
|
|
public function renderHtml(): string;
|
2017-04-06 21:20:47 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the rendered plain text email as string
|
|
|
|
*
|
|
|
|
* @return string
|
2017-04-11 17:35:46 +03:00
|
|
|
*
|
|
|
|
* @since 12.0.0
|
2017-04-06 21:20:47 +03:00
|
|
|
*/
|
2018-03-01 23:15:39 +03:00
|
|
|
public function renderText(): string;
|
2017-04-07 15:51:05 +03:00
|
|
|
}
|