1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
<?php
/**
* @copyright 2017, Morris Jobke <hey@morrisjobke.de>
*
* @author Morris Jobke <hey@morrisjobke.de>
*
* @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 OC\Mail;
/**
* Interface IEMailTemplate
*
* Interface to a class that allows to build HTML emails
*
* Example:
*
* <?php
*
* $emailTemplate = new EMailTemplate($this->defaults);
*
* $emailTemplate->addHeader('https://example.org/img/logo-mail-header.png');
* $emailTemplate->addHeading('Welcome aboard');
* $emailTemplate->addBodyText('You have now an Nextcloud account, you can add, protect, and share your data.');
*
* $emailTemplate->addBodyButtonGroup(
* 'Set your password', 'https://example.org/resetPassword/q1234567890qwertz',
* 'Install Client', 'https://nextcloud.com/install/#install-clients'
* );
*
* $emailTemplate->addFooter(
* 'https://example.org/img/logo-mail-footer.png',
* 'Nextcloud - a safe home for your data <br>This is an automatically generated email, please do not reply.'
* );
*
* $htmlContent = $emailTemplate->renderHTML();
* $plainContent = $emailTemplate->renderText();
*/
interface IEMailTemplate {
/**
* Adds a header to the email
*
* @param string $logoUrl
*/
public function addHeader($logoUrl);
/**
* Adds a heading to the email
*
* @param string $title
*/
public function addHeading($title);
/**
* Adds a paragraph to the body of the email
*
* @param string $text
*/
public function addBodyText($text);
/**
* Adds a button group of two buttons to the body of the email
*
* @param string $textLeft Text of left button
* @param string $urlLeft URL of left button
* @param string $textRight Text of right button
* @param string $urlRight URL of right button
*/
public function addBodyButtonGroup($textLeft, $urlLeft, $textRight, $urlRight);
/**
* Adds a logo and a text to the footer. <br> in the text will be replaced by new lines in the plain text email
*
* @param string $logoUrl
* @param string $text
*/
public function addFooter($logoUrl, $text);
/**
* Returns the rendered HTML email as string
*
* @return string
*/
public function renderHTML();
/**
* Returns the rendered plain text email as string
*
* @return string
*/
public function renderText();
}
|
