Jump to Content

Objective HTML

Postmaster

The definitive email solution for ExpressionEngine

Postmaster Core

The Postmaster Core class is an abstract class from which all other classes are extended.

Properties

$filename
The name of the file that was loaded.
$name
The name of the object. This is a valid PHP class name (all lowercase).
$description
The name of the object.
$title
The title of the object. This is the human readable name.
$var_prefix
The variable prefix is used to prefix all the parsed variables with a prefix.
$class_suffix
This the suffix that is used for all classes extending the base api.
$settings
An array of settings
$default_settings
The default settings array
$fields
An array of InterfaceBuilder fields

Extends

Base Class


Methods

install()

The install() method is triggered when Postmaster is installed. Each API has an install routine that may be used to perform custom logic.

Return

(void)

update($version)

The update() method is triggered when Postmaster is updated. Each API has an update routine that may be used to perform custom logic.

$version
This string is the Postmaster version
Return

(void)

uninstall()

The uninstall() method is triggered when Postmaster is uninstalled. Each API has an uninstall routine that may be used to perform custom logic.

Return

(void)

get_title()

Gets the object's title if different than the name.

Return

(string) Object title

trim_array($array, $prefix = '', $suffix = '')

This method trims the values of an array, while allowing you to insert prefixes and suffixes.

Return

(array) A trimmed array