Overview

Packages

  • awl
    • AuthPlugin
    • AwlDatabase
    • Browser
    • classEditor
    • DataEntry
    • DataUpdate
    • EMail
    • iCalendar
    • MenuSet
    • PgQuery
    • Session
    • Translation
    • User
    • Utilities
    • Validation
    • vCalendar
    • vComponent
    • XMLDocument
    • XMLElement
  • None

Classes

  • EMail
  • Overview
  • Package
  • Class

Class EMail

Lightweight class for sending an e-mail.

Package: awl\EMail
Copyright: Catalyst IT Ltd
License: GNU GPL v2 or later
Author: Andrew McMillan andrew@mcmillan.net.nz
Located at EMail.php
Methods summary
public
# __construct( string $subject = "", string $to = "" )

Create the e-mail, optionally assigning the subject and primary recipient.

Create the e-mail, optionally assigning the subject and primary recipient.

Parameters

$subject
The subject line of the email.
$to
A comma-separated list of addresses for the primary recipient(s).
public string
# AddTo( string $recipient )

Add another recipient to the email

Add another recipient to the email

Parameters

$recipient
The email address to append.

Returns

string
The new recipient list.
public string
# To( )

Get the current recipient list.

Get the current recipient list.

Returns

string
The current recipient list.
public string
# AddCc( string $recipient )

Add another Cc recipient to the email

Add another Cc recipient to the email

Parameters

$recipient
The email address to append.

Returns

string
The new Cc recipient list.
public string
# AddBcc( string $recipient )

Add another Bcc recipient to the email

Add another Bcc recipient to the email

Parameters

$recipient
The email address to append.

Returns

string
The new Bcc recipient list.
public string
# AddReplyTo( string $recipient )

Add another Reply-to address to the email

Add another Reply-to address to the email

Parameters

$recipient
The email address to append.

Returns

string
The new Reply-to list.
public string
# AddErrorsTo( string $recipient )

Add another Error recipient to the email

Add another Error recipient to the email

Parameters

$recipient
The email address to append.

Returns

string
The new Error recipient list.
public string
# SetFrom( string $sender )

Set the visible From address for the e-mail.

Set the visible From address for the e-mail.

Parameters

$sender
$recipient The visible From address

Returns

string
The new From address
public string
# SetSender( string $sender )

Set the envelope sender address for the e-mail.

Set the envelope sender address for the e-mail.

Parameters

$sender
$recipient The e-mail address for the sender

Returns

string
The new envelope sender address.
public string
# SetSubject( string $subject )

Set the subject line for the email

Set the subject line for the email

Parameters

$subject
$recipient The new subject line.

Returns

string
The new subject line.
public string
# SetBody( string $body )

Set the body of the e-mail.

Set the body of the e-mail.

Parameters

$body
$recipient The email address to append.

Returns

string
The new body of the e-mail.
public
# Send( string $additional_headers = "" )

Actually send the email

Actually send the email

Parameters

$additional_headers
Any additional headers that are needed.
public
# PretendLog( string $additional_headers = "" )

Don't actually send the email, just log it.

Don't actually send the email, just log it.

Parameters

$additional_headers
Any additional headers that are needed.
public
# Pretend( string $additional_headers = "" )

Don't actually send the email, just output it directly in the stream(!). We use this method when we're doing regression testing.

Don't actually send the email, just output it directly in the stream(!). We use this method when we're doing regression testing.

Parameters

$additional_headers
Any additional headers that are needed.
API documentation generated by ApiGen