interface MailHandlerInterface

Same name and namespace in other branches
  1. 8.9.x core/modules/contact/src/MailHandlerInterface.php \Drupal\contact\MailHandlerInterface
  2. 10 core/modules/contact/src/MailHandlerInterface.php \Drupal\contact\MailHandlerInterface
  3. 11.x core/modules/contact/src/MailHandlerInterface.php \Drupal\contact\MailHandlerInterface

Provides an interface for assembly and dispatch of contact mail messages.

Hierarchy

Expanded class hierarchy of MailHandlerInterface

All classes that implement MailHandlerInterface

File

core/modules/contact/src/MailHandlerInterface.php, line 10

Namespace

Drupal\contact
View source
interface MailHandlerInterface {
    
    /**
     * Sends mail messages as appropriate for a given Message form submission.
     *
     * Can potentially send up to three messages as follows:
     * - To the configured recipient;
     * - Auto-reply to the sender; and
     * - Carbon copy to the sender.
     *
     * @param \Drupal\contact\MessageInterface $message
     *   Submitted message entity.
     * @param \Drupal\Core\Session\AccountInterface $sender
     *   User that submitted the message entity form.
     *
     * @throws \Drupal\contact\MailHandlerException
     *   When unable to determine message recipient.
     */
    public function sendMailMessages(MessageInterface $message, AccountInterface $sender);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
MailHandlerInterface::sendMailMessages public function Sends mail messages as appropriate for a given Message form submission. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.