- Symphony 2.2.3
-
› assets
11 -
› boot
9 -
› core
22 -
› email-gateways
3 -
› toolkit
67 -
› Unknown
33 - Delegates87
- Deprecated30
Versions
- 2.7.9
- 2.7.8
- 2.7.7
- 2.7.6
- 2.7.5
- 2.7.3
- 2.7.2
- 2.7.10
- 2.7.1
- 2.7.0
- 2.6.9
- 2.6.8
- 2.6.7
- 2.6.6
- 2.6.5
- 2.6.4
- 2.6.3
- 2.6.2
- 2.6.11
- 2.6.10
- 2.6.1
- 2.6.0
- 2.5.3
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4
- 2.3.6
- 2.3.5
- 2.3.4
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3
- 2.2.5
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2
Options
public abstract class EmailGateway
class.emailgateway.php #46A base class for email gateways. All email-gateways should extend this class in order to work.
Methods
void __construct()
boolean|mixed __get(
$name)
Gets a property.
Magic function, supplied by php.
This function will attempt to find a variable set with $name
and
returns it. If the variable is not set, it will return false.
Parameters
void|boolean __set(
$name, $value)
Sets a property.
Magic function, supplied by php. This function will try and find a method of this class, by camelcasing the name, and appending it with set. If the function can not be found, an exception will be thrown.
Parameters
void appendHeaderField(
$name, $body)
Appends a single header field to the header fields array. The header field should be presented as a name/body pair.
Parameters
void appendHeaderFields(
$header_array)
Appends one or more header fields to the header fields array. Header fields should be presented as an array with name/body pairs.
Parameters
string contentInfoArray(
$type, $file)
Builds the right content-type/encoding types based on file and content-type.
Will return a string containing the section, or an empty array on failure. Can be used to send to an email server directly.
XMLElement getPreferencesPane()
The preferences to add to the preferences pane in the admin area.
void send()
Sends the actual email. This function should be set on the email-gateway itself. See the default gateway for an example.
void setAttachments(
$file)
void setFrom(
$email, $name)
Sets the sender-email and sender-name.
Parameters
void setRecipients(
$email)
Sets the recipients.
Parameters
void setReplyToEmailAddress(
$email)
Sets the reply-to-email.
Parameters
void setReplyToName(
$name)
Sets the reply-to-name.
Parameters
void setSenderEmailAddress(
$email)
Sets the sender-email.
Parameters
void setSenderName(
$name)
Sets the sender-name.
Parameters
void setSubject(
$subject)
Sets the subject.
Parameters
void setTextEncoding(
$encoding)
Parameters
void setTextHtml(
$text_html)
This functions takes a string to be used as the HTML content for the Email
void setTextPlain(
$text_plain)
This functions takes a string to be used as the plaintext content for the Email
boolean validate()
Check to see if all required data is set.