\FAA\Handler\MailerPhpMail

Summary

Methods

Properties

Constants

SendInterface()
AddAttachment()
AddEmbeddedImage()
GetFormPreset()
GetDefaultSettings()
GetSettings()
StoreSettings()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

config()

$settings
$deamon
$debug
$config_file
$preset_file
$default_config_file

N/A

Properties

$settings

$settings :\stdClass

Store the local config Buffer the local configuration object

Type

\stdClass—Configuration object

$deamon

$deamon :\PHPMailer\PHPMailer\PHPMailer

Buffer handler Store the mail send abstraction layer

Type

\PHPMailer\PHPMailer\PHPMailer—A php mailer instance

$debug

$debug :

Type

$config_file

$config_file :

Type

$preset_file

$preset_file :

Type

$default_config_file

$default_config_file :

Type

Methods

SendInterface()

SendInterface(\FAA\Obj\Generic\Email  $mail): \FAA\Obj\Result

Get the mailer Get the mailer instance and handle further operations

Parameters

\FAA\Obj\Generic\Email

$mail

Set the mail to send

Throws

Returns

\FAA\Obj\Result —

The send via interface result

AddAttachment()

AddAttachment(string  $path,string  $name): boolean

Add attachment Add an attachment to mail

Parameters

string	$path	Absolute path to file
string	$name	Speaking name

Throws

Returns

boolean —

Adding worked

AddEmbeddedImage()

AddEmbeddedImage(string  $path,string  $id): boolean

Add an image Add internal embedded image to this mail

Parameters

string	$path	Absolute path to file
string	$id	Reference id

Returns

boolean —

The add result

GetFormPreset()

GetFormPreset(): \FAA\Obj\Result

preset load the common pickup settings preset for generation a form

Returns

\FAA\Obj\Result —

$result A system result object

GetDefaultSettings()

GetDefaultSettings(): \FAA\Obj\Result

load defaults load the default settings for this mail method

Returns

\FAA\Obj\Result —

$result A system result object

GetSettings()

GetSettings(): \FAA\Obj\Result

get load the common mail settings object

Returns

\FAA\Obj\Result —

$result A system result object

StoreSettings()

StoreSettings(\stdClass  $values): \FAA\Obj\Result

store store the common pickup settings object

Parameters

\stdClass

$values

The configuration values

Returns

\FAA\Obj\Result —

$result A system result object

config()

config(): \stdClass

connect load settings object from local storage

Returns

\stdClass