interface YamlFormEmailProviderInterface in YAML Form 8

Defines the interface for form email provider.

Hierarchy

• interface \Drupal\yamlform\YamlFormEmailProviderInterface

File

src/YamlFormEmailProviderInterface.php, line 8

Namespace

Drupal\yamlform

interface YamlFormEmailProviderInterface {

  /**
   * 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 YAML Form module should provide support for sending HTML emails.
   */
  public function check();

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

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

  /**
   * Uninstall form'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();

  /**
   * 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

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