class SystemEmailToUsersOfRole in Rules 8.3

Provides a 'Email to users of a role' action.

@RulesAction( id = "rules_email_to_users_of_role", label = @Translation("Send email to all users of a role"), category = @Translation("System"), context_definitions = { "roles" = @ContextDefinition("entity:user_role", label = @Translation("Roles"), description = @Translation("The roles to which to send the email."), multiple = TRUE ), "subject" = @ContextDefinition("string", label = @Translation("Subject"), description = @Translation("The email's subject.") ), "message" = @ContextDefinition("string", label = @Translation("Message"), description = @Translation("The email's message body. Drupal will by default remove all HTML tags. If you want to use HTML you must override this behavior by installing a contributed module such as Mime Mail.") ), "reply" = @ContextDefinition("email", label = @Translation("Reply to"), description = @Translation("The email's reply-to address. Leave it empty to use the site-wide configured address."), default_value = NULL, required = FALSE ), "language" = @ContextDefinition("language", label = @Translation("Language"), description = @Translation("If specified, the language object (not language code) used for getting the email message and subject."), default_value = NULL, required = FALSE ), } )

@todo Add access callback information from Drupal 7.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\rules\Core\RulesActionBase implements RulesActionInterface uses ContextProviderTrait, ConfigurationAccessControlTrait, ExecutablePluginTrait
    class \Drupal\rules\Plugin\RulesAction\SystemEmailToUsersOfRole implements ContainerFactoryPluginInterface

Expanded class hierarchy of SystemEmailToUsersOfRole

File

src/Plugin/RulesAction/SystemEmailToUsersOfRole.php, line 51

Namespace

Drupal\rules\Plugin\RulesAction

View source

class SystemEmailToUsersOfRole extends RulesActionBase implements ContainerFactoryPluginInterface {

  /**
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  protected $logger;

  /**
   * @var \Drupal\Core\Mail\MailManagerInterface
   */
  protected $mailManager;

  /**
   * @var \Drupal\user\UserStorageInterface
   */
  protected $userStorage;

  /**
   * Constructs a SystemEmailToUsersOfRole object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Logger\LoggerChannelInterface $logger
   *   The rules logger service.
   * @param \Drupal\Core\Mail\MailManagerInterface $mail_manager
   *   The mail manager service.
   * @param \Drupal\user\UserStorageInterface $userStorage
   *   The user storage service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerChannelInterface $logger, MailManagerInterface $mail_manager, UserStorageInterface $userStorage) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->logger = $logger;
    $this->mailManager = $mail_manager;
    $this->userStorage = $userStorage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('logger.factory')
      ->get('rules'), $container
      ->get('plugin.manager.mail'), $container
      ->get('entity_type.manager')
      ->getStorage('user'));
  }

  /**
   * Sends an email to all users of the specified role(s).
   *
   * @param \Drupal\user\RoleInterface[] $roles
   *   Array of user roles.
   * @param string $subject
   *   Subject of the email.
   * @param string $message
   *   Email message text.
   * @param string $reply
   *   (optional) Reply to email address.
   * @param \Drupal\Core\Language\LanguageInterface $language
   *   (optional) Language object. If not specified, email will be sent to each
   *   recipient in the recipient's preferred language.
   */
  protected function doExecute(array $roles, $subject, $message, $reply = NULL, LanguageInterface $language = NULL) {
    if (empty($roles)) {
      return;
    }
    $rids = array_map(function ($role) {
      return $role
        ->id();
    }, $roles);

    // Set a unique key for this email.
    $key = 'rules_action_mail_' . $this
      ->getPluginId();

    // Select only active users, based on the roles given. We do not want to
    // send email to blocked users.
    $accounts = $this->userStorage
      ->loadByProperties([
      'roles' => $rids,
      'status' => 1,
    ]);
    $params = [
      'subject' => $subject,
      'message' => $message,
    ];

    // Loop over users and send email to each individually using that user's
    // preferred language (or a fixed language, if passed in the context).
    $number = 0;
    foreach ($accounts as $account) {

      // Language to use. Value passed in the context takes precedence.
      $langcode = isset($language) ? $language
        ->getId() : $account
        ->getPreferredLangcode();
      $message = $this->mailManager
        ->mail('rules', $key, $account
        ->getEmail(), $langcode, $params, NULL);
      $number += $message['result'] ? 1 : 0;
    }
    $this->logger
      ->notice('Successfully sent email to %number out of %count users having the role(s) %roles', [
      '%number' => $number,
      '%count' => count($accounts),
      '%roles' => implode(', ', $rids),
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurationAccessControlTrait::checkConfigurationAccess	public	function	Checks configuration permission.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
ContextProviderTrait::$providedContext	protected	property	The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext	public	function
ContextProviderTrait::getProvidedContextDefinition	public	function
ContextProviderTrait::getProvidedContextDefinitions	public	function
ContextProviderTrait::setProvidedValue	public	function
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
ExecutablePluginTrait::getLabelValue	protected	function	Get the translated label from the plugin definition.
ExecutablePluginTrait::summary	public	function	Get the translated summary from the label annotation.	4
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RulesActionBase::$configuration	protected	property	The plugin configuration. Overrides PluginBase::$configuration
RulesActionBase::access	public	function	Checks object access. Overrides RulesActionInterface::access
RulesActionBase::assertMetadata	public	function	Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata
RulesActionBase::autoSaveContext	public	function	Returns a list of context names that should be auto-saved after execution. Overrides RulesActionInterface::autoSaveContext	14
RulesActionBase::calculateDependencies	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::defaultConfiguration	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute	2
RulesActionBase::executeMultiple	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::getConfiguration	public	function	@todo this documentation is not actually inherited from any interface.
RulesActionBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginBase::getContextValue
RulesActionBase::refineContextDefinitions	public	function	Refines used and provided context definitions based upon context values. Overrides ContextAwarePluginInterface::refineContextDefinitions	5
RulesActionBase::setConfiguration	public	function	@todo this documentation is not actually inherited from any interface.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
SystemEmailToUsersOfRole::$logger	protected	property
SystemEmailToUsersOfRole::$mailManager	protected	property
SystemEmailToUsersOfRole::$userStorage	protected	property
SystemEmailToUsersOfRole::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SystemEmailToUsersOfRole::doExecute	protected	function	Sends an email to all users of the specified role(s).
SystemEmailToUsersOfRole::__construct	public	function	Constructs a SystemEmailToUsersOfRole object. Overrides ContextAwarePluginBase::__construct
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class SystemEmailToUsersOfRole in Rules 8.3

Hierarchy

File

Namespace

Members

API Navigation