drupal_mail()を使用してカスタムテンプレートでメールを送信する方法


31

このdrupal_mail()機能を使用してメールを送信したいのですが、カスタムHTMLテンプレートを使用して、ウェブサイトのデザインを維持しますが、フックやモジュールなどに完全に慣れているので、何らかの説明や初心者ガイドください。

自分でテンプレートを作成できます。テンプレートdrupal_mail()を使用する方法を知る必要があります。

回答:


39

カスタムモジュール経由でメールを送信しようとしている場合は、以下のガイドに従ってください。たとえば、「Commerce Canvas(commerce_canvas)」というモジュールが1つありました。最初に、Drupalのメール機能を変更して、リンクをサポートし、他のエンコードタイプを追加します


/**
 * Implements hook_mail_alter()
 * @param string $message
 */
function commerce_canvas_mail_alter(&$message) {
    $headers = array(
        'MIME-Version' => '1.0',
        'Content-Type' => 'text/html; charset=iso-8859-1; format=flowed',
        'Content-Transfer-Encoding' => '8Bit',
        'X-Mailer' => 'Drupal',
    );
    foreach ($headers as $key => $value) {
        $message['headers'][$key] = $value;
    }
}
  1. 次に、モジュールのHOOK_mailを次のようにフックします。

/**
 * Implements hook_mail()
 * @param string $key
 * @param string $message
 * @param unknown_type $params
 */
function commerce_canvas_mail($key, &$message, $params) {

    //Language Selection
    $options = array(
        'langcode' => $message['language']->language,
    );
    switch($key) {
        case "user_payment_notification" :
            $message['subject'] = isset($params['subject']) ? $params['subject'] : $message['subject'] = t('Payment recieved @site-name', array('@site-name' => variable_get('site_name', 'Express Canvas')), $options);
            $message['body'][] = isset($params['body']) ? $params['body'] : NULL;
            if (isset($params['headers']) && is_array($params['headers'])) {
                $message['headers'] += $params['headers'];
            }
            break;
    }
}


  1. 次に、モジュールからメールを呼び出すラッパー関数を作成する必要があります。

function commerce_canvas_mail_send(array $values = array()) {
    $module = $values['module'];
    $key = $values['key'];
    $to = $values['to'];
    $from = $values['form'];
    $language = isset($values['lang']) ? $values['lang'] : language_default();
    $params = array(
        'subject' => $values['subject'],
        'body' => $values['body'],
    );
    if(array_key_exists('headers', $values)) {
        $params['headers'] = $values['headers']; //Assumed as an array
    }
    $send = TRUE;
    $mail = drupal_mail($module, $key, $to, $language, $params, $from, $send);
    if($mail['result']) {
        return TRUE;
    } else {
        $error_msg = 'Failed to send the email in commerce_canvas Module';
        watchdog('canvas-email', $error_msg, array(), WATCHDOG_ALERT);
        return FALSE;
    }
}

この関数は電子メールを送信し、問題が発生した場合にデバッグメッセージを作成します。ただし、Drupal 7のデフォルトのDefaultMailSystemを独自に拡張する必要があるため、HTMLメールを送信することはできません。次のようにする必要があります、


class CommerceCanvasMailSystem extends DefaultMailSystem {
    /**
     * Concatenate and wrap the e-mail body for plain-text mails.
     *
     * @param $message
     *   A message array, as described in hook_mail_alter().
     *
     * @return
     *   The formatted $message.
     */
    public function format(array $message) {
        $message['body'] = implode("\n\n", $message['body']);
        return $message;
    }

    /**
     * Send an e-mail message, using Drupal variables and default settings.
     *
     * @see http://php.net/manual/en/function.mail.php
        * @see drupal_mail()
     *
     * @param $message
     *   A message array, as described in hook_mail_alter().
     * @return
     *   TRUE if the mail was successfully accepted, otherwise FALSE.
     */
    public function mail(array $message) {
        $mimeheaders = array();
        foreach ($message['headers'] as $name => $value) {
            $mimeheaders[] = $name . ': ' . mime_header_encode($value);
        }
        $line_endings = variable_get('mail_line_endings', MAIL_LINE_ENDINGS);
        return mail(
        $message['to'],
        mime_header_encode($message['subject']),
        // Note: e-mail uses CRLF for line-endings. PHP's API requires LF
        // on Unix and CRLF on Windows. Drupal automatically guesses the
        // line-ending format appropriate for your system. If you need to
        // override this, adjust $conf['mail_line_endings'] in settings.php.
        preg_replace('@\r?\n@', $line_endings, $message['body']),
        // For headers, PHP's API suggests that we use CRLF normally,
        // but some MTAs incorrectly replace LF with CRLF. See #234403.
        join("\n", $mimeheaders)
        );
    }
}


次に、hook_theme()でカスタムテンプレートファイルを呼び出す新しいテーマ関数を登録する必要があります。


/**
 * Implements hook_theme();
 */
function commerce_canvas_theme($existing, $type, $theme, $path) {
  if($type == 'module') {
    return array(
      'tracking_code_email' => array(
        'variables' => array(
          'image_path' => NULL,
          'user' => NULL,
          'page' => NULL,
        ),
        'template' => 'commerce-canvas-tracking-code',
        'path' => drupal_get_path('module', 'commerce_canvas').'/theme',
      ),

    );
  }
}

最後に、メールを送信するときにこのテーマ関数を呼び出す必要があります。



function a_custom_function($params) {

$email_text_user = theme('tracking_code_email', array(
                    'image_path' => $base_url . '/' . drupal_get_path('module', 'commerce_canvas') . '/images',
                    'user' => null,
                    'page' => array(
                        'greet_text' => t('Thank you for your order at Express Canvas. Your order is ready and has shipped. You may track your order using FedEx tracking with your tracking number: '.$order->field_tracking_number['und']['0']['value'].''),

                    ),
                ));
$sent_to_user = commerce_canvas_mail_send($email_values_user);

}

これらは、Drupal 7でHTMLメールを正しく処理するための完全なスニペットです。したがって、hook_themeでカスタムテンプレートを指定できます。


1
ご回答ありがとうございます。まさに私が求めたものです!残念ながら、関連する作業を見てきましたし、私のためにすべてを行うことができるモジュールがそこにあるので、自分のフックを作成するために急ぐ前に待つと思います。しかし、それは私が求めたすべてであるため、私はあなたの答えに十分に感謝することはできません。私は私が複数回賛成票を投じることができることを望んでいます
アンディ

11
素晴らしい答え。Drupalが基本的なことをとてもシンプルにする方法が大好きです
;

1
But still you won't be able to send the HTML mail...、 右。
エハズ14

@Ejay、はい、できます。これはそうします。
Aneek Mukhopadhyay

1
記録のため:次のモジュールを使用すると簡単です:drupal.org/project/simple_mail
gue

11

カスタムテンプレートを使用して送信メールのテーマを設定する場合は、HTMLメールモジュールを使用する必要があります

あなたがあなたのウェブサイトの残りをテーマにするのと同じ方法であなたのメッセージをテーマにすることができます。

PrintMail mimeなどの他のモジュールとうまく機能します。

HTMLメールを使用するには、メールシステムモジュールをインストールする必要があります。


1
HTML MailはMime MailではなくMail Mimeモジュールで動作することに注意してください(Mime MailとHTML Mailは同様のことを行い、互いに上書きします)。
パトリックケニー

@indrockご回答ありがとうございます。HTMLメールモジュールを使用して、phpコードを使用して送信されたテーマの電子メールを送信できるかどうか知っていますか?
アンディ

4

使用例:

    $module = 'module_name';
    $key = 'key';
    $language = language_default();
    $params = array();
    $from = NULL;
    $send = FALSE;
    $message = drupal_mail($module, $key, $email, $language, $params, $from, $send);

    $message['subject'] = $subject;
    $message['body'] = array();
    $message['body'][] = $line1;
    $message['body'][] = $line2;

    // Retrieve the responsible implementation for this message.
    $system = drupal_mail_system($module, $key);

    // Format the message body.
    $message = $system->format($message);

    // Send e-mail.
    $message['result'] = $system->mail($message);

4
常に使用してメールを送信することが推奨されてdrupal_mail()ではなく、$system->mail(..使用するためにhook_mail_alterのみメールを使用して送信されたために働く機能を(drupal_mail()
AjitS

私は、関数の使用方法を十分に認識しています(構文/コード賢明)、私はちょうど私が送信されたすべての電子メールに適用することができるようにテーマを作成する方法をお知りになりたいdrupal_mailなど、とにかくありがとう
アンディ・

私はこのコードを使用していますが、うまく機能していますが、空のメールが1つ送信されています。
vishal sirsodiya

3

HTML形式の電子メールを送信するには、Mimemailモジュールを使用できます。テンプレートをセットアップして構成したら、テンプレートを準備し、名前を付けmimemail-message.tpl.php、テーマディレクトリにドロップするだけで、すべての送信メールに自動的に適用されます(すべてのメールがMimemailによって送信されるように構成した場合) 。

モジュールのセットアップは、オーバーライドよりもおそらく簡単ですdrupal_mail()


ご回答ありがとうございます!このモジュールでPHPを使用してメールを送信できますか?もしそうなら、どのように私に教えてくれますか?
アンディ

Mimemailは、メールシステムモジュールと組み合わせると、サイトから送信されたすべての電子メールを引き継ぎます。したがって、カスタムモジュールを含む任意のモジュールによって送信されるすべての電子メールは、Mimemailを介して自動的に送信されます。影響を受ける電子メールを制限する場合は、メールシステムのモジュール構成オプションを使用できます。
パトリックケニー

1
これはアンディが正確に尋ねたものではないと思います。確かに、あなたはMimemailモジュールを必要とするか、またはこれを行うには、独自のMailSystemのロールが、アンディは、どのようにについて尋ねたことがありますテーマそれでhook_mail()関数内で行われるべきである電子メールの本文やテーマ(「my_custom_theme」)コール?
AyeshK

1
@Andyは、Mimemailモジュールに電子メールを送信するために呼び出すことができる関数があるかどうかを知りたいと思っています。
キアムルノ

@kiamlalunoあなたは正しいです、これは私が知りたいことです
アンディ
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.