Wikimedia SlimApp
Common classes to help with creating an application using the Slim micro framework and Twig template engine.
Loading...
Searching...
No Matches
Wikimedia\Slimapp\Mailer Class Reference

Wrapper around PHPMailer. More...

Public Member Functions

 __construct ( $settings=[], $logger=null)
 
 mail ( $to, $subject, $message, $settings=[])
 

Protected Member Functions

 createMailer ( $settings=null)
 Create and configure a PHPMailer instance.
 

Protected Attributes

 $logger
 
 $settings
 

Detailed Description

Wrapper around PHPMailer.

Author
Bryan Davis bd808.nosp@m.@wik.nosp@m.imedi.nosp@m.a.or.nosp@m.g

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Slimapp\Mailer::__construct ( $settings = [],
$logger = null )
Parameters
array$settingsConfiguration settings for PHPMailer
LoggerInterface$loggerLog channel

Member Function Documentation

◆ createMailer()

Wikimedia\Slimapp\Mailer::createMailer ( $settings = null)
protected

Create and configure a PHPMailer instance.

Parameters
array$settingsConfiguration settings
Returns
PHPMailer New mailer configured with default, instance and local settings

◆ mail()

Wikimedia\Slimapp\Mailer::mail ( $to,
$subject,
$message,
$settings = [] )
Parameters
string$toRecipient(s)
string$subjectSubject
string$messageMessage
array$settingsAdditional settings
Returns
bool Send status

Member Data Documentation

◆ $settings

Wikimedia\Slimapp\Mailer::$settings
protected
Initial value:
= [
'AllowEmpty' => false,
'CharSet' => 'utf-8',
'ContentType' => 'text/plain',
'From' => 'grants@wikimedia.org',
'FromName' => 'Wikimedia Grants',
'Mailer' => 'smtp',
'WordWrap' => 72,
'XMailer' => 'Wikimedia Grants review system',
]

The documentation for this class was generated from the following file: