public abstract class EmailGateway

class.emailgateway.php #44

A base class for email gateways. All email-gateways should extend this class in order to work.

Methods

void __construct()
void|boolean __set()

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.

The property name.

Parameters
  • $name The property value;

void appendHeaderField()

Appends a single header field to the header fields array. The header field should be presented as a name/body pair.

The header name. Examples are From, X-Sender and Reply-to

Parameters
  • $name The header body.

void appendHeaderFields()

Appends one or more header fields to the header fields array. Header fields should be presented as an array with name/body pairs.

The header name. Examples are From, X-Sender and Reply-to

string contentInfoArray()

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()
void setFrom()

Sets the sender-email and sender-name.

The email-address emails will be sent from

Parameters
  • $email The name the emails will be sent from.

void setRecipients()

Sets the recipients.

The email-address(es) to send the email to.

void setReplyToEmailAddress()

Sets the reply-to-email.

The email-address emails should be replied to

void setReplyToName()

Sets the reply-to-name.

The name emails should be replied to

void setSenderEmailAddress()

Sets the sender-email.

The email-address emails will be sent from

void setSenderName()

Sets the sender-name.

The name emails will be sent from

void setSubject()

Sets the subject.

The subject that the email will have.

void setTextEncoding()
void setTextHtml()
void setTextPlain()
boolean validate()

Check to see if all required data is set.

Symphony • Open Source XSLT CMS

Server Requirements

  • PHP 5.3-5.6 or 7.0-7.3
  • PHP's LibXML module, with the XSLT extension enabled (--with-xsl)
  • MySQL 5.5 or above
  • An Apache or Litespeed webserver
  • Apache's mod_rewrite module or equivalent

Compatible Hosts

Sign in

Login details