|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.core.mail.AbstractProtocol
public class AbstractProtocol
An abstract class that give identity to mail protocols when building custom or extending mail protocols the Mail Service uses.
Constructor Summary | |
---|---|
init([any properties='[runtime expression]'])
Constructor called by a Concrete Protocol |
Method Summary | |
---|---|
any<struct> |
getProperties()
Get properties structure map |
any |
getProperty(any property)
Get a property, throws exception if not found |
any<Boolean> |
propertyExists(any property)
Checks wether a given property exists or not |
struct |
send(any<Mail> payload)
I send a payload via the this protocol |
void |
setProperties(any<struct> properties)
Set the entire properties structure map |
void |
setProperty(any property, any value)
Set a property |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init([any properties='[runtime expression]'])
properties
- A map of configuration properties for the protocolMethod Detail |
---|
public any<struct> getProperties()
public any getProperty(any property)
property
- The key of the property to return.public any<Boolean> propertyExists(any property)
property
- The property namepublic struct send(any<Mail> payload)
payload
- I'm the payload to deliverypublic void setProperties(any<struct> properties)
properties
public void setProperty(any property, any value)
property
- The property name to set.value
- The value of the property.
|
ColdBox Platform v3.8.0 | ||||
FRAMES |