interface PhpmailerOauth2PluginInterface in PHPMailer SMTP 2.1.x

Interface for PHPMailer Oauth2 plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\ConfigurableInterface
  • interface \Drupal\phpmailer_smtp\Plugin\PhpmailerOauth2\PhpmailerOauth2PluginInterface

File

src/Plugin/PhpmailerOauth2/PhpmailerOauth2PluginInterface.php, line 13

Namespace

Drupal\phpmailer_smtp\Plugin\PhpmailerOauth2

interface PhpmailerOauth2PluginInterface extends PluginInspectionInterface, ContainerFactoryPluginInterface, PluginFormInterface, ConfigurableInterface {

  /**
   * Retrieves the human-readable name of the PHPMailer Oauth2 plugin.
   *
   * @return string
   *   The name of the plugin.
   */
  public function getName();

  /**
   * Retrieves the id of the PHPMailer OAuth2 plugin.
   *
   * @return string
   *   The id of the plugin.
   */
  public function getId();

  /**
   * Retrieves the auth options for PHPMailer OAuth.
   *
   * @return array
   *   The array of auth options, including the provider.
   */
  public function getAuthOptions();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	14
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	15
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	15
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	120
PhpmailerOauth2PluginInterface::getAuthOptions	public	function	Retrieves the auth options for PHPMailer OAuth.	1
PhpmailerOauth2PluginInterface::getId	public	function	Retrieves the id of the PHPMailer OAuth2 plugin.	1
PhpmailerOauth2PluginInterface::getName	public	function	Retrieves the human-readable name of the PHPMailer Oauth2 plugin.	1
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	37
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2