SendOrderEmail.php in Ubercart 8.4

Namespace

Drupal\uc_order\Plugin\RulesAction

File

uc_order/src/Plugin/RulesAction/SendOrderEmail.php

<?php

namespace Drupal\uc_order\Plugin\RulesAction;

use Drupal\uc_order\OrderInterface;

/**
 * Provides a 'Send order email' action.
 *
 * @RulesAction(
 *   id = "uc_order_email",
 *   label = @Translation("Send an order email"),
 *   category = @Translation("Order"),
 *   context_definitions = {
 *     "order" = @ContextDefinition("entity:uc_order",
 *       label = @Translation("Order")
 *     ),
 *     "from" = @ContextDefinition("email",
 *       label = @Translation("Sender"),
 *       description = @Translation("Enter the 'From' email address, or leave blank to use your store email address. You may use order tokens for dynamic email addresses."),
 *       required = FALSE
 *     ),
 *     "addresses" = @ContextDefinition("email",
 *       label = @Translation("Recipients"),
 *       description = @Translation("Enter the email addresses to receive the notifications, one on each line. You may use order tokens for dynamic email addresses."),
 *       multiple = TRUE
 *     ),
 *     "subject" = @ContextDefinition("string",
 *       label = @Translation("Subject"),
 *       translatable = TRUE
 *     ),
 *     "message" = @ContextDefinition("string",
 *       label = @Translation("Message"),
 *       translatable = TRUE
 *     ),
 *     "format" = @ContextDefinition("string",
 *       label = @Translation("Message format"),
 *       list_options_callback = "messageFormats"
 *     )
 *   }
 * )
 */
class SendOrderEmail extends EmailActionBase {

  /**
   * Sends an email concerning an order.
   *
   * The 'Sender', 'Recipients', 'Subject', and 'Message' fields accept
   * order token replacements.
   *
   * @param \Drupal\uc_order\OrderInterface $order
   *   The order object.
   * @param string $from
   *   Sender's e-mail address.
   * @param string[] $addresses
   *   Recipients' e-mail addresses.
   * @param string $subject
   *   E-mail subject.
   * @param string $message
   *   E-mail body.
   * @param string $format
   *   Format filter machine name.
   */
  protected function doExecute(OrderInterface $order, $from, array $addresses, $subject, $message, $format) {
    $settings = [
      'from' => $from,
      'addresses' => $addresses,
      'subject' => $subject,
      'message' => $message,
      'format' => $format,
    ];

    // Additional token replacements applied to the subject and body
    // in uc_order_mail().
    $settings['replacements'] = [
      'uc_order' => $order,
    ];

    // Apply token replacements to the 'from' e-mail address.
    $from = $this->token
      ->replace($settings['from'], $settings['replacements']);
    if (empty($from)) {
      $from = uc_store_email_from();
    }

    // Split up our recipient e-mail addresses so we can send a
    // separate e-mail to each.
    $recipients = [];
    foreach ($addresses as $address) {
      $address = trim($address);

      // Remove blank lines.
      if (!empty($address)) {

        // Apply token replacements to the 'recipient' e-mail address.
        $recipients[] = $this->token
          ->replace($address, $settings['replacements']);
      }
    }

    // Use uc_order's hook_mail() to send a separate e-mail to each recipient.
    foreach ($recipients as $to) {
      $sent = $this->mailManager
        ->mail('uc_order', 'rules-action-email', $to, uc_store_mail_recipient_langcode($to), $settings, $from);
      if (!$sent['result']) {
        $this->logger
          ->get('uc_order')
          ->error('Attempt to e-mail @email concerning order @order_id failed.', [
          '@email' => $to,
          '@order_id' => $order
            ->id(),
        ]);
      }
    }
  }

}

Classes

Name	Description
SendOrderEmail	Provides a 'Send order email' action.