Class QEmailServer

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.

QBaseClass

QEmailServer

Abstract
Located at includes/framework/QEmailServer.class.php

Methods summary
`public static string[]`	# `GetEmailAddresses( string $strAddresses )` Uses regular expression matching to return an array of valid e-mail addresses Uses regular expression matching to return an array of valid e-mail addresses Parameters `$strAddresses` Single string containing e-mail addresses and anything else Returns string[] An array of e-mail addresses only, or NULL if none
`public static boolean`	# `IsEmailValid( string $strEmailAddress )` This will check to see if an email address is considered "Valid" according to RFC 2822. It utilizes the GetEmailAddresses static method, which does the actual logic work of checking. This will check to see if an email address is considered "Valid" according to RFC 2822. It utilizes the GetEmailAddresses static method, which does the actual logic work of checking. Parameters `$strEmailAddress` Returns boolean
`public static`	# `Send( QEmailMessage $objMessage )` 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. 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 `$objMessage` Message to Send Throws `QEmailException`

Methods inherited from QBaseClass
`OverrideAttributes(), __call(), __get(), __set()`

Properties summary
`public static string`	`$SmtpServer` Server Hostname or IP Address of the server running the SMTP service. Using an IP address is slightly faster, but using a Hostname is easier to manage. Defaults to "localhost". Server Hostname or IP Address of the server running the SMTP service. Using an IP address is slightly faster, but using a Hostname is easier to manage. Defaults to "localhost".	# `'localhost'`
`public static integer`	`$SmtpPort` Port of the SMTP Service on the SmtpServer, usually 25 Port of the SMTP Service on the SmtpServer, usually 25	# `25`
`public static string`	`$OriginatingServerIp` IP Address of the Originating Server (e.g. the IP address of this server) used for the EHLO command in the SMTP protocol. Defaults to the QApplication::$ServerAddress variable, which uses the PHP $_SERVER constants to determine the correct IP address. IP Address of the Originating Server (e.g. the IP address of this server) used for the EHLO command in the SMTP protocol. Defaults to the QApplication::$ServerAddress variable, which uses the PHP $_SERVER constants to determine the correct IP address.	#
`public static boolean`	`$TestMode` Whether or not we are running in Test Mode. Test Mode allows you to develop e-mail-based applications without actually having access to an SMTP server or the Internet. Instead of messages being sent out, the messages and corresponding SMTP communication will be saved to disk. Whether or not we are running in Test Mode. Test Mode allows you to develop e-mail-based applications without actually having access to an SMTP server or the Internet. Instead of messages being sent out, the messages and corresponding SMTP communication will be saved to disk.	# `false`
`public static string`	`$TestModeDirectory` The directory where TestMode e-mail files will be saved to. The process running the webserver must have write access to this directory. Default is "/tmp", which makes sense in unix/linux/mac environments. Windows users will likely need to set up their own temp directories. The directory where TestMode e-mail files will be saved to. The process running the webserver must have write access to this directory. Default is "/tmp", which makes sense in unix/linux/mac environments. Windows users will likely need to set up their own temp directories.	# `__TMP__`
`public static boolean`	`$AuthPlain` Boolean flag signifying whether SMTP's AUTH PLAIN should be used Boolean flag signifying whether SMTP's AUTH PLAIN should be used	# `false`
`public static boolean`	`$AuthLogin` Boolean flag signifying whether SMTP's AUTH LOGIN should be used Boolean flag signifying whether SMTP's AUTH LOGIN should be used	# `false`
`public static string`	`$SmtpUsername` SMTP Username to use for AUTH PLAIN or LOGIN SMTP Username to use for AUTH PLAIN or LOGIN	# `''`
`public static string`	`$SmtpPassword` SMTP Password to use for AUTH PLAIN or LOGIN SMTP Password to use for AUTH PLAIN or LOGIN	# `''`
`public static string`	`$EncodingType` Encoding Type (if null, will default to the QApplication::$EncodingType) Encoding Type (if null, will default to the QApplication::$EncodingType)	# `null`

Packages

Classes

Interfaces

Traits

Exceptions

Functions

Class QEmailServer

Parameters

Returns

Parameters

Returns

Parameters

Throws