You are here

interface WebformEmailProviderInterface in Webform 8.5

Same name and namespace in other branches
  1. 6.x src/WebformEmailProviderInterface.php \Drupal\webform\WebformEmailProviderInterface

Defines the interface for webform email provider.

Hierarchy

Expanded class hierarchy of WebformEmailProviderInterface

All classes that implement WebformEmailProviderInterface

File

src/WebformEmailProviderInterface.php, line 8

Namespace

Drupal\webform
View source
interface WebformEmailProviderInterface {

  /**
   * Get list of known contrib module that support HTML email.
   *
   * @return array
   *   An array containing known contrib module that support HTML email.
   */
  public function getModules();

  /**
   * Check if the Webform module should provide support for sending HTML emails.
   */
  public function check();

  /**
   * Check if webform email handler is installed.
   */
  public function installed();

  /**
   * Install webform's PHP mail handler which supports sending HTML emails.
   */
  public function install();

  /**
   * Uninstall webform's PHP mail handler which supports sending HTML emails.
   */
  public function uninstall();

  /**
   * Get the HTML email provider module machine name.
   *
   * @return bool|string
   *   The HTML email provider module machine name.
   */
  public function getModule();

  /**
   * Get the HTML email provider human readable module name.
   *
   * @return bool|string
   *   The HTML email provider module name.
   */
  public function getModuleName();

  /**
   * Determine if mail module is installed and enabled.
   *
   * @param string $module
   *   Mail module name.
   *
   * @return bool
   *   TRUE if mail module is installed and enabled.
   */
  public function moduleEnabled($module);

  /**
   * Get the mail back-end plugin id.
   *
   * @return string
   *   The email handler plugin id.
   */
  public function getMailPluginId();

  /**
   * Get the mail back-end plugin definition.
   *
   * @return array
   *   A plugin definition array.
   */
  public function getMailPluginDefinition();

}

Members

Namesort descending Modifiers Type Description Overrides
WebformEmailProviderInterface::check public function Check if the Webform module should provide support for sending HTML emails. 1
WebformEmailProviderInterface::getMailPluginDefinition public function Get the mail back-end plugin definition. 1
WebformEmailProviderInterface::getMailPluginId public function Get the mail back-end plugin id. 1
WebformEmailProviderInterface::getModule public function Get the HTML email provider module machine name. 1
WebformEmailProviderInterface::getModuleName public function Get the HTML email provider human readable module name. 1
WebformEmailProviderInterface::getModules public function Get list of known contrib module that support HTML email. 1
WebformEmailProviderInterface::install public function Install webform's PHP mail handler which supports sending HTML emails. 1
WebformEmailProviderInterface::installed public function Check if webform email handler is installed. 1
WebformEmailProviderInterface::moduleEnabled public function Determine if mail module is installed and enabled. 1
WebformEmailProviderInterface::uninstall public function Uninstall webform's PHP mail handler which supports sending HTML emails. 1