class SystemSendEmail

Provides "Send email" rules action.

@todo Define that message Context should be textarea comparing with textfield Subject @todo Add access callback information from Drupal 7.

Plugin annotation


@RulesAction(
  id = "rules_send_email",
  label = @Translation("Send email"),
  category = @Translation("System"),
  context_definitions = {
    "to" = @ContextDefinition("email",
      label = @Translation("Send to"),
      description = @Translation("Email address(es) drupal will send an email to."),
      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 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 SystemSendEmail

File

src/Plugin/RulesAction/SystemSendEmail.php, line 52

Namespace

Drupal\rules\Plugin\RulesAction
View source
class SystemSendEmail extends RulesActionBase implements ContainerFactoryPluginInterface {
    
    /**
     * The logger channel the action will write log messages to.
     *
     * @var \Drupal\Core\Logger\LoggerChannelInterface
     */
    protected $logger;
    
    /**
     * @var \Drupal\Core\Mail\MailManagerInterface
     */
    protected $mailManager;
    
    /**
     * Constructs a SystemSendEmail 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 channel.
     * @param \Drupal\Core\Mail\MailManagerInterface $mail_manager
     *   The mail manager service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerChannelInterface $logger, MailManagerInterface $mail_manager) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->logger = $logger;
        $this->mailManager = $mail_manager;
    }
    
    /**
     * {@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'));
    }
    
    /**
     * Send a system email.
     *
     * @param string[] $to
     *   Email addresses of the recipients.
     * @param string $subject
     *   Subject of the email.
     * @param string $message
     *   Email message text.
     * @param string|null $reply
     *   (optional) Reply to email address.
     * @param \Drupal\Core\Language\LanguageInterface|null $language
     *   (optional) Language code.
     */
    protected function doExecute(array $to, $subject, $message, $reply = NULL, LanguageInterface $language = NULL) {
        // ORIG.
        $langcode = isset($language) ? $language->getId() : LanguageInterface::LANGCODE_SITE_DEFAULT;
        // @todo Is this better?
        $langcode = isset($language) && $language->getId() != LanguageInterface::LANGCODE_NOT_SPECIFIED ? $language->getId() : LanguageInterface::LANGCODE_SITE_DEFAULT;
        $params = [
            'subject' => $subject,
            'message' => $message,
        ];
        // Set a unique key for this email.
        $key = 'rules_action_mail_' . $this->getPluginId();
        $recipients = implode(', ', $to);
        $message = $this->mailManager
            ->mail('rules', $key, $recipients, $langcode, $params, $reply);
        if ($message['result']) {
            $this->logger
                ->notice('Successfully sent email to %recipient', [
                '%recipient' => $recipients,
            ]);
        }
    }

}

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.
SystemSendEmail::$logger protected property The logger channel the action will write log messages to.
SystemSendEmail::$mailManager protected property
SystemSendEmail::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SystemSendEmail::doExecute protected function Send a system email.
SystemSendEmail::__construct public function Constructs a SystemSendEmail object.