Email Class. Provides a common interface to send email from the Joomla! Platform
since |
1.7.0 |
---|---|
package |
Joomla CMS |
Methods
__construct
Constructor
__construct(bool exceptions = true) : mixed
since |
1.7.0 |
---|
Arguments
- exceptions
bool
Flag if Exceptions should be thrown
Response
mixed
add
Add recipients to the email.
add(mixed recipient, mixed name = '', string method = 'addAddress') : \Joomla\CMS\Mail\Mail|bool
since |
1.7.0 |
---|---|
throws |
|
Arguments
- recipient
mixed
Either a string or array of strings [email address(es)]- name
mixed
Either a string or array of strings [name(s)]- method
string
The parent method's name.
Response
\Joomla\CMS\Mail\Mail|bool
Returns this object for chaining on success or boolean false on failure.
addAttachment
Add file attachment to the email
addAttachment(mixed path, mixed name = '', mixed encoding = 'base64', mixed type = 'application/octet-stream', string disposition = 'attachment') : \Joomla\CMS\Mail\Mail|bool
since |
3.0.1 |
---|---|
throws |
|
Arguments
- path
mixed
Either a string or array of strings [filenames]- name
mixed
Either a string or array of strings [names]. N.B. if this is an array it must contain the same number of elements as the array of paths supplied.- encoding
mixed
The encoding of the attachment- type
mixed
The mime type- disposition
string
The disposition of the attachment
Response
\Joomla\CMS\Mail\Mail|bool
Returns this object for chaining on success or boolean false on failure when exception throwing is disabled.
addBcc
Add blind carbon copy recipients to the email
addBcc(mixed bcc, mixed name = '') : \Joomla\CMS\Mail\Mail|bool
since |
1.7.0 |
---|---|
throws |
|
Arguments
- bcc
mixed
Either a string or array of strings [email address(es)]- name
mixed
Either a string or array of strings [name(s)]
Response
\Joomla\CMS\Mail\Mail|bool
Returns this object for chaining on success or boolean false on failure when exception throwing is disabled.
addCc
Add carbon copy recipients to the email
addCc(mixed cc, mixed name = '') : \Joomla\CMS\Mail\Mail|bool
since |
1.7.0 |
---|---|
throws |
|
Arguments
- cc
mixed
Either a string or array of strings [email address(es)]- name
mixed
Either a string or array of strings [name(s)]
Response
\Joomla\CMS\Mail\Mail|bool
Returns this object for chaining on success or boolean false on failure when exception throwing is enabled.
addRecipient
Add recipients to the email
addRecipient(mixed recipient, mixed name = '') : \Joomla\CMS\Mail\Mail|bool
since |
1.7.0 |
---|---|
throws |
|
Arguments
- recipient
mixed
Either a string or array of strings [email address(es)]- name
mixed
Either a string or array of strings [name(s)]
Response
\Joomla\CMS\Mail\Mail|bool
Returns this object for chaining on success or false on failure when exception throwing is disabled.
addReplyTo
Add Reply to email address(es) to the email
addReplyTo(mixed replyto, mixed name = '') : \Joomla\CMS\Mail\Mail|bool
since |
1.7.0 |
---|---|
throws |
|
Arguments
- replyto
mixed
Either a string or array of strings [email address(es)]- name
mixed
Either a string or array of strings [name(s)]
Response
\Joomla\CMS\Mail\Mail|bool
Returns this object for chaining on success or boolean false on failure when exception throwing is disabled.
clearAttachments
Unset all file attachments from the email
clearAttachments() : \Joomla\CMS\Mail\Mail
since |
3.0.1 |
---|
Response
\Joomla\CMS\Mail\Mail
Returns this object for chaining.
getInstance
Returns the global email object, only creating it if it doesn't already exist.
getInstance(string id = 'Joomla', bool exceptions = true) : \Joomla\CMS\Mail\Mail
NOTE: If you need an instance to use that does not have the global configuration values, use an id string that is not 'Joomla'.
since |
1.7.0 |
---|
Arguments
- id
string
The id string for the Mail instance [optional]- exceptions
bool
Flag if Exceptions should be thrown [optional]
Response
\Joomla\CMS\Mail\Mail
The global Mail object
isHtml
Sets message type to HTML
isHtml(bool ishtml = true) : \Joomla\CMS\Mail\Mail
since |
3.1.4 |
---|
Arguments
- ishtml
bool
Boolean true or false.
Response
\Joomla\CMS\Mail\Mail
Returns this object for chaining.
isSendmail
Send messages using $Sendmail.
isSendmail() : void
This overrides the parent class to remove the restriction on the executable's name containing the word "sendmail"
since |
1.7.0 |
---|
removeAttachment
Unset file attachments specified by array index.
removeAttachment(int index) : \Joomla\CMS\Mail\Mail
since |
3.0.1 |
---|
Arguments
- index
int
The numerical index of the attachment to remove
Response
\Joomla\CMS\Mail\Mail
Returns this object for chaining.
Send
Send the mail
Send() : bool
since |
1.7.0 |
---|---|
throws |
|
Response
bool
Boolean true if successful, false if exception throwing is disabled.
sendMail
Function to send an email
sendMail(string from, string fromName, mixed recipient, string subject, string body, bool mode = false, mixed cc = null, mixed bcc = null, mixed attachment = null, mixed replyTo = null, mixed replyToName = null) : bool
since |
1.7.0 |
---|---|
throws |
|
Arguments
- from
string
From email address- fromName
string
From name- recipient
mixed
Recipient email address(es)- subject
string
email subject- body
string
Message body- mode
bool
false = plain text, true = HTML- cc
mixed
CC email address(es)- bcc
mixed
BCC email address(es)- attachment
mixed
Attachment file name(s)- replyTo
mixed
Reply to email address(es)- replyToName
mixed
Reply to name(s)
Response
bool
True on success, false on failure when exception throwing is disabled.
setBody
Set the email body
setBody(string content) : \Joomla\CMS\Mail\Mail
since |
1.7.0 |
---|
Arguments
- content
string
Body of the email
Response
\Joomla\CMS\Mail\Mail
Returns this object for chaining.
setSender
Set the email sender
setSender(mixed from) : \Joomla\CMS\Mail\Mail|bool
since |
1.7.0 |
---|---|
throws |
|
Arguments
- from
mixed
email address and Name of senderarray([0] => email Address, [1] => Name)
or as a string
Response
\Joomla\CMS\Mail\Mail|bool
Returns this object for chaining on success or boolean false on failure.
setSubject
Set the email subject
setSubject(string subject) : \Joomla\CMS\Mail\Mail
since |
1.7.0 |
---|
Arguments
- subject
string
Subject of the email
Response
\Joomla\CMS\Mail\Mail
Returns this object for chaining.
useSendmail
Use sendmail for sending the email
useSendmail(string sendmail = null) : bool
since |
1.7.0 |
---|
Arguments
- sendmail
string
Path to sendmail [optional]
Response
bool
True on success
useSmtp
Use SMTP for sending the email
useSmtp(string auth = null, string host = null, string user = null, string pass = null, string secure = null, int port = 25) : bool
since |
1.7.0 |
---|
Arguments
- auth
string
SMTP Authentication [optional]- host
string
SMTP Host [optional]- user
string
SMTP Username [optional]- pass
string
SMTP Password [optional]- secure
string
Use secure methods- port
int
The SMTP port
Response
bool
True on success