Overview

Namespaces

  • Core
    • BaseClasses
    • Cookie
    • Crontab
    • DB
    • Input
    • Mailer
    • Middleware
      • Auth
      • CSRF
    • Route
    • Session
    • System
  • None

Classes

  • Mailer
  • Overview
  • Namespace
  • Class

Class Mailer

Namespace: Core\Mailer
Located at Mailer.php
Methods summary
public Core\Mailer\Mailer
# setEngine( $engine, null $host = null, null $port = null, null $user = null, null $password = null, null $encryption = null )

Sets the mailing Engine php/swiftmailer etc avoid using this method except for testing purposes

Sets the mailing Engine php/swiftmailer etc avoid using this method except for testing purposes

Deprecated

use the config file instead

Parameters

$engine
$host
$port
$user
$password
$encryption

Returns

Core\Mailer\Mailer
class object
public static Core\Mailer\Mailer
# init( )

Initialize the mailing system

Initialize the mailing system

Returns

Core\Mailer\Mailer
class Object
public Core\Mailer\Mailer
# to( $recipients )

Sets the mail recipients

Sets the mail recipients

Parameters

$recipients
be a single email address or an array

Returns

Core\Mailer\Mailer
class Object
public Core\Mailer\Mailer
# from( $from )

Sets the sender of the mail

Sets the sender of the mail

Parameters

$from
be email address or an associative array of length 1 containing the name as key and email as value

Returns

Core\Mailer\Mailer
class Object
public Core\Mailer\Mailer
# cc( $cc )

Sets the CC recipient of the email

Sets the CC recipient of the email

Parameters

$cc
be a single email address or an array of addresses

Returns

Core\Mailer\Mailer
class Object
public Core\Mailer\Mailer
# bcc( $bcc )

Sets the Bcc recipient of the email

Sets the Bcc recipient of the email

Parameters

$bcc

Returns

Core\Mailer\Mailer
class Object
public Core\Mailer\Mailer
# contentType( $type )

Sets the content type of mail message defaults to text/plain

Sets the content type of mail message defaults to text/plain

Parameters

$type

Returns

Core\Mailer\Mailer
class Object
public Core\Mailer\Mailer
# subject( $subject )

Sets the email subject

Sets the email subject

Parameters

$subject

Returns

Core\Mailer\Mailer
class Object
public Core\Mailer\Mailer
# body( $body )

Set the body of the email message a custom view can also be passed as a string

Set the body of the email message a custom view can also be passed as a string

Parameters

$body

Returns

Core\Mailer\Mailer
class Object
public
# attach( $attachmentPath, $fileName )

Adds an attachment to the mail

Adds an attachment to the mail

Parameters

$attachmentPath
$fileName

Returns


$this
public boolean
# send( null $options = null )

Send the compiled mail

Send the compiled mail

Parameters

$options
for swiftmailer/php mailer

Returns

boolean
mail send response
protected boolean
# test( )

Returns

boolean
API documentation generated by ApiGen