lucee.Componentcontentbox.modules.contentbox-deps.modules.cbmailservices.models.MailService
Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com The ColdBox Mail Service used to send emails in an oo and ColdBoxy fashion
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
mailSettings
The mail settings configuration structure.
|
true
|
false
|
|
any
|
tokenMarker
The token marker used for token replacements, default is `@`.
|
true
|
false
|
Constructor Summary | |
---|---|
init([struct mailSettings='[runtime expression]'], [string tokenMarker='@'], [any wirebox])
Constructor. |
Method Summary | |
---|---|
string
|
getMailSettings()
|
string
|
getTokenMarker()
|
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. |
any
|
parseTokens(any mail)
Parse the tokens and do body replacements. |
struct
|
send(Mail mail)
Send an email payload. |
any
|
setMailSettings(any mailSettings)
|
any
|
setTokenMarker(any tokenMarker)
|
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
mailSettings
- A structure of mail settings and protocol to bind this service with. A MailSettingsBean object is created with it.tokenMarker
- The default token Marker Symbolwirebox
- The wirebox instanceProperty Detail |
---|
The mail settings configuration structure.
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe token marker used for token replacements, default is `@`
access
- publicrequired
- falsereturntype
- anyserializable
- trueMethod Detail |
---|
Get a new Mail payload object, just use config() on it to prepare it or pass in all the arguments via this method
Parse the tokens and do body replacements.
mail
Send an email payload. Returns a struct: [error:boolean, errorArray:array]
mail
- The mail payload to send.mailSettings
tokenMarker