Come utilizzare drupal_mail () per inviare e-mail con un modello personalizzato


31

Vorrei utilizzare la drupal_mail()funzione per inviare e-mail ma con un modello HTML personalizzato in modo che siano in linea con il design del mio sito Web ma sono un principiante completo di hook e moduli ecc., Quindi apprezzerei una sorta di spiegazione o guida per principianti per favore.

Posso creare il modello da solo, devo solo sapere come drupal_mail()usarlo.

Risposte:


39

Se stai cercando di inviare la posta tramite il tuo modulo personalizzato, puoi seguire la guida di seguito indicata. Supponiamo di avere un modulo chiamato "Commerce Canvas (commerce_canvas)" 1. Innanzitutto modifica la funzione di posta di Drupal per supportare i collegamenti e aggiungere altri tipi di codifica


/**
 * 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. Quindi, aggancia HOOK_mail nel tuo modulo come

/**
 * 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. Quindi è necessario creare una funzione wrapper per richiamare la posta dal modulo.

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;
    }
}

Questa funzione invierà l'e-mail e creerà messaggi di debug in caso di problemi. Ma non sarai ancora in grado di inviare la posta HTML perché devi estendere il DefaultMailSystem predefinito di Drupal 7 con il tuo. Quindi devi fare come segue,


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)
        );
    }
}


Successivamente è necessario registrare una nuova funzione tema che chiamerà il file modello personalizzato in 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',
      ),

    );
  }
}

Infine, è necessario chiamare questa funzione tema al momento dell'invio dell'e-mail come,



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);

}

Questi sono gli snippet completi per gestire correttamente l'email HTML in Drupal 7, quindi nel hook_theme puoi dare il tuo modello personalizzato.


1
Grazie mille per la tua risposta - è esattamente quello che ho chiesto! Purtroppo ora che ho visto il lavoro coinvolto e che ci sono moduli là fuori che potrebbero fare tutto per me, penso che aspetterò prima di correre a creare il mio hook. Tuttavia, non posso ringraziarti abbastanza per la tua risposta perché è tutto ciò che ho chiesto. Vorrei poter votare più di una volta
Andy,

11
Bella risposta. Adoro il modo in cui Drupal rende le cose di base così semplici ;-)
artfulrobot il

1
But still you won't be able to send the HTML mail..., destra.
Ejaz,

@Ejay, sì, puoi. Questo fa quello.
Aneek Mukhopadhyay,

1
Per la cronaca: è più facile usare il seguente modulo: drupal.org/project/simple_mail
gue

11

Se si desidera creare un tema per i messaggi in uscita con l'aiuto di modelli personalizzati, è necessario utilizzare il modulo Posta HTML .

Ti consente di temi i tuoi messaggi allo stesso modo in cui temi il resto del tuo sito web.

Funziona bene con altri moduli, come Print , Mail mime , ecc.

Devi installare il modulo Mail System per usare la posta HTML.


1
Nota che HTML Mail funziona con il modulo Mail Mime, non con Mime Mail (Mime Mail e HTML Mail fanno cose simili e si sostituiscono).
Patrick Kenny

@indrock Grazie anche per la tua risposta. Sai se posso usare il modulo di posta HTML per i temi e-mail inviati utilizzando il codice php?
Andy,

4

Esempio di utilizzo:

    $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
Si consiglia sempre di inviare le e-mail utilizzando drupal_mail()anziché $system->mail(..per utilizzare la hook_mail_alterfunzione (che funziona solo per le e-mail inviate utilizzando drupal_mail().
AjitS

Sono pienamente consapevole di come utilizzare la funzione (sintassi / codice saggio), vorrei solo sapere come creare un tema in modo da poter applicare a tutte le e-mail inviate con drupal_mailecc, ma grazie comunque
Andy

Sto usando questo codice, funziona benissimo ma ha inviato anche una mail vuota.
vishal sirsodiya,

3

Per inviare e-mail HTML, è possibile utilizzare il modulo Mimemail . Una volta impostato e configurato, puoi semplicemente preparare il modello, nominarlo mimemail-message.tpl.php, rilasciarlo nella directory dei temi e verrà automaticamente applicato a tutta la posta elettronica in uscita (supponendo che tu abbia configurato tutta la posta per essere inviata da Mimemail) .

La configurazione del modulo è probabilmente più semplice della sostituzione drupal_mail().


La ringrazio per la risposta! Posso inviare e-mail usando PHP con questo modulo? Se è così, potresti mostrarmi come, per favore?
Andy,

Mimemail, quando combinato con il modulo Mail System, prenderà in carico tutte le e-mail inviate dal sito. Pertanto, tutte le e-mail inviate da qualsiasi modulo, compresi i moduli personalizzati, verranno automaticamente inviate tramite Mimemail. Se si desidera limitare quali e-mail sono interessate, è possibile utilizzare le opzioni di configurazione dei moduli del sistema di posta.
Patrick Kenny

1
Penso che non sia esattamente quello che ha chiesto Andy. È vero, avrai bisogno del modulo Mimemail o esegui il rollup del tuo MailSystem per farlo, ma potrebbe essere chiesto ad Andy su come tema il corpo dell'email che dovrebbe essere fatto nella funzione hook_mail () e un tema ('my_custom_theme') in esso?
AyeshK

1
Penso che @Andy voglia sapere se il modulo Mimemail ha una funzione che può essere chiamata per inviare e-mail.
kiamlaluno

@kiamlaluno Hai ragione, questo è quello che vorrei sapere per favore
Andy
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.