QEmailServer Class Reference

Inherits QBaseClass.

Collaboration diagram for QEmailServer:

[legend]

List of all members.

Static Public Member Functions

• static GetEmailAddresses ($strAddresses)
• static Send (QEmailMessage $objMessage)

Static Public Attributes

• static $SmtpServer = 'localhost'
• static $SmtpPort = 25
• static $OriginatingServerIp
• static $TestMode = false
• static $TestModeDirectory = '/tmp'
• static $AuthPlain = false
• static $AuthLogin = false
• static $SmtpUsername = ''
• static $SmtpPassword = ''
• static $EncodingType = null

---

Detailed Description

This EmailServer (and its dependent EmailMessage class) allows the application to send messages via any accessible SMTP server.

The QEmailServer class, specifically, is an abstract class and is NOT meant to be instantiated. It has one public static method, Send, which takes in a QEmailMessage object.

---

Member Function Documentation

static QEmailServer::GetEmailAddresses

(

$

strAddresses

)

[static]

Uses regular expression matching to return an array of valid e-mail addresses

Parameters:

string

$strAddresses Single string containing e-mail addresses and anything else

Returns:

string[] An array of e-mail addresses only, or NULL if none

Referenced by Send().

static QEmailServer::Send

(

QEmailMessage $

objMessage

)

[static]

Sends a message out via SMTP according to the server, ip, etc. preferences as set up on the class. Takes in a QEmailMessage object.

Will throw a QEmailException exception on any error.

Parameters:

QEmailMessage

$objMessage Message to Send

Returns:

void

References $AuthLogin, $AuthPlain, $EncodingType, $OriginatingServerIp, $SmtpPassword, $SmtpPort, $SmtpServer, $SmtpUsername, $TestMode, $TestModeDirectory, QDateTime::FormatRfc822, GetEmailAddresses(), and QDateTime::NowToString().

---

Member Data Documentation

QEmailServer::$AuthLogin = false [static]

Referenced by Send().

QEmailServer::$AuthPlain = false [static]

Referenced by Send().

QEmailServer::$EncodingType = null [static]

Referenced by Send().

QEmailServer::$OriginatingServerIp [static]

Referenced by Send().

QEmailServer::$SmtpPassword = '' [static]

Referenced by Send().

QEmailServer::$SmtpPort = 25 [static]

Referenced by Send().

QEmailServer::$SmtpServer = 'localhost' [static]

Referenced by Send().

QEmailServer::$SmtpUsername = '' [static]

Referenced by Send().

QEmailServer::$TestMode = false [static]

Referenced by Send().

QEmailServer::$TestModeDirectory = '/tmp' [static]

Referenced by Send().

---

The documentation for this class was generated from the following file:

• qcodo/_core/framework/QEmailServer.class.php