class SystemEmailToUsersOfRole

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

@todo Add access callback information from Drupal 7.

Plugin annotation


@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."),
      options_provider = "\Drupal\rules\TypedData\Options\RolesOptions",
      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."),
      options_provider = "\Drupal\rules\TypedData\Options\LanguageOptions",
      default_value = NULL,
      required = FALSE
    ),
  }
)

Hierarchy

Expanded class hierarchy of SystemEmailToUsersOfRole

File

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

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.
            // ORIG.
            $langcode = isset($language) ? $language->getId() : $account->getPreferredLangcode();
            // @todo Is this better?
            $langcode = isset($language) && $language->getId() != LanguageInterface::LANGCODE_NOT_SPECIFIED ? $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

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
ConfigurationAccessControlTrait::checkConfigurationAccess public function Checks configuration permission.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function Aliased as: traitGetContextValue
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
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
ContextProviderTrait::upcastEntityId public function Upcasts an entity id to a full entity object.
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
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RulesActionBase::$configuration protected property The plugin 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 ContextAwarePluginInterface::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.
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.