interface OptOutInterface in Mass Contact 8

A service for managing user opt-outs of mass contact emails.

Hierarchy

• interface \Drupal\mass_Contact\OptOutInterface

File

src/OptOutInterface.php, line 8

Namespace

Drupal\mass_Contact

interface OptOutInterface {

  /**
   * Finds a list of users that have opted out of emails.
   *
   * @param \Drupal\mass_contact\Entity\MassContactCategoryInterface[] $categories
   *   An array of categories.
   *
   * @return int[]
   *   An array of account IDs that have opted out. This includes global opt-out
   *   as well. If opt-outs are disabled, this method always returns an empty
   *   array.
   */
  public function getOptOutAccounts(array $categories = []);

}

Members

Name	Modifiers	Type	Description	Overrides
OptOutInterface::getOptOutAccounts	public	function	Finds a list of users that have opted out of emails.	1