Menu

## SwiftMailerHandler extends MailHandler
in package

SwiftMailerHandler.php : 24

SwiftMailerHandler uses Swift_Mailer to send the emails

##### Tags

author

  Gyula Sallai

### Table of Contents

$bubble : mixed
$formatter : FormatterInterface
$level : mixed
$mailer : mixed
$processors : mixed
$messageTemplate : mixed
__construct() : mixed
__destruct() : mixed
__get() : mixed
  BC getter, to be removed in 2.0
close() : mixed
  Closes the handler.
getBubble() : bool
  Gets the bubbling behavior.
getFormatter() : FormatterInterface
  Gets the formatter.
getLevel() : int
  Gets minimum logging level at which this handler will be triggered.
handle() : mixed
  {@inheritdoc}
handleBatch() : mixed
  Handles a set of records at once.
isHandling() : bool
  Checks whether the given record will be handled by this handler.
popProcessor() : callable
  Removes the processor on top of the stack and returns it.
pushProcessor() : self
  Adds a processor in the stack.
reset() : mixed
setBubble() : self
  Sets the bubbling behavior.
setFormatter() : self
  Sets the formatter.
setLevel() : self
  Sets minimum logging level at which this handler will be triggered.
buildMessage() : Swift_Message
  Creates instance of Swift_Message to be sent
getDefaultFormatter() : FormatterInterface
  Gets the default formatter.
getHighestRecord() : mixed
getSubjectFormatter() : FormatterInterface
  Gets the formatter for the Swift_Message subject.
processRecord() : array<string|int, mixed>
  Processes a record.
send() : mixed
  Send a mail with the given content
write() : void
  Writes the record down to the log of the implementing handler

### Properties

#### $bubble

AbstractHandler.php : 27
`protected mixed $bubble = true`

#### $formatter

AbstractHandler.php : 32
`protected FormatterInterface $formatter`

#### $level

AbstractHandler.php : 26
`protected mixed $level = MonologLogger::DEBUG`

#### $mailer

SwiftMailerHandler.php : 26
`protected mixed $mailer`

#### $processors

AbstractHandler.php : 33
`protected mixed $processors = array()`

#### $messageTemplate

SwiftMailerHandler.php : 27
`private mixed $messageTemplate`

### Methods

#### __construct()

SwiftMailerHandler.php : 35
`public __construct(Swift_Mailer $mailer, callable|Swift_Message $message[, int $level = Logger::ERROR ][, bool $bubble = true ]) : mixed`

##### Parameters

$mailer : Swift_Mailer

  The mailer to use

$message : callable|Swift_Message

  An example message for real messages, only the body will be replaced

$level : int = Logger::ERROR

  The minimum logging level at which this handler will be triggered

$bubble : bool = true

  Whether the messages that are handled can bubble up the stack or not

##### Return values

mixed —

#### __destruct()

AbstractHandler.php : 167
`public __destruct() : mixed`

##### Return values

mixed —

#### __get()

SwiftMailerHandler.php : 101

BC getter, to be removed in 2.0

`public __get(mixed $name) : mixed`

##### Parameters

$name : mixed

##### Return values

mixed —

#### close()

AbstractHandler.php : 68

Closes the handler.

`public close() : mixed`

This will be called automatically when the object is destroyed

##### Return values

mixed —

#### getBubble()

AbstractHandler.php : 162

Gets the bubbling behavior.

`public getBubble() : bool`

##### Return values

bool —

true means that this handler allows bubbling. false means that bubbling is not permitted.

#### getFormatter()

AbstractHandler.php : 110

Gets the formatter.

`public getFormatter() : FormatterInterface`

##### Return values

FormatterInterface —

#### getLevel()

AbstractHandler.php : 137

Gets minimum logging level at which this handler will be triggered.

`public getLevel() : int`

##### Return values

int —

#### handle()

AbstractProcessingHandler.php : 29

{@inheritdoc}

`public handle(array<string|int, mixed> $record) : mixed`

##### Parameters

$record : array<string|int, mixed>

##### Return values

mixed —

#### handleBatch()

AbstractHandler.php : 56

Handles a set of records at once.

`public handleBatch(array<string|int, mixed> $records) : mixed`

##### Parameters

$records : array<string|int, mixed>

  The records to handle (an array of record arrays)

##### Return values

mixed —

#### isHandling()

AbstractHandler.php : 48

Checks whether the given record will be handled by this handler.

`public isHandling(array<string|int, mixed> $record) : bool`

##### Parameters

$record : array<string|int, mixed>

  Partial log record containing only a level key

##### Return values

bool —

#### popProcessor()

AbstractHandler.php : 88

Removes the processor on top of the stack and returns it.

`public popProcessor() : callable`

##### Return values

callable —

#### pushProcessor()

AbstractHandler.php : 75

Adds a processor in the stack.

`public pushProcessor(mixed $callback) : self`

##### Parameters

$callback : mixed

##### Return values

self —

#### reset()

AbstractHandler.php : 178
`public reset() : mixed`

##### Return values

mixed —

#### setBubble()

AbstractHandler.php : 149

Sets the bubbling behavior.

`public setBubble(bool $bubble) : self`

##### Parameters

$bubble : bool

  true means that this handler allows bubbling. false means that bubbling is not permitted.

##### Return values

self —

#### setFormatter()

AbstractHandler.php : 100

Sets the formatter.

`public setFormatter(FormatterInterface $formatter) : self`

##### Parameters

$formatter : FormatterInterface

##### Return values

self —

#### setLevel()

AbstractHandler.php : 125

Sets minimum logging level at which this handler will be triggered.

`public setLevel(int|string $level) : self`

##### Parameters

$level : int|string

  Level or level name

##### Return values

self —

#### buildMessage()

SwiftMailerHandler.php : 69

Creates instance of Swift_Message to be sent

`protected buildMessage(string $content, array<string|int, mixed> $records) : Swift_Message`

##### Parameters

$content : string

  formatted email body to be sent

$records : array<string|int, mixed>

  Log records that formed the content

##### Return values

Swift_Message —

#### getDefaultFormatter()

AbstractHandler.php : 192

Gets the default formatter.

`protected getDefaultFormatter() : FormatterInterface`

##### Return values

FormatterInterface —

#### getHighestRecord()

MailHandler.php : 56
`protected getHighestRecord(array<string|int, mixed> $records) : mixed`

##### Parameters

$records : array<string|int, mixed>

##### Return values

mixed —

#### getSubjectFormatter()

SwiftMailerHandler.php : 57

Gets the formatter for the Swift_Message subject.

`protected getSubjectFormatter(string $format) : FormatterInterface`

##### Parameters

$format : string

  The format of the subject

##### Return values

FormatterInterface —

#### processRecord()

AbstractProcessingHandler.php : 58

Processes a record.

`protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>`

##### Parameters

$record : array<string|int, mixed>

##### Return values

array<string|int, mixed> —

#### send()

SwiftMailerHandler.php : 46

Send a mail with the given content

`protected send(mixed $content, array<string|int, mixed> $records) : mixed`

##### Parameters

$content : mixed

  formatted email body to be sent

$records : array<string|int, mixed>

  the array of log records that formed this content

##### Return values

mixed —

#### write()

AbstractProcessingHandler.php : 50

Writes the record down to the log of the implementing handler

`protected abstract write(array<string|int, mixed> $record) : void`

##### Parameters

$record : array<string|int, mixed>

##### Return values

void —

## Search results