nextcloud-server-mirror/lib/public/Mail/IEMailTemplate.php

<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCP\Mail;

/**
 * Interface IEMailTemplate
 *
 * Interface to a class that allows to build HTML emails
 *
 * Example:
 *
 * <?php
 *
 * $emailTemplate = new EMailTemplate($this->defaults, $this->urlGenerator, $this->l10n);
 *
 * $emailTemplate->addHeader();
 * $emailTemplate->addHeading('Welcome aboard');
 * $emailTemplate->addBodyText('Welcome to your 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('Optional footer text');
 *
 * $htmlContent = $emailTemplate->renderHtml();
 * $plainContent = $emailTemplate->renderText();
 *
 * @since 12.0.0
 */
interface IEMailTemplate {
	/**
	 * Note for content written by a user, e.g. a share note
	 *
	 * @since 36.0.0
	 */
	public const NOTE_NEUTRAL = 'neutral';
	/**
	 * @since 36.0.0
	 */
	public const NOTE_INFO = 'info';
	/**
	 * @since 36.0.0
	 */
	public const NOTE_WARNING = 'warning';
	/**
	 * @since 36.0.0
	 */
	public const NOTE_ERROR = 'error';

	/**
	 * Sets the subject of the email
	 *
	 * @param string $subject
	 *
	 * @since 13.0.0
	 */
	public function setSubject(string $subject);

	/**
	 * Adds a header to the email
	 *
	 * @since 12.0.0
	 */
	public function addHeader();

	/**
	 * Sets the language of the recipient
	 *
	 * Used for the lang and dir attributes of the HTML email, mirrors the
	 * layout for right-to-left languages, and is the default language of
	 * the footer. Call it before addFooter().
	 *
	 * @param string $language Language code, e.g. `ar` or `pt_BR`
	 *
	 * @since 36.0.0
	 */
	public function setLanguage(string $language): void;

	/**
	 * Adds a heading to the email
	 *
	 * @param string $title
	 * @param string|bool $plainTitle Title that is used in the plain text email
	 *                                if empty the $title is used, if false none will be used
	 *
	 * @since 12.0.0
	 */
	public function addHeading(string $title, $plainTitle = '');

	/**
	 * Adds a paragraph to the body of the email
	 *
	 * @param string $text; Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email
	 * @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
	 *
	 * @since 12.0.0
	 */
	public function addBodyText(string $text, $plainText = '');

	/**
	 * Adds a list item to the body of the email
	 *
	 * @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
	 * @param string $icon Absolute path, must be 16*16 pixels
	 * @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
	 * @param string|bool $plainMetaInfo Meta info that is used in the plain text email
	 *                                   if empty the $metaInfo is used, if false none will be used
	 * @param integer plainIndent If > 0, Indent plainText by this amount.
	 * @since 12.0.0
	 */
	public function addBodyListItem(string $text, string $metaInfo = '', string $icon = '', $plainText = '', $plainMetaInfo = '', $plainIndent = 0);

	/**
	 * Adds a button group of two buttons to the body of the email
	 *
	 * @param string $textLeft Text of left button; Note: When $plainTextLeft falls back to this, HTML is automatically escaped in the HTML email
	 * @param string $urlLeft URL of left button
	 * @param string $textRight Text of right button; Note: When $plainTextRight falls back to this, HTML is automatically escaped in the HTML email
	 * @param string $urlRight URL of right button
	 * @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
	 *
	 * @since 12.0.0
	 */
	public function addBodyButtonGroup(string $textLeft, string $urlLeft, string $textRight, string $urlRight, string $plainTextLeft = '', string $plainTextRight = '');

	/**
	 * Adds a button to the body of the email
	 *
	 * @param string $text Text of button; Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email
	 * @param string $url URL of button
	 * @param string|false $plainText Text of button in plain text version
	 *                                if empty the $text is used, if false none will be used
	 *
	 * @since 12.0.0
	 */
	public function addBodyButton(string $text, string $url, $plainText = '');

	/**
	 * Adds a row of buttons to the body of the email, the first one is the primary action
	 *
	 * @param non-empty-list<array{text: string, url: string}> $buttons
	 * @param string $label Optional text shown above the buttons, e.g. "Will you attend?"
	 *
	 * @since 36.0.0
	 */
	public function addBodyButtons(array $buttons, string $label = ''): void;

	/**
	 * Adds the person an email is about (sharer, organizer...), shown with an initials circle
	 *
	 * @param string $subline Optional second line, e.g. the email address
	 *
	 * @since 36.0.0
	 */
	public function addBodySender(string $displayName, string $subline = ''): void;

	/**
	 * Adds a highlighted box to the body of the email
	 *
	 * Use {@see self::NOTE_NEUTRAL} for content written by a user (share note,
	 * event description), the other types for messages from the server itself.
	 * Line breaks in $text are kept. A short note about a shared item goes
	 * before its details card, longer content like an event description after it.
	 *
	 * @param string $label Label above the text for neutral notes, bold title before it for the other types
	 * @param self::NOTE_* $type
	 *
	 * @since 36.0.0
	 */
	public function addBodyNote(string $text, string $label = '', string $type = self::NOTE_NEUTRAL): void;

	/**
	 * Adds a card with a title and labelled rows to the body of the email
	 *
	 * @since 36.0.0
	 */
	public function addBodyDetails(EMailDetails $details): void;

	/**
	 * 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 $text If the text is empty the default "Name - Slogan<br>This is an automatically sent email" will be used
	 * @param string $lang Optional language to set the default footer in
	 *
	 * @since 12.0.0
	 */
	public function addFooter(string $text = '', ?string $lang = null);

	/**
	 * Returns the rendered email subject as string
	 *
	 * @return string
	 *
	 * @since 13.0.0
	 */
	public function renderSubject(): string;

	/**
	 * Returns the rendered HTML email as string
	 *
	 * @return string
	 *
	 * @since 12.0.0
	 */
	public function renderHtml(): string;

	/**
	 * Returns the rendered plain text email as string
	 *
	 * @return string
	 *
	 * @since 12.0.0
	 */
	public function renderText(): string;
}