Zend_Mail-AddingRecipients.xml 1.2 KB

12345678910111213141516171819202122232425262728293031323334
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <sect1 id="zend.mail.adding-recipients">
  4. <title>Adding Recipients</title>
  5. <para>
  6. Recipients can be added in three ways:
  7. <itemizedlist>
  8. <listitem>
  9. <para><code>addTo()</code>: Adds a recipient to the mail with a "To" header</para>
  10. </listitem>
  11. <listitem>
  12. <para><code>addCc()</code>: Adds a recipient to the mail with a "Cc" header</para>
  13. </listitem>
  14. <listitem>
  15. <para><code>addBcc()</code>: Adds a recipient to the mail not visible in the header.</para>
  16. </listitem>
  17. </itemizedlist>
  18. </para>
  19. <para>
  20. <code>getRecipients()</code> serves list of the recipients. <code>clearRecipients()</code>
  21. clears the list.
  22. </para>
  23. <note>
  24. <title>Additional parameter</title>
  25. <para>
  26. <code>addTo()</code> and <code>addCc()</code> accept a second optional parameter that is used as a
  27. human-readable name of the recipient for the header. Double quotation is changed to
  28. single quotation and angle brackets to square brackets in the parameter.
  29. </para>
  30. </note>
  31. </sect1>
  32. <!--
  33. vim:se ts=4 sw=4 et:
  34. -->