Callable

Class

ColdBox Platform - MockBox Version 1.2

FRAMES

mockbox.system.core.mail
Class MailService

WEB-INF.cftags.component
        mockbox.system.core.mail.MailService

public class MailService
extends WEB-INF.cftags.component
extends WEB-INF.cftags.component

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

Constructor Summary
`init([MailSettingsBean mailSettings], [string tokenMarker='@'])` Constructor

Method Summary
`MailSettingsBean`	`getMailSettingsBean()` Get the mail settings configuration object
`string`	`getTokenMarker()` Get the token marker
`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 or pass in all the arguments via this method
`private void`	`parseTokens(Mail Mail)` Parse the tokens and do body replacements
`struct`	`send(Mail mail)` Send an email payload
`void`	`setTokenMarker(string TokenMarker)` Set the token marker

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init([MailSettingsBean mailSettings], [string tokenMarker='@'])

Constructor

Parameters:: mailSettings - A configured mail settings bean with default mail configurations, else ignored and uses payload; tokenMarker - The default token Marker Symbol

Method Detail

getMailSettingsBean

public MailSettingsBean getMailSettingsBean()

Get the mail settings configuration object

getTokenMarker

public string getTokenMarker()

Get the token marker

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 or pass in all the arguments via this method

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]

setTokenMarker

public void setTokenMarker(string TokenMarker)

Set the token marker

Overview

Package