\FAA\InterfacesMailSender

Summary

Methods
Constants
SendInterface()
GetFormPreset()
GetSettings()
GetDefaultSettings()
StoreSettings()
AddAttachment()
AddEmbeddedImage()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

SendInterface()

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

Get the mailer Get the mailer instance and handle further operations

Parameters

\FAA\Obj\Generic\Email $mail

The mail to send

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

GetSettings()

GetSettings(): \FAA\Obj\Result

get load the common pickup settings object

Returns

\FAA\Obj\Result —

$result A system result object

GetDefaultSettings()

GetDefaultSettings(): \FAA\Obj\Result

load defaults load the default settings for this delivery method

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

AddAttachment()

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

Add an attachment Add attachment to mail

Parameters

string $path

Absolute path to file

string $name

Speaking name

Returns

boolean —

The add result

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