|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.core.mail.MailService
public class MailService
The ColdBox Mail Service used to send emails in an oo and ColdBoxy fashion
Constructor Summary | |
---|---|
init([any<MailSettingsBean> mailSettings], [any tokenMarker='@'])
Constructor |
Method Summary | |
---|---|
any<MailSettingsBean> |
getMailSettingsBean()
Get the mail settings configuration object |
string |
getTokenMarker()
Get the token marker to use for body token replacements |
any<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(any<Mail> mail)
Parse the tokens and do body replacements |
struct |
send(any<Mail> mail)
Send an email payload |
void |
setTokenMarker(any tokenMarker)
Set the token marker to use for body token replacements |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init([any<MailSettingsBean> mailSettings], [any tokenMarker='@'])
mailSettings
- A configured mail settings bean with default mail configurations, else ignored and uses payloadtokenMarker
- The default token Marker SymbolMethod Detail |
---|
public any<MailSettingsBean> getMailSettingsBean()
public string getTokenMarker()
public any<Mail> newMail()
private void parseTokens(any<Mail> mail)
mail
- The mail payloadpublic struct send(any<Mail> mail)
mail
- The mail payload to send.public void setTokenMarker(any tokenMarker)
tokenMarker
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |