Mail::send()

Description

Sends a mail. The send()-function is provided by the object returned from factory()

Parameter

• mixed $recipients - an array or a string with comma separated recipients.

• array $headers - an associative array of headers. The header name is used as key and the header value as value. If you want to override the envelope sender of the email, set the Return-Path header and that value will be used instead of the value of the From: header.

• string $body - the body of the email.

Return value

boolean - TRUE or a PEAR_Error object, if fails

Throws

$headers['From'] = 'mymail@example.com';

$headers['From'] = 'mymail@example.com';

Note

This function can not be called statically.

Example

<?php
include('Mail.php');

$recipients = 'joe@example.com';

$headers['From']    = 'richard@example.com';
$headers['To']      = 'joe@example.com';
$headers['Subject'] = 'Test message';

$body = 'Test message';

$params['sendmail_path'] = '/usr/lib/sendmail';

// Create the mail object using the Mail::factory method
$mail_object =& Mail::factory('sendmail', $params);

$mail_object->send($recipients, $headers, $body);
?>

See

Mail::factory()