annotate core/modules/contact/src/MailHandlerInterface.php @ 11:bfffd8d7479a

Move drupal/core from "replace" to "require" section, to ensure Composer updates it
author Chris Cannam
date Fri, 23 Feb 2018 15:51:18 +0000
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\contact;
Chris@0 4
Chris@0 5 use Drupal\Core\Session\AccountInterface;
Chris@0 6
Chris@0 7 /**
Chris@0 8 * Provides an interface for assembly and dispatch of contact mail messages.
Chris@0 9 */
Chris@0 10 interface MailHandlerInterface {
Chris@0 11
Chris@0 12 /**
Chris@0 13 * Sends mail messages as appropriate for a given Message form submission.
Chris@0 14 *
Chris@0 15 * Can potentially send up to three messages as follows:
Chris@0 16 * - To the configured recipient;
Chris@0 17 * - Auto-reply to the sender; and
Chris@0 18 * - Carbon copy to the sender.
Chris@0 19 *
Chris@0 20 * @param \Drupal\contact\MessageInterface $message
Chris@0 21 * Submitted message entity.
Chris@0 22 * @param \Drupal\Core\Session\AccountInterface $sender
Chris@0 23 * User that submitted the message entity form.
Chris@0 24 *
Chris@0 25 * @throws \Drupal\contact\MailHandlerException
Chris@0 26 * When unable to determine message recipient.
Chris@0 27 */
Chris@0 28 public function sendMailMessages(MessageInterface $message, AccountInterface $sender);
Chris@0 29
Chris@0 30 }