summaryrefslogtreecommitdiffstats
path: root/lib/private/Mail/IEMailTemplate.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Mail/IEMailTemplate.php')
-rw-r--r--lib/private/Mail/IEMailTemplate.php25
1 files changed, 14 insertions, 11 deletions
diff --git a/lib/private/Mail/IEMailTemplate.php b/lib/private/Mail/IEMailTemplate.php
index 5bf2b8e4394..0d660a35516 100644
--- a/lib/private/Mail/IEMailTemplate.php
+++ b/lib/private/Mail/IEMailTemplate.php
@@ -34,7 +34,7 @@ namespace OC\Mail;
*
* $emailTemplate = new EMailTemplate($this->defaults);
*
- * $emailTemplate->addHeader('https://example.org/img/logo-mail-header.png');
+ * $emailTemplate->addHeader();
* $emailTemplate->addHeading('Welcome aboard');
* $emailTemplate->addBodyText('You have now an Nextcloud account, you can add, protect, and share your data.');
*
@@ -43,21 +43,25 @@ namespace OC\Mail;
* '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.'
- * );
+ * $emailTemplate->addFooter('Optional footer text');
*
* $htmlContent = $emailTemplate->renderHTML();
* $plainContent = $emailTemplate->renderText();
*/
interface IEMailTemplate {
/**
+ * @param \OCA\Theming\ThemingDefaults $themingDefaults
+ * @param \OCP\IURLGenerator $urlGenerator
+ * @param \OCP\IL10N $l10n
+ */
+ public function __construct(\OCA\Theming\ThemingDefaults $themingDefaults,
+ \OCP\IURLGenerator $urlGenerator,
+ \OCP\IL10N $l10n);
+
+ /**
* Adds a header to the email
- *
- * @param string $logoUrl
*/
- public function addHeader($logoUrl);
+ public function addHeader();
/**
* Adds a heading to the email
@@ -86,10 +90,9 @@ interface IEMailTemplate {
/**
* 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);
+ public function addFooter($text = '');
/**
* Returns the rendered HTML email as string
@@ -104,4 +107,4 @@ interface IEMailTemplate {
* @return string
*/
public function renderText();
-} \ No newline at end of file
+}