diff options
Diffstat (limited to 'lib/public/Mail/IMessage.php')
| -rw-r--r-- | lib/public/Mail/IMessage.php | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/lib/public/Mail/IMessage.php b/lib/public/Mail/IMessage.php new file mode 100644 index 00000000000..20e4ea19c4c --- /dev/null +++ b/lib/public/Mail/IMessage.php @@ -0,0 +1,84 @@ +<?php +/** + * @copyright Copyright (c) 2017 Joas Schilling <coding@schilljs.com> + * + * @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 OCP\Mail; + +/** + * Class Message + * + * @package OCP\Mail + * @since 13.0.0 + */ +interface IMessage { + /** + * Set the from address of this message. + * + * If no "From" address is used \OC\Mail\Mailer will use mail_from_address and mail_domain from config.php + * + * @param array $addresses Example: array('sender@domain.org', 'other@domain.org' => 'A name') + * @return $this + * @since 13.0.0 + */ + public function setFrom(array $addresses); + + /** + * Set the Reply-To address of this message + * + * @param array $addresses + * @return $this + * @since 13.0.0 + */ + public function setReplyTo(array $addresses); + + /** + * Set the to addresses of this message. + * + * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name') + * @return $this + * @since 13.0.0 + */ + public function setTo(array $recipients); + + /** + * Set the CC recipients of this message. + * + * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name') + * @return $this + * @since 13.0.0 + */ + public function setCc(array $recipients); + + /** + * Set the BCC recipients of this message. + * + * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name') + * @return $this + * @since 13.0.0 + */ + public function setBcc(array $recipients); + + /** + * @param IEMailTemplate $emailTemplate + * @return $this + * @since 13.0.0 + */ + public function useTemplate(IEMailTemplate $emailTemplate); +} |