coldbox.system.core.mail

Class MailSettingsBean

WEB-INF.cftags.component
        extended by coldbox.system.core.mail.MailSettingsBean
Class Attributes:
  • output : false
    •  

    I model mail server settings to be used with our Mail Service

    Constructor Summary
    init([string server=''], [string username=''], [string password=''], [numeric port='0'], [struct protocol='[runtime expression]'], [string from], [string to], [string body], [string bcc], [string cc], [string charset], [boolean debug], [string failto], [string group], [boolean groupcasesensitive], [string mailerid], [numeric maxrows], [string mimeattach], [string priority], [string query], [string replyto], [boolean spoolenable], [numeric startrow], [string subject], [numeric timeout], [string type], [boolean useSSL], [boolean useTLS], [numeric wraptext])
          I return a mail setting bean.
    Method Summary
    any getMemento()
         Get the memento.
    any getPassword()
         Get Password DEPRECATED.
    any getPort()
         Get port DEPRECATED.
    any getServer()
         Get server DEPRECATED.
    any getTransit()
         Get the protocol implementation object.
    any getUsername()
         Get Username DEPRECATED.
    any getValue(any setting, [any default])
         Get a value of a setting.
    any getprotocol()
         Get protocolsettings.
    void registerProtocol([any class='coldbox.system.core.mail.protocols.CFMailProtocol'], [any properties='[runtime expression]'])
         I register a protocol with the settings.
    void setMemento(struct memento)
         Set the memento.
    any setPassword([any password])
         Set Password DEPRECATED.
    any setPort([any port])
         Set port DEPRECATED.
    any setProtocol([struct protocol])
         Set protocolsettings.
    any setServer([any server])
         Set server DEPRECATED.
    any setUsername([any username])
         Set Username DEPRECATED.
    any setValue(any setting, any value)
         Set a new setting value and return yourself.
     
    Methods inherited from class WEB-INF.cftags.component
    None
    Constructor Detail

    init

    public init([string server=''], [string username=''], [string password=''], [numeric port='0'], [struct protocol='[runtime expression]'], [string from], [string to], [string body], [string bcc], [string cc], [string charset], [boolean debug], [string failto], [string group], [boolean groupcasesensitive], [string mailerid], [numeric maxrows], [string mimeattach], [string priority], [string query], [string replyto], [boolean spoolenable], [numeric startrow], [string subject], [numeric timeout], [string type], [boolean useSSL], [boolean useTLS], [numeric wraptext])

    I return a mail setting bean.

    Parameters:
    server - Initial value for the server property.
    username - Initial value for the username property.
    password - Initial value for the password property.
    port - Initial value for the port property.
    protocol
    from - Initial value for the from property.
    to - Initial value for the to property.
    body - Initial value for the email body.
    bcc - Initial value for the bcc property.
    cc - Initial value for the cc property.
    charset - Initial value for the charset property.
    debug - Initial value for the debug property.
    failto - Initial value for the failto property.
    group - Initial value for the group property.
    groupcasesensitive - Initial value for the groupcasesensitive property.
    mailerid - Initial value for the mailerid property.
    maxrows - Initial value for the maxrows property.
    mimeattach - Initial value for the mimeattach property.
    priority - Initial value for the priority property.
    query - Initial value for the query property.
    replyto - Initial value for the replyto property.
    spoolenable - Initial value for the spoolenable property.
    startrow - Initial value for the startrow property.
    subject - Initial value for the subject property.
    timeout - Initial value for the timeout property.
    type - Initial value for the type property.
    useSSL - Initial value for the useSSL property.
    useTLS - Initial value for the useTLS property.
    wraptext - Initial value for the wraptext property.
    Method Detail

    getMemento

    public any getMemento()

    Get the memento

    getPassword

    public any getPassword()

    Get Password DEPRECATED

    Returns:
    string

    getPort

    public any getPort()

    Get port DEPRECATED

    Returns:
    string

    getServer

    public any getServer()

    Get server DEPRECATED

    Returns:
    string

    getTransit

    public any getTransit()

    Get the protocol implementation object

    Returns:
    any

    getUsername

    public any getUsername()

    Get Username DEPRECATED

    Returns:
    string

    getValue

    public any getValue(any setting, [any default])

    Get a value of a setting

    Parameters:
    setting - The name of the setting to retrieve
    default - The default value to return

    getprotocol

    public any getprotocol()

    Get protocolsettings

    Returns:
    struct

    registerProtocol

    public void registerProtocol([any class='coldbox.system.core.mail.protocols.CFMailProtocol'], [any properties='[runtime expression]'])

    I register a protocol with the settings.

    Parameters:
    class - The instantiation path of the mail protocol object
    properties - The properties to construct the protocol object with

    setMemento

    public void setMemento(struct memento)

    Set the memento

    Parameters:
    memento

    setPassword

    public any setPassword([any password])

    Set Password DEPRECATED

    Parameters:
    password
    Returns:
    any

    setPort

    public any setPort([any port])

    Set port DEPRECATED

    Parameters:
    port
    Returns:
    any

    setProtocol

    public any setProtocol([struct protocol])

    Set protocolsettings

    Parameters:
    protocol
    Returns:
    any

    setServer

    public any setServer([any server])

    Set server DEPRECATED

    Parameters:
    server
    Returns:
    any

    setUsername

    public any setUsername([any username])

    Set Username DEPRECATED

    Parameters:
    username
    Returns:
    any

    setValue

    public any setValue(any setting, any value)

    Set a new setting value and return yourself

    Parameters:
    setting - The name of the setting
    value - The value of the setting