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

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.mail.adding-recipients">
   4     <title>Adding Recipients</title>
   5
   6     <para>
   7         Recipients can be added in three ways:
   8     </para>
   9
  10     <itemizedlist>
  11         <listitem>
  12             <para>
  13                 <methodname>addTo()</methodname>: Adds a recipient to the mail with a "To" header
  14             </para>
  15         </listitem>
  16
  17         <listitem>
  18             <para>
  19                 <methodname>addCc()</methodname>: Adds a recipient to the mail with a "Cc" header
  20             </para>
  21         </listitem>
  22
  23         <listitem>
  24             <para>
  25                 <methodname>addBcc()</methodname>: Adds a recipient to the mail not visible in the
  26                 header
  27             </para>
  28         </listitem>
  29     </itemizedlist>
  30
  31     <para>
  32         <methodname>getRecipients()</methodname> serves list of the recipients.
  33         <methodname>clearRecipients()</methodname> clears the list.
  34     </para>
  35
  36     <note>
  37         <title>Additional parameter</title>
  38
  39         <para>
  40             <methodname>addTo()</methodname> and <methodname>addCc()</methodname> accept a second
  41             optional parameter that is used as a human-readable name of the recipient for the
  42             header. Double quotation is changed to single quotation and angle brackets to square
  43             brackets in the parameter.
  44         </para>
  45     </note>
  46
  47     <note>
  48         <title>Optional Usage</title>
  49
  50         <para>
  51             All three of these methods can also accept an array of email addresses
  52             to add instead of one at a time. In the case of <methodname>addTo()</methodname> and
  53             <methodname>addCc()</methodname>, they can be associative arrays where the key is the
  54             human readable name for the recipient.
  55         </para>
  56     </note>
  57 </sect1>
  58 <!--
  59 vim:se ts=4 sw=4 et:
  60 -->