interface AmazonSesHandlerInterface in Amazon SES 2.0.x

Interface for the Amazon SES handler.

Hierarchy

• interface \Drupal\amazon_ses\AmazonSesHandlerInterface

File

src/AmazonSesHandlerInterface.php, line 8

Namespace

Drupal\amazon_ses

interface AmazonSesHandlerInterface {

  /**
   * Send an email using the AWS SDK.
   *
   * @param array $message
   *   An array of message data.
   *
   * @return string|bool
   *   The message ID tf successful, or FALSE if an error occurs.
   */
  public function send(array $message);

  /**
   * Get verified identities.
   *
   * @return array
   *   An array of verified indentities.
   */
  public function getIdentities();

  /**
   * Verify an identity.
   *
   * @param string $identity
   *   The identity to verify.
   * @param string $type
   *   The type of the identity, domain or email.
   */
  public function verifyIdentity($identity, $type);

  /**
   * Delete a verified identity.
   *
   * @param string $identity
   *   The identity to delete.
   */
  public function deleteIdentity($identity);

  /**
   * Get sending quota.
   *
   * @return array
   *   An array of quota information.
   */
  public function getSendQuota();

  /**
   * Get sending statistics.
   *
   * @return array
   *   An array of statistics.
   */
  public function getSendStatistics();

}

Members

Name	Modifiers	Type	Description	Overrides
AmazonSesHandlerInterface::deleteIdentity	public	function	Delete a verified identity.	1
AmazonSesHandlerInterface::getIdentities	public	function	Get verified identities.	1
AmazonSesHandlerInterface::getSendQuota	public	function	Get sending quota.	1
AmazonSesHandlerInterface::getSendStatistics	public	function	Get sending statistics.	1
AmazonSesHandlerInterface::send	public	function	Send an email using the AWS SDK.	1
AmazonSesHandlerInterface::verifyIdentity	public	function	Verify an identity.	1