documentation/manual/en/module_specs/Zend_Application-AvailableResources-Mail.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect2 id="zend.application.available-resources.mail">
   4     <title>Zend_Application_Resource_Mail</title>
   5
   6     <para>
   7         <classname>Zend_Application_Resource_Mail</classname> can be used
   8         to instantiate a transport for <classname>Zend_Mail</classname> or set
   9         the default name and address, as well as the default replyto- name and address.
  10     </para>
  11
  12     <para>
  13         When instantiating a transport, it's registered automatically to
  14         <classname>Zend_Mail</classname>. Though, by setting the
  15         <property>transport.register</property> directive to <constant>FALSE</constant>, this
  16         behaviour does no more occur.
  17     </para>
  18
  19     <example id="zend.application.available-resources.mail.configExample">
  20         <title>Sample Mail Resource Configuration</title>
  21
  22         <para>
  23             Below is a sample <acronym>INI</acronym> snippet showing how to
  24             configure the mail resource plugin.
  25         </para>
  26
  27         <programlisting language="ini"><![CDATA[
  28 resources.mail.transport.type = smtp
  29 resources.mail.transport.host = "smtp.example.com"
  30 resources.mail.transport.auth = login
  31 resources.mail.transport.username = myUsername
  32 resources.mail.transport.password = myPassword
  33 resources.mail.transport.register = true ; True by default
  34
  35 resources.mail.defaultFrom.email = john@example.com
  36 resources.mail.defaultFrom.name = "John Doe"
  37 resources.mail.defaultReplyTo.email = Jane@example.com
  38 resources.mail.defaultReplyTo.name = "Jane Doe"
  39 ]]></programlisting>
  40
  41     </example>
  42 </sect2>