cvs: phpdoc /en/functions mail.xml

ronabop Tue Oct 10 22:37:00 2000 EDT Modified files: /phpdoc/en/functions mail.xml Log: Added example to show complex email, some formatting. Index: phpdoc/en/functions/mail.xml diff -u phpdoc/en/functions/mail.xml:1.6 phpdoc/en/functions/mail.xml:1.7 --- phpdoc/en/functions/mail.xml:1.6 Sat Jul 1 14:36:42 2000 +++ phpdoc/en/functions/mail.xml Tue Oct 10 22:37:00 2000 @@ -20,14 +20,18 @@ <paramdef>string <parameter>to</parameter></paramdef> <paramdef>string <parameter>subject</parameter></paramdef> <paramdef>string <parameter>message</parameter></paramdef> - <paramdef>string <parameter><optional>additional_headers</optional></parameter></paramdef> + <paramdef>string + <parameter><optional>additional_headers</optional> + </parameter> + </paramdef> </funcprototype> </funcsynopsis> <simpara> <function>Mail</function> automatically mails the message specified in <parameter>message</parameter> to the receiver specified in <parameter>to</parameter>. Multiple recipients can be specified by - putting a comma between each address in <parameter>to</parameter>.</simpara> + putting a comma between each address in <parameter>to</parameter>. + </simpara> <para> <example> <title>Sending mail.</title> @@ -46,7 +50,48 @@ mail("nobody@aol.com", "the subject", $message, "From: webmaster@$SERVER_NAME\nReply-To: webmaster@$SERVER_NAME\nX-Mailer: PHP/" . phpversion()); </programlisting> - </example></para> + </example> + You can also use fairly simple string building techniques to + build complex email messages. + <example> + <title>Sending complex email.</title> + <programlisting> +/* recipients */ +$recipient .= "Mary &lt;mary@u.college.edu>" . ", " ; //note the comma +$recipient .= "Kelly &lt;kelly@u.college.edu> . ", "; +$recipient .= "ronabop@php.net"; + +/* subject */ +$subject = "Birthday Reminders for August"; + +/* message */ +$message .= "The following email includes a formatted ASCII table\n"; +$message .= "Day \t\tMonth \t\tYear\n"; +$message .= "3rd \t\tAug \t\t1970\n"; +$message .= "17rd\t\tAug \t\t1973\n"; + +/* you can add a stock signature */ +$message .= "--\r\n"; //Signature delimiter +$message .= "Birthday reminder copylefted by public domain"; + +/* additional header pieces for errors, From cc's, bcc's, etc */ + +$headers .= "From: Birthday Reminder &lt;birthday@php.net>\n"; +$headers .= "X-Sender: &lt;birthday@php.net>\n"; +$headers .= "X-Mailer: PHP\n"; // mailer +$headers .= "X-Priority: 1\n"; // Urgent message! +$headers .= "Return-Path: &lt;birthday@php.net>\n"; // Return path for errors + +$headers .= "Content-Type: text/html; charset=iso-8859-1\n" // Mime type + +$headers .= "cc:birthdayarchive@php.net\n"; // CC to +$headers .= "bcc:birthdaycheck@php.net, birthdaygifts@php.net\n"; // BCCs to + +/* and now mail it */ +mail($recipent, $subject, $message, $headers); + </programlisting> + </example> + </para> </refsect1> </refentry>