documentation/manual/en/module_specs/Zend_Mail-MultipleEmails.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.mail.multiple-emails">
   4     <title>Sending Multiple Mails per SMTP Connection</title>
   5
   6     <para>
   7         By default, a single SMTP transport creates a single connection and
   8         re-uses it for the lifetime of the script execution. You may send multiple
   9         e-mails through this SMTP connection. A RSET command is issued before each
  10         delivery to ensure the correct SMTP handshake is followed.
  11     </para>
  12
  13     <para>
  14         Optionally, you can also define a default From email address and name,
  15         as well as a default reply-to header. This can be done through the static
  16         methods <methodname>setDefaultFrom()</methodname> and
  17         <methodname>setDefaultReplyTo()</methodname>. These defaults will be used when you
  18         don't specify a From/Reply-to Address or -Name until the defaults are reset (cleared).
  19         Resetting the defaults can be done through the use of the
  20         <methodname>clearDefaultFrom()</methodname> and
  21         <methodname>clearDefaultReplyTo</methodname>.
  22     </para>
  23
  24     <example id="zend.mail.multiple-emails.example-1">
  25         <title>Sending Multiple Mails per SMTP Connection</title>
  26
  27         <programlisting language="php"><![CDATA[
  28 // Create transport
  29 $config = array('name' => 'sender.example.com');
  30 $transport = new Zend_Mail_Transport_Smtp('mail.example.com', $config);
  31
  32 // Set From & Reply-To address and name for all emails to send.
  33 Zend_Mail::setDefaultFrom('sender@example.com', 'John Doe');
  34 Zend_Mail::setDefaultReplyTo('replyto@example.com','Jane Doe');
  35
  36 // Loop through messages
  37 for ($i = 0; $i < 5; $i++) {
  38     $mail = new Zend_Mail();
  39     $mail->addTo('studio@example.com', 'Test');
  40
  41     $mail->setSubject(
  42         'Demonstration - Sending Multiple Mails per SMTP Connection'
  43     );
  44     $mail->setBodyText('...Your message here...');
  45     $mail->send($transport);
  46 }
  47
  48 // Reset defaults
  49 Zend_Mail::clearDefaultFrom();
  50 Zend_Mail::clearDefaultReplyTo();
  51 ]]></programlisting>
  52     </example>
  53
  54     <para>
  55         If you wish to have a separate connection for each mail
  56         delivery, you will need to create and destroy your transport before and
  57         after each <methodname>send()</methodname> method is called. Or alternatively,
  58         you can manipulate the connection between each delivery by accessing the
  59         transport's protocol object.
  60     </para>
  61
  62     <example id="zend.mail.multiple-emails.example-2">
  63         <title>Manually controlling the transport connection</title>
  64
  65         <programlisting language="php"><![CDATA[
  66 // Create transport
  67 $transport = new Zend_Mail_Transport_Smtp();
  68
  69 $protocol = new Zend_Mail_Protocol_Smtp('mail.example.com');
  70 $protocol->connect();
  71 $protocol->helo('sender.example.com');
  72
  73 $transport->setConnection($protocol);
  74
  75 // Loop through messages
  76 for ($i = 0; $i < 5; $i++) {
  77     $mail = new Zend_Mail();
  78     $mail->addTo('studio@example.com', 'Test');
  79     $mail->setFrom('studio@example.com', 'Test');
  80     $mail->setSubject(
  81         'Demonstration - Sending Multiple Mails per SMTP Connection'
  82     );
  83     $mail->setBodyText('...Your message here...');
  84
  85     // Manually control the connection
  86     $protocol->rset();
  87     $mail->send($transport);
  88 }
  89
  90 $protocol->quit();
  91 $protocol->disconnect();
  92 ]]></programlisting>
  93     </example>
  94 </sect1>
  95 <!--
  96 vim:se ts=4 sw=4 et:
  97 -->