MailHandlerInterface.php

Same filename and directory in other branches
  1. 8.9.x core/modules/contact/src/MailHandlerInterface.php
  2. 10 core/modules/contact/src/MailHandlerInterface.php
  3. 11.x core/modules/contact/src/MailHandlerInterface.php

Namespace

Drupal\contact

File

core/modules/contact/src/MailHandlerInterface.php

View source
<?php

namespace Drupal\contact;

use Drupal\Core\Session\AccountInterface;

/**
 * Provides an interface for assembly and dispatch of contact mail messages.
 */
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);

}

Interfaces

Title Deprecated Summary
MailHandlerInterface Provides an interface for assembly and dispatch of contact mail messages.

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