Question

I asked a question about that the action.class.php is getting very huge. There were a lot of useful answers. You can read here: Multiple action.class.php

Because of that the action.class.php is getting big there might be a problem that there is to much stuff in it. Okay, I got the model, so e.g. I can put the queries into lib/model/doctrine/… and move couple forms.

What is the best way to move the action concerning emails in symfony! Where should I put the code? Is there a better way to send emails in symfony?

Thanks!

Craphunter

My example:

if ($this->form->isValid()) {
            $formData = $this->form->getValues();
            $firstname = $this->userdata->getFirstname();
            $lastname = $this->userdate->getLastname();

            try {
                $message = Swift_Message::newInstance()
                        ->setFrom('[e-mail]')
                        ->setTo($this->shopdata->getEmail())
                        ->addReplyTo($this->userdata->getEmail())
                        ->setSubject($formData['subject'])
                        ->setBody($this->getPartial('emailcontact', $arguments = array(
                                    'firstname' => $firstname,
                                    'lastname' => $lastname,
                                    'message' => $formData['message'],
                                )));
                $this->getMailer()->send($message);
                $this->getUser()->setFlash('shop_name', $formData['email']);
                $this->getUser()->setFlash('name', $formData['name']);

            } catch (Exception $e) {

                $this->getUser()->setFlash('mailError', 'Technical Problem');
            }
            $this->redirect('aboutus/sendfeedbackthankyou');

Answer 1

I find it useful to put the sending code in a main class that extends sfActions. I usually throw there everything that is common used throughout the project (code for helping ajax use, etc).

Particularly for email, I have a static method

public static function mail($options, $mailer) {

    sfProjectConfiguration::getActive()->loadHelpers('Partial');

    $required = array('subject', 'parameters', 'to_email', 'to_name', 'html', 'text');
    foreach ($required as $option)
    {
      if (!isset($options[$option])) {
        throw new sfException("Required option $option not supplied to ef3Actions::mail");
      }
    }

    $address = array();
    if (isset($options['from_name']) && isset($options['from_email'])) {
      $address['fullname'] = $options['from_name'];
      $address['email'] = $options['from_email'];
    } else
      $address = self::getFromAddress();


    if(!isset($options['body_is_partial']) || $options['body_is_partial']==true ){

      $message = Swift_Message::newInstance()
          ->setFrom(array($address['email'] => $address['fullname']))
          ->setTo(array($options['to_email'] => $options['to_name']))
          ->setSubject($options['subject'])
          ->setBody(get_partial($options['html'], $options['parameters']), 'text/html')
          ->addPart(get_partial($options['text'], $options['parameters']), 'text/plain');

    } else {

      $message = Swift_Message::newInstance()
          ->setFrom(array($address['email'] => $address['fullname']))
          ->setTo(array($options['to_email'] => $options['to_name']))
          ->setSubject($options['subject'])
          ->setBody($options['html'], 'text/html')
          ->addPart($options['text'], 'text/plain');

    }

    if (isset($options['cc']) && !is_null($options['cc'])) {
      if (is_array($options['cc'])) {
        foreach ($options['cc'] as $key => $value) {
          if (!is_number($key))
            $message->addCc($key, $value);
          else
            $message->addCc($value);
        }
      } elseif (is_string($options['cc'])) {
        $message->addCc($options['cc']);
      }
    }

    if (isset($options['bcc']) && !is_null($options['bcc'])) {
      if (is_array($options['bcc'])) {
        foreach ($options['bcc'] as $key => $value) {
          if (!is_number($key))
            $message->addBcc($key, $value);
          else
            $message->addBcc($value);
        }
      } elseif (is_string($options['bcc'])) {
        $message->addBcc($options['bcc']);
      }
    }

    if (isset($options['attachments'])) {
      $atts = $options['attachments'];
      if (is_array($atts)) {
        foreach ($atts as $att) {
          $message->attach(Swift_Attachment::fromPath($att));
        }
      } elseif (is_string($atts)) {
        $message->attach(Swift_Attachment::fromPath($atts));
      }
    }

    try
    {
      return $mailer->send($message);
    } catch (Exception $e)
    {
      throw new Exception("Erro ao tentar enviar um email: " . $e->getMessage());
    }

  }

why is the method static? Well, I’ve also been using this method from another contexts like event listeners. A typical call for sending e-mail looks like

  // SEND EMAIL FROM ACTION
$opts = array();
$opts['from_name'] = 'Webmaster';
$opts['from_email'] = '[e-mail]';

$variables = array();
// variables passed to the partial template
$variables['%client_firstname%'] = $firstName;
$variables['%client_lastname%'] = $lastName;
$variables['%client_email%'] = $client_email;
// preenche opcoes de envio
$opts['parameters'] = array();
$opts['body_is_partial'] = false;
$opts['to_name'] = $variables['%client_firstname%'] . " " . $variables['%client_lastname%'];
$opts['to_email'] = $variables['%client_email%'];
$opts['subject'] = __($subject, $variables);
$opts['html'] = __($message_html, $variables);
$opts['text'] = __($message_text, $variables);
if (isset($cc)) $opts['cc'] = $cc;
$bcc = sfDoctrineKeyValueProjectStore::get("{$contexto}_message_bcc");
if (isset($bcc)) $opts['bcc'] = $bcc;

return dcActions::mail($opts, sfContext::getInstance()->getMailer());

It also enforces the use of sending both versions of an email (html and text). With such a code you can also use partials to deliver email messages. I find it very useful.