__construct()
alt_body()
attach()
bcc()
body()
cc()
clear_addresses()
clear_attachments()
clear_bcc()
clear_cc()
clear_recipients()
clear_reply_to()
clear_to()
from()
get_bcc()
get_body()
get_cc()
get_config()
get_from()
get_invalid_addresses()
get_reply_to()
get_subject()
get_to()
header()
html_body()
pipelining()
priority()
reply_to()
return_path()
send()
set_config()
string_attach()
subject()
to()
_send()
add_to_list()
attachment_mime()
build_message()
clear_list()
encode_mimeheader()
encode_string()
find_attachment()
format_addresses()
generate_alt()
get_attachment_headers()
get_content_type()
get_header()
get_mail_type()
get_message_id()
prep_newlines()
set_boundaries()
set_header()
validate_addresses()
$alt_body
$attachments
$bcc
$body
$boundaries
$cc
$config
$extra_headers
$headers
$invalid_addresses
$pipelining
$reply_to
$subject
$to
$type
__construct(array $config)
arraydriver config
alt_body(string $alt_body) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringThe message alt body
attach(string $file, bool $inline, string $cid, string $mime, string $name) : \Email\Email_Driver
This method will search for the file in the attachment paths set (config/email.php) in the attach_paths array
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringThe file to attach
boolWhether to include the file inline
stringThe content identifier. Used when attaching inline images
stringThe file's mime-type
stringThe attachment's name
\InvalidAttachmentsException |
Could not read attachment or attachment is empty |
|---|
bcc(string | array $email, string | bool $name) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringarrayEmail address or list of email addresses, array(email => name, email)
stringboolRecipient name, false, null or empty for no name
body(string $body) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringThe message body
cc(string | array $email, string | bool $name) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringarrayEmail address or list of email addresses, array(email => name, email)
stringboolRecipient name, false, null or empty for no name
clear_addresses() : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
clear_bcc() : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
clear_cc() : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
clear_recipients() : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
clear_reply_to() : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
clear_to() : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
from(string $email, bool | string $name) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringThe from email address
boolstringThe optional from name
get_bcc() : array
arrayto bcc recipients listget_body() : string
stringthe message bodyget_cc() : array
arrayto cc recipients listget_config(string $key, string $default) : mixed
stringConfig key
stringDefault value
mixedthe config setting valueget_from() : array
arrayfrom address and nameget_invalid_addresses() : array
arrayAn array of invalid email addressesget_reply_to() : array
arrayto 'reply to' recipients listget_subject() : string
stringthe message subjectget_to() : array
arrayto recipients listheader(string | array $header, string $value) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringarrayHeader type or array of headers
stringHeader value
html_body(string $html, bool $generate_alt, bool $auto_attach) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringThe body html
boolWhether to generate the alt body, will set is html to true
boolWhether to auto attach inline files
pipelining(bool $pipelining) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
boolWhether or not to enable pipelining
priority(string $priority) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringThe message priority
reply_to(string | array $email, string | bool $name) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringarrayEmail address or list of email addresses, array(email => name, email)
stringboolThe name, false, null or empty for no name
return_path(string $email) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringThe return-path email address
send(bool $validate) : bool
boolWhether to validate the addresses, falls back to config setting
\EmailValidationFailedException |
One or more email addresses did not pass validation |
|---|---|
\FuelException |
Cannot send without from address/Cannot send without recipients |
boolset_config(string $key, mixed $value) : object
stringthe config key
mixedthe new config value
object$thisstring_attach(string $contents, string $filename, string $cid, bool $inline, string $mime) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringFile contents
stringThe files name
stringThe content identifier. Used when attaching inline images
boolWhether it's an inline attachment
stringThe file's mime-type
subject(string $subject) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringThe message subject
to(string | array $email, string | bool $name) : \Email\Email_Driver
| fluent | This method is part of a fluent interface and will return the same instance |
|---|
stringarrayEmail address or list of email addresses, array(email => name, email)
stringboolRecipient name, false, null or empty for no name
_send() : bool
boolsuccess booleanadd_to_list(string $list, string | array $email, string | bool $name) : void
stringList to add to (to, cc, bcc)
stringarrayEmail address or list of email addresses, array(email => name, email)
stringboolRecipient name, false, null or empty for no name
clear_list(string | array $list) : void
stringarrayList or array of lists
encode_mimeheader(string $header) : string
stringHeader to encode
stringMimeheader encoded stringencode_string(string $string, string $encoding, string $newline) : string
stringString to encode
stringThe charset
stringNewline delimeter
\InvalidEmailStringEncoding |
Encoding is not a supported by encoding method |
|---|
stringEncoded stringformat_addresses(array $addresses) : string
arrayArray of adresses array(array(name=>name, email=>email));
stringCorrectly formatted email addressesgenerate_alt(string $html, int $wordwrap, string $newline) : string
stringhtml Body to al body generate from
intWordwrap length
stringLine separator to use
stringThe generated alt bodyget_content_type(string $mail_type, $boundary) : string
stringType of email (plain, html, html_inline, etc…)
\FuelException |
Invalid content-type |
|---|
stringMail content typeget_header(string $header, bool $formatted) : string | array
stringThe header name. Will return all headers, if not specified
boolAdds newline as suffix and colon as prefix, if true
stringarrayMail header or array of headersget_mail_type() : string
stringMail typeprep_newlines(string $string, string $newline) : string
stringString to prep
stringThe newline delimiter
stringString with standardized newlinesset_boundaries()
set_header(string $header, string $value)
stringThe header type
stringThe header value
validate_addresses() : bool | array
boolarrayTrue if all are valid or an array of recipients which failed validation.$alt_body
$bcc
$body
$boundaries
$cc
$config
$extra_headers
$headers
$invalid_addresses
$pipelining
$reply_to
$subject
$to
$type
