EmailGateway SMTPGateway

public class SMTPGateway extends EmailGateway

email.smtp.php #13

One of the two core email gateways. Provides simple SMTP functionalities. Supports AUTH LOGIN, SSL and TLS.

Methods

void __construct()

Constructor. Sets basic default values based on preferences.

public static
email.smtp.php #31
static array about()

Returns the name, used in the dropdown menu in the preferences pane.

boolean closeConnection()

Close the connection to the email Server. This function is used to allow persistent connections.

XMLElement getPreferencesPane()

Builds the preferences pane, shown in the Symphony backend.

boolean openConnection()

Open new connection to the email server. This function is used to allow persistent connections.

void reset()

Resets the headers, body, subject

boolean send()

Send an email using an SMTP server

void setAuth(boolean $auth)

Use AUTH login or no auth.

boolean setConfiguration(array $config)

Sets all configuration entries from an array.

Parameters
  • $config arrayAll configuration entries stored in a single array. The array should have the format of the $_POST array created by the preferences HTML.

void setEnvelopeFrom(null $envelope_from)

Sets the envelope_from address. This is only available via the API, as it is an expert-only feature.

void setHeloHostname(string $helo_hostname)

Sets the HELO/EHLO hostanme

void setHost(null|string $host)

Sets the host to connect to.

Parameters
  • $host null|string(optional)

void setPass(string $pass)

Sets the password to use with AUTH LOGIN

void setPort(null|int $port)

Sets the port, used in the connection.

void setSecure(string $secure)

Sets the encryption used.

Parameters
  • $secure stringThe encryption used. Can be 'ssl', 'tls'. Anything else defaults to a non secure TCP connection

void setUser(string $user)

Sets the username to use with AUTH LOGIN

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