AloFramework documentation
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Namespaces

  • Alo
    • Cache
    • CLI
    • Controller
    • Db
    • Exception
    • FileSystem
    • Session
    • Validators
    • Windows
  • Controller
  • None
  • PHP

Classes

  • Cookie
  • Cron
  • Curl
  • Email
  • Format
  • Handler
  • Locale
  • Profiler
  • Security
  • SFTP

Class Email

Mail wrapper for the external PHPMailer library

PHPMailer
Extended byAlo\Email
Namespace:Alo
Author:Art <a.molcanovas@gmail.com>
Link:https://github.com/PHPMailer/PHPMailer
Located atsys/class/alo/email.php

Methods summary

public
#__construct(boolean$exceptions=false)

Instantiates the class

Instantiates the class

Parameters

$exceptions
boolean
$exceptions Should we throw external exceptions?

Author

Art <a.molcanovas@gmail.com>
public staticAlo\Email
#email(boolean$exceptions=false)

Instantiates the class

Instantiates the class

Parameters

$exceptions
boolean
$exceptions Should we throw external exceptions?

Returns

Alo\Email

Author

Art <a.molcanovas@gmail.com>
public static boolean
#isEmailAddress(string$str)

Checks if the supplied string is an email

Checks if the supplied string is an email

Parameters

$str
string
$str The input

Returns

boolean

Author

Art <a.molcanovas@gmail.com>
public
#__destruct( )

Destructor. Performs cleanup operations

Destructor. Performs cleanup operations

Author

Art <a.molcanovas@gmail.com>
publicAlo\Email
#cleanup( )

Cleans up attached content

Cleans up attached content

Returns

Alo\Email

Author

Art <a.molcanovas@gmail.com>
publicAlo\Email
#addAddress(string$address,string$name='')

Adds a recipient address

Adds a recipient address

Parameters

$address
string
$address The address to add
$name
string
$name Optionally, the recipient's name

Returns

Alo\Email

Throws

phpmailerException

Author

Art <a.molcanovas@gmail.com>
publicAlo\Email
#addBCC(string$address,string$name='')

Adds a BCC address

Adds a BCC address

Parameters

$address
string
$address The address
$name
string
$name Their name

Returns

Alo\Email

Throws

phpmailerException

Author

Art <a.molcanovas@gmail.com>
publicAlo\Email
#addCC(string$address,string$name='')

Adds a CC address

Adds a CC address

Parameters

$address
string
$address The address
$name
string
$name Their name

Returns

Alo\Email

Throws

phpmailerException

Author

Art <a.molcanovas@gmail.com>
publicAlo\Email
#addReplyTo(string$to,string$name='')

Adds reply-to data

Adds reply-to data

Parameters

$to
string
$to Reply-to address
$name
string
$name Reply-to name

Returns

Alo\Email

Throws

phpmailerException

Author

Art <a.molcanovas@gmail.com>
public boolean
#send( )

Create a message and send it.

Create a message and send it.

Returns

boolean
false on error - See the ErrorInfo property for details of the error.

Throws

phpmailerException

Author

Art <a.molcanovas@gmail.com>
public boolean
#attachContent(string$name,string$content)

Attempts to attach not a file from the disk, but generated contents

Attempts to attach not a file from the disk, but generated contents

Parameters

$name
string
$name The attachment filename
$content
string
$content The contents

Returns

boolean

Throws

Exception
phpmailerException

Author

Art <a.molcanovas@gmail.com>
public array
#getDebugOutput( )

Returns the debug output from calls to $this->send()

Returns the debug output from calls to $this->send()

Returns

array

Author

Art <a.molcanovas@gmail.com>

Magic methods summary

Properties summary

public staticAlo\Email$this
#

Static reference to the last instance of the class

Static reference to the last instance of the class

protected array$debugOutput
#

Array of debug outputs, each send operation representing a key/value pair

Array of debug outputs, each send operation representing a key/value pair

protected array$attachedContent
#

Array of content attachments to clean afterwards

Array of content attachments to clean afterwards

AloFramework documentation API documentation generated byApiGen 2.8.0