class SendAccountEmail

Provides a 'Send account email' action.

@todo Add access callback information from Drupal 7.

Plugin annotation


@RulesAction(
  id = "rules_send_account_email",
  label = @Translation("Send account email"),
  category = @Translation("User"),
  context_definitions = {
    "user" = @ContextDefinition("entity:user",
      label = @Translation("User"),
      description = @Translation("The user to whom we send the email.")
    ),
    "email_type" = @ContextDefinition("string",
      label = @Translation("Email type"),
      description = @Translation("The type of the email to send."),
      options_provider = "\Drupal\rules\TypedData\Options\EmailTypeOptions",
    ),
  }
)

Hierarchy

Expanded class hierarchy of SendAccountEmail

File

src/Plugin/RulesAction/SendAccountEmail.php, line 33

Namespace

Drupal\rules\Plugin\RulesAction
View source 
class SendAccountEmail extends RulesActionBase implements ContainerFactoryPluginInterface {
    
    /**
     * @var \Drupal\Core\Logger\LoggerChannelInterface
     */
    protected $logger;
    
    /**
     * Constructs a SendAccountEmail 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.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerChannelInterface $logger) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->logger = $logger;
    }
    
    /**
     * {@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'));
    }
    
    /**
     * Send account email.
     *
     * @param \Drupal\user\UserInterface $user
     *   User who should receive the notification.
     * @param string $email_type
     *   Type of email to be sent.
     */
    protected function doExecute(UserInterface $user, $email_type) {
        $message = _user_mail_notify($email_type, $user);
        // Log the success or failure.
        if (!$message['result']) {
            $this->logger
                ->notice('%type email sent to %recipient.', [
                '%type' => $email_type,
                '%recipient' => $user->mail,
            ]);
        }
        else {
            $this->logger
                ->error('Failed to send %type email to %recipient.', [
                '%type' => $email_type,
                '%recipient' => $user->mail,
            ]);
        }
    }

}

Members

Title 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.
SendAccountEmail::$logger protected property
SendAccountEmail::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SendAccountEmail::doExecute protected function Send account email.
SendAccountEmail::__construct public function Constructs a SendAccountEmail object.