1.8Documentation

// Plain an simple:
$email = \Email::forge();

// Config loaded from a group
$email = \Email::forge('my_defaults');

// Config supplied
$email = \Email::forge(array(
    'driver' => 'smtp',
));

// Loaded config from group with an dynamic overwrite
$email = \Email::forge('my_defaults', array(
    'driver' => 'smtp',
));

$email->body('This is my message.');

//or pass it a View
$email->body(\View::forge('my/view', $data);

$email->alt_body('This is my alternative message.');

//or pass it a View
$email->alt_body(\View::forge('my/alt/view', $data);

$email->priority(\Email::P_HIGHEST);

$email->html_body(\View::forge('welcome/email', $data));
// Don't generate the alt body
$email->html_body(\View::forge('welcome/email', $data), false);

// Do generate the alt body, but don't auto attach images.
$email->html_body(\View::forge('welcome/email', $data), true, false);

$email->from('me@example.com', 'My Name');

$email->subject('This is my subject');

// Add a single address
$email->to('me@example.com', 'My Name');

// Add multiple addresses
$email->to(array(
    'me@example.com',
    // with a name
    'me@example.com' => 'His/Her name.',
));

// Add a single address
$email->cc('me@example.com', 'My Name');

// Add multiple addresses
$email->cc(array(
    'me@example.com',
    // with a name
    'me@example.com' => 'His/Her name.',
));

// Add a single address
$email->bcc('me@example.com', 'My Name');

// Add multiple addresses
$email->bcc(array(
    'me@example.com',
    // with a name
    'me@example.com' => 'His/Her name.',
));

// Add a single address
$email->reply_to('me@example.com', 'My Name');

// Add multiple addresses
$email->reply_to(array(
    'me@example.com',
    // with a name
    'me@example.com' => 'His/Her name.',
));

// Add a single address
$email->header('X-SMTPAP', 'XXXXXXXX');

// Add multiple addresses
$email->reply_to(array(
    'X-SMTPAP' => 'XXXXXX',
    'X-SMTPAP2' => 'XXXXXA',
));

// Add a single address
$email->bcc('me@example.com', 'My Name');

// Add multiple addresses
$email->to(array(
    'me@example.com',
    // with a name
    'me@example.com' => 'His/Her name.',
));

// Reset them
$email->clear_recipients();

// Add a single address
$email->reply_to('me@example.com', 'My Name');

// Add multiple addresses
$email->to(array(
    'me@example.com',
    // with a name
    'me@example.com' => 'His/Her name.',
));

// Reset them
$email->clear_addresses();

// Add multiple addresses
$email->to(array(
    'me@example.com',
    // with a name
    'me@example.com' => 'His/Her name.',
));

// Reset them
$email->clear_to();

// Add multiple addresses
$email->cc(array(
    'me@example.com',
    // with a name
    'me@example.com' => 'His/Her name.',
));

// Reset them
$email->clear_cc();

// Add multiple addresses
$email->bcc(array(
    'me@example.com',
    // with a name
    'me@example.com' => 'His/Her name.',
));

// Reset them
$email->clear_bcc();

// Add multiple addresses
$email->reply_to(array(
    'me@example.com',
    // with a name
    'me@example.com' => 'His/Her name.',
));

// Reset them
$email->clear_reply_to();

// Add an attachment
$email->attach(DOCROOT.'attachments/report.pdf');

// Attach an image inline
$email->attach(DOCROOT.'assets/img/mail/header.png', true, 'cid:headerimage');
// This image would be bound to <img src="cid:headerimage" />

// Add an attachment
$email->string_attach('This is a textfile', 'test.txt');

// Add some attachments
$email->string_attach('This is a textfile', 'test.txt');
$email->attach(DOCROOT.'uploads/attach.pdf');

// And empty the attachments
$email->clear_attachments();

try{
    $email->send();
}
catch(\EmailSendingFailedException $e)
{
    // The driver could not send the mail.
}
catch(\EmailValidationFailedException $e)
{
    // One or more email addresses failed validation.
}

try{
    $email->send();
}
catch(\EmailSendingFailedException $e)
{
    // The driver could not send the mail.
}
catch(\EmailValidationFailedException $e)
{
    // One or more email addresses failed validation.
    $these_failed = $email->get_invalid_addresses();
}

$email->return_path('bounces@example.com');

$email->pipelining(true);

// returns the address set by from()
$from = $email->get_from();

// returns the addresses set by to()
$to = $email->get_to();

// returns the address set by cc()
$cc = $email->get_cc();

// returns the address set by bcc()
$bcc = $email->get_bcc();

// returns the addresses set by reply_to()
$reply_to = $email->get_reply_to();

// returns the email body
$text = $email->get_body();

// returns the subject set by subject()
$subject = $email->get_subject();