drupal_mail（）を使用してカスタムテンプレートでメールを送信する方法
drupal_mail()関数を使用してメールを送信したいのですが、カスタムHTMLテンプレートを使用して、ウェブサイトのデザインに沿ったものにしていますが、フックやモジュールなどの完全な初心者なので、 dある種の説明に感謝するか、初心者ガイドをどうぞ。
テンプレートは自分で作成できます。drupal_mail()を使用する方法を知っている必要があります。
カスタムモジュール経由でメールを送信しようとしている場合は、下記のガイドに従ってください。たとえば、「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;
}
}
- 次に、次のようにモジュールの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;
}
}
- 次に、モジュールからメールを呼び出すラッパー関数を作成する必要があります。
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でカスタムテンプレートを指定できます。
カスタムテンプレートを使用して送信メールのテーマを設定する場合は、 HTML Mail モジュールを使用する必要があります。
Webサイトの他の部分と同じ方法でメッセージのテーマを設定できます。
Print 、 Mail mime などの他のモジュールとうまく連携します。
HTMLメールを使用するには、 Mail System モジュールをインストールする必要があります。
使用例：
$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);
HTML電子メールを送信するには、 Mimemail モジュールを使用できます。セットアップと構成が完了したら、テンプレートを準備し、_mimemail-message.tpl.php_という名前を付けて、テーマディレクトリにドロップすると、すべての送信メールに自動的に適用されます（すべてのメールをMimemailから送信されます）。
モジュールの設定は、drupal_mail()をオーバーライドするよりもおそらく簡単です。