class TestMailer extends Mailer (View source)

Properties

public string $class from  SS_Object
protected array $extension_instances from  SS_Object
protected $beforeExtendCallbacks

List of callbacks to call prior to extensions having extend called on them, each grouped by methodName.

from  SS_Object
protected $afterExtendCallbacks

List of callbacks to call after extensions having extend called on them, each grouped by methodName.

from  SS_Object
protected string $messageEncoding

Encoding type currently set

from  Mailer
protected string $bounceEmail

Email used for bounces

from  Mailer
protected $emailsSent

Methods

public static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

protected
beforeExtending(string $method, callable $callback)

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

protected
afterExtending(string $method, callable $callback)

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

public static 
create()

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton()

Creates a class instance by the "singleton" design pattern.

public static 
create_from_string($classSpec, $firstArg = null)

Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().

public static 
parse_class_spec($classSpec)

Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().

public static 
strong_create()

Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()

public static 
useCustomClass(string $oldClass, string $newClass, bool $strong = false)

This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()

public static 
string
getCustomClass(string $class)

If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name

public static 
any
static_lookup($class, $name, null $default = null)

Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.

public static 
get_static($class, $name, $uncached = false) deprecated

No description

public static 
set_static($class, $name, $value) deprecated

No description

public static 
uninherited_static($class, $name, $uncached = false) deprecated

No description

public static 
combined_static($class, $name, $ceiling = false) deprecated

No description

public static 
addStaticVars($class, $properties, $replace = false) deprecated

No description

public static 
add_static_var($class, $name, $value, $replace = false) deprecated

No description

public static 
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)

Return TRUE if a class has a specified extension.

public static 
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

public static 
remove_extension(string $extension)

Remove an extension from a class.

public static 
array
get_extensions(string $class, bool $includeArgumentString = false)

No description

public static 
get_extra_config_sources($class = null)

No description

public
__construct()

No description

public
mixed
__call(string $method, array $arguments)

Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located

public
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

public
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

protected
defineMethods()

Adds any methods from Extension instances attached to this object.

protected
array
findMethodsFromExtension(object $extension)

No description

protected
addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

protected
removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

protected
addWrapperMethod(string $method, string $wrap)

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

protected
createMethod(string $method, string $code)

Add an extra method using raw PHP code passed as a string

public
stat($name, $uncached = false)

No description

public
set_stat($name, $value)

No description

public
uninherited($name)

No description

public
bool
exists()

Return true if this object "exists" i.e. has a sensible value

public
string
parentClass()

No description

public
bool
is_a(string $class)

Check if this class is an instance of a specific class, or has that class as one of its parents

public
string
__toString()

No description

public
mixed
invokeWithExtensions(string $method, mixed $argument = null)

Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array

public
array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

public
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

public
bool
hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.

public
array
getExtensionInstances()

Get all extension instances for this specific object instance.

public
mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

Cache the results of an instance method in this object to a file, or if it is already cache return the cached results

public
clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

protected
mixed
loadCache(string $cache, int $lifetime = 3600)

Loads a cache from the filesystem if a valid on is present and within the specified lifetime

protected
saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

protected
string
sanitiseCachename(string $name)

Strip a file name of special characters so it is suitable for use as a cache file name

public
string
getBounceEmail()

Email used for bounces

from  Mailer
public
setBounceEmail(string $email)

Set the email used for bounces

from  Mailer
public
string
getMessageEncoding()

Get the encoding type used for plain text messages

from  Mailer
public
setMessageEncoding(string $encoding)

Sets encoding type for messages. Available options are:

  • quoted-printable
  • base64

from  Mailer
protected
string
encodeMessage(string $message, string $encoding)

Encode a message using the given encoding mechanism

from  Mailer
protected
array
mergeCustomHeaders(array $headers, array $customHeaders)

Merge custom headers with default ones

from  Mailer
public
mixed
sendPlain(string $to, string $from, string $subject, string $plainContent, array $attachedFiles = false, array $customHeaders = false)

Send a plain-text email.

public
mixed
sendHTML(string $to, string $from, string $subject, string $htmlContent, array $attachedFiles = false, array $customHeaders = false, string $plainContent = false, $inlineImages = false)

Send a multi-part HTML email TestMailer will merely record that the email was asked to be sent, without sending anything.

protected
mixed
sendPreparedMessage(string $to, string $from, string $subject, array $attachedFiles, array $customHeaders, string $fullBody, array $headers)

Send an email of an arbitrary format

from  Mailer
protected
mixed
email(string $to, string $subjectEncoded, string $fullBody, string $headersEncoded, string $bounceAddress)

Send the actual email

from  Mailer
protected
array
encodeAttachments(array $attachments, array $headers, string $body)

Encode attachments into a message

from  Mailer
protected
string
preparePlainSubmessage(string $plainContent, string $htmlContent)

Generate the plainPart of a html message

from  Mailer
protected
string
prepareHTMLSubmessage(string $htmlContent)

Generate the html part of a html message

from  Mailer
protected
array
encodeMultipart(array $parts, string $contentType, array $headers = array())

Encode an array of parts using multipart

from  Mailer
protected
string
processHeaders(array $headers, string $body = '')

Add headers to the start of the message

from  Mailer
protected
encodeFileForEmail($file, $destFileName = false, $disposition = NULL, $extraHeaders = "")

Encode the contents of a file for emailing, including headers

from  Mailer
public
validEmailAddr($emailAddress) deprecated

No description

from  Mailer
protected
string
validEmailAddress(string $emailAddress)

Cleans up emails which may be in 'Name [email protected]' format

from  Mailer
public
wrapImagesInline($htmlContent) deprecated

No description

from  Mailer
public
wrapImagesInline_rewriter($url) deprecated

No description

from  Mailer
public
clearEmails()

Clear the log of emails sent

public
array
findEmail($to, $from = null, $subject = null, $content = null)

Search for an email that was sent.

Details

static Config_ForClass|null config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass|null

protected beforeExtending(string $method, callable $callback)

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected afterExtending(string $method, callable $callback)

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

static SS_Object create()

An implementation of the factory method, allows you to create an instance of a class

This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use Object::useCustomClass()

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

Return Value

SS_Object

static SS_Object singleton()

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Return Value

SS_Object

The singleton instance

static create_from_string($classSpec, $firstArg = null)

Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().

Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.

Object::create_from_string("Versioned('Stage','Live')") will return the result of Versioned::create('Stage', 'Live);

It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.

If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.

Object::create_from_string("Varchar(50)", "MyField") will return the result of Vachar::create('MyField', '50');

Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.

Parameters

$classSpec
$firstArg

static parse_class_spec($classSpec)

Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().

Returns a 2-elemnent array, with classname and arguments

Parameters

$classSpec

static SS_Object strong_create()

Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()

Return Value

SS_Object

static useCustomClass(string $oldClass, string $newClass, bool $strong = false)

This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()

Parameters

string $oldClass

the class to replace

string $newClass

the class to replace it with

bool $strong

allows you to enforce a certain class replacement under all circumstances. This is used in singletons and DB interaction classes

static string getCustomClass(string $class)

If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name

Parameters

string $class

the class to check

Return Value

string

the class that would be created if you called Object::create() with the class

static any static_lookup($class, $name, null $default = null)

Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.

Parameters

$class
  • The class to get the static from
$name
  • The property to get from the class
null $default
  • The value to return if property doesn't exist on class

Return Value

any
  • The value of the static property $name on class $class, or $default if that property is not defined

static get_static($class, $name, $uncached = false) deprecated

deprecated

No description

Parameters

$class
$name
$uncached

static set_static($class, $name, $value) deprecated

deprecated

No description

Parameters

$class
$name
$value

static uninherited_static($class, $name, $uncached = false) deprecated

deprecated

No description

Parameters

$class
$name
$uncached

static combined_static($class, $name, $ceiling = false) deprecated

deprecated

No description

Parameters

$class
$name
$ceiling

static addStaticVars($class, $properties, $replace = false) deprecated

deprecated

No description

Parameters

$class
$properties
$replace

static add_static_var($class, $name, $value, $replace = false) deprecated

deprecated

No description

Parameters

$class
$name
$value
$replace

static has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)

Return TRUE if a class has a specified extension.

This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))

Parameters

string $classOrExtension

if 1 argument supplied, the class name of the extension to check for; if 2 supplied, the class name to test

string $requiredExtension

used only if 2 arguments supplied

bool $strict

if the extension has to match the required extension and not be a subclass

static add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

As an alternative, extensions can be added to a specific class directly in the Object::$extensions array. See SiteTree::$extensions for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through singleton()).

Parameters

string $classOrExtension

Class that should be extended - has to be a subclass of Object

string $extension

Subclass of Extension with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

See also

http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

static remove_extension(string $extension)

Remove an extension from a class.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.

Add support for removing extensions with parameters

Parameters

string $extension

Classname of an Extension subclass, without parameters

static array get_extensions(string $class, bool $includeArgumentString = false)

No description

Parameters

string $class
bool $includeArgumentString

Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array

Numeric array of either DataExtension classnames, or eval'ed classname strings with constructor arguments.

static get_extra_config_sources($class = null)

No description

Parameters

$class

__construct()

No description

mixed __call(string $method, array $arguments)

Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located

You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()

Parameters

string $method
array $arguments

Return Value

mixed

bool hasMethod(string $method)

Return TRUE if a method exists on this object

This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions

Parameters

string $method

Return Value

bool

array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom

include methods added dynamically at runtime

Return Value

array

protected defineMethods()

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

protected array findMethodsFromExtension(object $extension)

No description

Parameters

object $extension

Return Value

array

protected addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

protected removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

protected addWrapperMethod(string $method, string $wrap)

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

Parameters

string $method

the method name to wrap

string $wrap

the method name to wrap to

protected createMethod(string $method, string $code)

Add an extra method using raw PHP code passed as a string

Parameters

string $method

the method name

string $code

the PHP code - arguments will be in an array called $args, while you can access this object by using $obj. Note that you cannot call protected methods, as the method is actually an external function

stat($name, $uncached = false)

No description

Parameters

$name
$uncached

See also

SS_Object::get_static

set_stat($name, $value)

No description

Parameters

$name
$value

See also

SS_Object::set_static

uninherited($name)

No description

Parameters

$name

See also

SS_Object::uninherited_static

bool exists()

Return true if this object "exists" i.e. has a sensible value

This method should be overriden in subclasses to provide more context about the classes state. For example, a DataObject class could return false when it is deleted from the database

Return Value

bool

string parentClass()

No description

Return Value

string

this classes parent class

bool is_a(string $class)

Check if this class is an instance of a specific class, or has that class as one of its parents

Parameters

string $class

Return Value

bool

string __toString()

No description

Return Value

string

the class name

mixed invokeWithExtensions(string $method, mixed $argument = null)

Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array

integrate inheritance rules

Parameters

string $method

the method name to call

mixed $argument

a single argument to pass

Return Value

mixed

array extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

The extension methods are defined during __construct()} in {@link defineMethods().

Parameters

string $method

the name of the method to call on each extension

mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

Extension getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

bool hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension

Classname of an Extension subclass without parameters

Return Value

bool

array getExtensionInstances()

Get all extension instances for this specific object instance.

See get_extensions() to get all applied extension classes for this class (not the instance).

Return Value

array

Map of DataExtension instances, keyed by classname.

mixed cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

Cache the results of an instance method in this object to a file, or if it is already cache return the cached results

Parameters

string $method

the method name to cache

int $lifetime

the cache lifetime in seconds

string $ID

custom cache ID to use

array $arguments

an optional array of arguments

Return Value

mixed

the cached data

clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

protected mixed loadCache(string $cache, int $lifetime = 3600)

Loads a cache from the filesystem if a valid on is present and within the specified lifetime

Parameters

string $cache

the cache name

int $lifetime

the lifetime (in seconds) of the cache before it is invalid

Return Value

mixed

protected saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

Parameters

string $cache

the cache name

mixed $data

data to save (must be serializable)

protected string sanitiseCachename(string $name)

Strip a file name of special characters so it is suitable for use as a cache file name

Parameters

string $name

Return Value

string

the name with all special cahracters replaced with underscores

string getBounceEmail()

Email used for bounces

Return Value

string

setBounceEmail(string $email)

Set the email used for bounces

Parameters

string $email

string getMessageEncoding()

Get the encoding type used for plain text messages

Return Value

string

setMessageEncoding(string $encoding)

Sets encoding type for messages. Available options are:

  • quoted-printable
  • base64

Parameters

string $encoding

protected string encodeMessage(string $message, string $encoding)

Encode a message using the given encoding mechanism

Parameters

string $message
string $encoding

Return Value

string

Encoded $message

protected array mergeCustomHeaders(array $headers, array $customHeaders)

Merge custom headers with default ones

Parameters

array $headers

Default headers

array $customHeaders

Custom headers

Return Value

array

Resulting message headers

mixed sendPlain(string $to, string $from, string $subject, string $plainContent, array $attachedFiles = false, array $customHeaders = false)

Send a plain-text email.

TestMailer will merely record that the email was asked to be sent, without sending anything.

Parameters

string $to

Email recipient

string $from

Email from

string $subject

Subject text

string $plainContent

Plain text content

array $attachedFiles

List of attached files

array $customHeaders

List of custom headers

Return Value

mixed

Return false if failure, or list of arguments if success

mixed sendHTML(string $to, string $from, string $subject, string $htmlContent, array $attachedFiles = false, array $customHeaders = false, string $plainContent = false, $inlineImages = false)

Send a multi-part HTML email TestMailer will merely record that the email was asked to be sent, without sending anything.

Parameters

string $to

Email recipient

string $from

Email from

string $subject

Subject text

string $htmlContent

HTML Content

array $attachedFiles

List of attachments

array $customHeaders

User specified headers

string $plainContent

Plain text content. If omitted, will be generated from $htmlContent

$inlineImages

Return Value

mixed

Return false if failure, or list of arguments if success

protected mixed sendPreparedMessage(string $to, string $from, string $subject, array $attachedFiles, array $customHeaders, string $fullBody, array $headers)

Send an email of an arbitrary format

Parameters

string $to To
string $from From
string $subject Subject
array $attachedFiles

List of attachments

array $customHeaders

User specified headers

string $fullBody

Prepared message

array $headers

Prepared headers

Return Value

mixed

Return false if failure, or list of arguments if success

protected mixed email(string $to, string $subjectEncoded, string $fullBody, string $headersEncoded, string $bounceAddress)

Send the actual email

Parameters

string $to
string $subjectEncoded
string $fullBody
string $headersEncoded
string $bounceAddress

Return Value

mixed

Return false if failure, or list of arguments if success

protected array encodeAttachments(array $attachments, array $headers, string $body)

Encode attachments into a message

Parameters

array $attachments
array $headers
string $body

Return Value

array

Array containing completed body followed by headers

protected string preparePlainSubmessage(string $plainContent, string $htmlContent)

Generate the plainPart of a html message

Parameters

string $plainContent

Plain body

string $htmlContent

HTML message

Return Value

string

Encoded headers / message in a single block

protected string prepareHTMLSubmessage(string $htmlContent)

Generate the html part of a html message

Parameters

string $htmlContent

HTML message

Return Value

string

Encoded headers / message in a single block

protected array encodeMultipart(array $parts, string $contentType, array $headers = array())

Encode an array of parts using multipart

Parameters

array $parts

List of parts

string $contentType

Content-type of parts

array $headers

Existing headers to include in response

Return Value

array

Array with two items, the body followed by headers

protected string processHeaders(array $headers, string $body = '')

Add headers to the start of the message

Parameters

array $headers
string $body

Return Value

string

Resulting message body

protected encodeFileForEmail($file, $destFileName = false, $disposition = NULL, $extraHeaders = "")

Encode the contents of a file for emailing, including headers

$file can be an array, in which case it expects these members: 'filename' - the filename of the file 'contents' - the raw binary contents of the file as a string and can optionally include these members: 'mimetype' - the mimetype of the file (calculated from filename if missing) 'contentLocation' - the 'Content-Location' header value for the file

$file can also be a string, in which case it is assumed to be the filename

h5. contentLocation

Content Location is one of the two methods allowed for embedding images into an html email. It's also the simplest, and best supported.

Assume we have an email with this in the body:

To display the image, an email viewer would have to download the image from the web every time it is displayed. Due to privacy issues, most viewers will not display any images unless the user clicks 'Show images in this email'. Not optimal.

However, we can also include a copy of this image as an attached file in the email. By giving it a contentLocation of "http://example.com/image.gif" most email viewers will use this attached copy instead of downloading it. Better, most viewers will show it without a 'Show images in this email' conformation.

Here is an example of passing this information through Email.php:

$email = new Email(); $email->attachments[] = array( 'filename' => BASE_PATH . "/themes/mytheme/images/header.gif", 'contents' => file_get_contents(BASE_PATH . "/themes/mytheme/images/header.gif"), 'mimetype' => 'image/gif', 'contentLocation' => Director::absoluteBaseURL() . "/themes/mytheme/images/header.gif" );

Parameters

$file
$destFileName
$disposition
$extraHeaders

validEmailAddr($emailAddress) deprecated

deprecated since version 4.0

No description

Parameters

$emailAddress

protected string validEmailAddress(string $emailAddress)

Cleans up emails which may be in 'Name [email protected]' format

Parameters

string $emailAddress

Return Value

string

wrapImagesInline($htmlContent) deprecated

deprecated since version 4.0

No description

Parameters

$htmlContent

wrapImagesInline_rewriter($url) deprecated

deprecated since version 4.0

No description

Parameters

$url

clearEmails()

Clear the log of emails sent

array findEmail($to, $from = null, $subject = null, $content = null)

Search for an email that was sent.

All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.

Parameters

$to
$from
$subject
$content

Return Value

array

Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles', 'customHeaders', 'htmlContent', 'inlineImages'