Mail
extends PHPMailer
in package
Wrapper class for \PHPMailer
Tags
Table of Contents
Properties
- $softFail : bool
- If set to TRUE, then the send process is not actually executed.
Methods
- __construct() : mixed
- addAttachment() : mixed
- addEmbeddedImage() : mixed
- postSend() : mixed
- preSend() : mixed
- softFail() : mixed
- Enable {@see static::$softFail}
- addAnAddress() : mixed
- isAllowedAttachment() : bool
- Verify if $path is a valid attachment
- mailSend() : mixed
- Turn off sendmail options for non-sendmail MTA
- makeImagesAbsoluteInHtmlBody() : mixed
- Converts `src` attributes of `img` HTML tags in the HTML-body {@see static::$Body} into absolute URLs.
- parseNodePlaceholders() : void
- Replaces any {@see \Cx\Core\Routing\NodePlaceholder} by its target URL in the HTML-body ({@see static::Body}).
Properties
$softFail
If set to TRUE, then the send process is not actually executed.
protected
bool
$softFail
= false
However the method static::send() still returns TRUE as if the send process was successful.
Methods
__construct()
public
__construct([mixed $exceptions = false ]) : mixed
Parameters
- $exceptions : mixed = false
addAttachment()
public
addAttachment(mixed $path[, mixed $name = '' ][, mixed $encoding = 'base64' ][, mixed $type = '' ][, mixed $disposition = 'attachment' ]) : mixed
Parameters
- $path : mixed
- $name : mixed = ''
- $encoding : mixed = 'base64'
- $type : mixed = ''
- $disposition : mixed = 'attachment'
addEmbeddedImage()
public
addEmbeddedImage(mixed $path, mixed $cid[, mixed $name = '' ][, mixed $encoding = 'base64' ][, mixed $type = '' ][, mixed $disposition = 'inline' ]) : mixed
Parameters
- $path : mixed
- $cid : mixed
- $name : mixed = ''
- $encoding : mixed = 'base64'
- $type : mixed = ''
- $disposition : mixed = 'inline'
postSend()
public
postSend() : mixed
Tags
preSend()
public
preSend() : mixed
Tags
softFail()
Enable {@see static::$softFail}
public
softFail() : mixed
addAnAddress()
protected
addAnAddress(mixed $kind, mixed $address[, mixed $name = '' ]) : mixed
Parameters
- $kind : mixed
- $address : mixed
- $name : mixed = ''
Tags
isAllowedAttachment()
Verify if $path is a valid attachment
protected
isAllowedAttachment(mixed $path) : bool
A valid attachment is a file located in a non-privileged filesystem location. See FileSystemFile::$privileged.
Parameters
- $path : mixed
Return values
bool —True if $path is a file located in one of the allowed locations.
mailSend()
Turn off sendmail options for non-sendmail MTA
protected
mailSend(mixed $header, mixed $body) : mixed
If the "sendmail" program is not sendmail itself we need to assume that it doesn't support sendmail compatible options.
It would be nicer to do this in mailPassthru(), but since this method is private we cannot overwrite it.
Parameters
- $header : mixed
- $body : mixed
Tags
makeImagesAbsoluteInHtmlBody()
Converts `src` attributes of `img` HTML tags in the HTML-body {@see static::$Body} into absolute URLs.
protected
makeImagesAbsoluteInHtmlBody() : mixed
parseNodePlaceholders()
Replaces any {@see \Cx\Core\Routing\NodePlaceholder} by its target URL in the HTML-body ({@see static::Body}).
protected
parseNodePlaceholders() : void