Zend_Mail-AddingRecipients.xml 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  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. </para>
  8. <itemizedlist>
  9. <listitem>
  10. <para>
  11. <methodname>addTo()</methodname>: Adds a recipient to the mail with a "To" header
  12. </para>
  13. </listitem>
  14. <listitem>
  15. <para>
  16. <methodname>addCc()</methodname>: Adds a recipient to the mail with a "Cc" header
  17. </para>
  18. </listitem>
  19. <listitem>
  20. <para>
  21. <methodname>addBcc()</methodname>: Adds a recipient to the mail not visible in the
  22. header
  23. </para>
  24. </listitem>
  25. </itemizedlist>
  26. <para>
  27. <methodname>getRecipients()</methodname> serves list of the recipients.
  28. <methodname>clearRecipients()</methodname> clears the list.
  29. </para>
  30. <note>
  31. <title>Additional parameter</title>
  32. <para>
  33. <methodname>addTo()</methodname> and <methodname>addCc()</methodname> accept a second
  34. optional parameter that is used as a human-readable name of the recipient for the
  35. header. Double quotation is changed to single quotation and angle brackets to square
  36. brackets in the parameter.
  37. </para>
  38. </note>
  39. </sect1>
  40. <!--
  41. vim:se ts=4 sw=4 et:
  42. -->