Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system.plugins
Class MailService

WEB-INF.cftags.component
        coldbox.system.FrameworkSupertype
            coldbox.system.Plugin
                coldbox.system.plugins.MailService

public class MailService
extends Plugin
extends Plugin

The ColdBox Mail Service used to send emails in an oo fashion

Constructor Summary
`init(any controller)` Constructor

Method Summary
`private void`	`mailIt(Mail mail)` Mail a payload
`private any`	`mailMultiPart(Mail mail)` Mail a payload using multi part objects
`private void`	`mailNormal(Mail mail)` Mail a payload
`Mail`	`newMail()` Get a new Mail payload object, just use config() on it to prepare it
`private void`	`parseTokens(Mail Mail)` Parse the tokens and do body replacements
`struct`	`send(Mail mail)` Send an email payload

Methods inherited from class coldbox.system.Plugin
`getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL`

Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class coldbox.system.FrameworkSupertype

$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(any controller)

Constructor

Parameters:: controller

Method Detail

mailIt

private void mailIt(Mail mail)

Mail a payload

mailMultiPart

private any mailMultiPart(Mail mail)

Mail a payload using multi part objects

mailNormal

private void mailNormal(Mail mail)

Mail a payload

newMail

public Mail newMail()

Get a new Mail payload object, just use config() on it to prepare it.

parseTokens

private void parseTokens(Mail Mail)

Parse the tokens and do body replacements.

send

public struct send(Mail mail)

Send an email payload. Returns a struct: [error:boolean,errorArray:array]

Overview

Package