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

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.mail.smtp-authentication">
   4     <title>SMTP Authentication</title>
   5
   6     <para>
   7         <classname>Zend_Mail</classname> supports the use of SMTP authentication, which
   8         can be enabled be passing the 'auth' parameter to the configuration array in
   9         the <classname>Zend_Mail_Transport_Smtp</classname> constructor. The available
  10         built-in authentication methods are PLAIN, LOGIN and CRAM-MD5 which all
  11         expect a 'username' and 'password' value in the configuration array.
  12     </para>
  13
  14     <example id="zend.mail.smtp-authentication.example-1">
  15         <title>Enabling authentication within Zend_Mail_Transport_Smtp</title>
  16
  17         <programlisting language="php"><![CDATA[
  18 $config = array('auth' => 'login',
  19                 'username' => 'myusername',
  20                 'password' => 'password');
  21
  22 $transport = new Zend_Mail_Transport_Smtp('mail.server.com', $config);
  23
  24 $mail = new Zend_Mail();
  25 $mail->setBodyText('This is the text of the mail.');
  26 $mail->setFrom('sender@test.com', 'Some Sender');
  27 $mail->addTo('recipient@test.com', 'Some Recipient');
  28 $mail->setSubject('TestSubject');
  29 $mail->send($transport);
  30 ]]></programlisting>
  31     </example>
  32
  33     <note>
  34         <title>Authentication types</title>
  35
  36         <para>
  37             The authentication type is case-insensitive but has no punctuation.
  38             E.g. to use CRAM-MD5 you would pass 'auth' => 'crammd5' in the
  39             <classname>Zend_Mail_Transport_Smtp</classname> constructor.
  40         </para>
  41     </note>
  42 </sect1>
  43 <!--
  44 vim:se ts=4 sw=4 et:
  45 -->