cbmailservices

Class MailService

lucee.Component
    extended by cbmailservices.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

Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
  • author : Luis Majano
  •  
    Property Summary
    type property default serializable required
    any mailSettings
          The mail settings configuration structure.

    • access = public
    • returntype = any
    true false
    any tokenMarker
          The token marker used for token replacements, default is `@`.

    • access = public
    • returntype = any
    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

    init

    public init([struct mailSettings='[runtime expression]'], [string tokenMarker='@'], [any wirebox])

    Constructor

    Parameters:
    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 Symbol
    wirebox - The wirebox instance

    Property Detail

    mailSettings

    property any mailSettings

    The mail settings configuration structure.

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    tokenMarker

    property any tokenMarker

    The token marker used for token replacements, default is `@`

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Method Detail

    getMailSettings

    public string getMailSettings()


    getTokenMarker

    public string getTokenMarker()


    newMail

    public 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


    parseTokens

    public any parseTokens(any mail)

    Parse the tokens and do body replacements.

    Parameters:
    mail

    send

    public struct send(Mail mail)

    Send an email payload. Returns a struct: [error:boolean, errorArray:array]

    Parameters:
    mail - The mail payload to send.

    setMailSettings

    public any setMailSettings(any mailSettings)

    Parameters:
    mailSettings

    setTokenMarker

    public any setTokenMarker(any tokenMarker)

    Parameters:
    tokenMarker