coldbox.system.core.mail

Class AbstractProtocol

WEB-INF.cftags.component
        extended by coldbox.system.core.mail.AbstractProtocol
Class Attributes:
  • output : false
    •  
    Direct Known Subclasses:
    CFMailProtocol , FileProtocol , PostmarkProtocol

    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

    init

    public init([any properties='[runtime expression]'])

    Constructor called by a Concrete Protocol

    Parameters:
    properties - A map of configuration properties for the protocol
    Method Detail

    getProperties

    public any<struct> getProperties()

    Get properties structure map

    getProperty

    public any getProperty(any property)

    Get a property, throws exception if not found.

    Parameters:
    property - The key of the property to return.

    propertyExists

    public any<Boolean> propertyExists(any property)

    Checks wether a given property exists or not.

    Parameters:
    property - The property name

    send

    public struct send(any<Mail> payload)

    I send a payload via the this protocol.

    Parameters:
    payload - I'm the payload to delivery

    setProperties

    public void setProperties(any<struct> properties)

    Set the entire properties structure map

    Parameters:
    properties

    setProperty

    public void setProperty(any property, any value)

    Set a property

    Parameters:
    property - The property name to set.
    value - The value of the property.