ContentBox Core API 1.6.0

contentbox.model.system
Class EmailTemplateService

WEB-INF.cftags.component
        extended by contentbox.model.system.EmailTemplateService

public class EmailTemplateService
extends WEB-INF.cftags.component

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ******************************************************************************* Manage the system's email templates for admin purposes

Property Summary
Type Property & Description Default Serializable Required
 any log


Attributes:
  • inject = logbox:logger:{this}
true false
 any moduleSettings


Attributes:
  • inject = coldbox:setting:modules
true false
 string templatesPath


Attributes:
true false
 
Constructor Summary
init()
 
Method Summary
 any GETLOG()
          get:
 any GETMODULESETTINGS()
          get:
 string GETTEMPLATESPATH()
          get:
 EmailTemplateService SETLOG(any log)
          set:
 EmailTemplateService SETMODULESETTINGS(any moduleSettings)
          set:
 EmailTemplateService SETTEMPLATESPATH(string templatesPath)
          set:
 string getTemplateCode(string name)
          Get template code
 query getTemplates()
          Get installed templates
 any onDIComplete()
          onDIComplete
 EmailTemplateService saveTemplateCode(string name, string code)
          Save template code
 boolean templateExists(string name)
          Check if template exists
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init()

Property Detail

log

any log

Attributes:
inject - logbox:logger:{this}
required - false
serializable - true
default -

moduleSettings

any moduleSettings

Attributes:
inject - coldbox:setting:modules
required - false
serializable - true
default -

templatesPath

string templatesPath

Attributes:
default -
serializable - true
required - false

Method Detail

GETLOG

public any GETLOG()
get:


GETMODULESETTINGS

public any GETMODULESETTINGS()
get:


GETTEMPLATESPATH

public string GETTEMPLATESPATH()
get:


SETLOG

public EmailTemplateService SETLOG(any log)
set:

Parameters:
log

SETMODULESETTINGS

public EmailTemplateService SETMODULESETTINGS(any moduleSettings)
set:

Parameters:
moduleSettings

SETTEMPLATESPATH

public EmailTemplateService SETTEMPLATESPATH(string templatesPath)
set:

Parameters:
templatesPath

getTemplateCode

public string getTemplateCode(string name)
Get template code

Parameters:
name

getTemplates

public query getTemplates()
Get installed templates


onDIComplete

public any onDIComplete()
onDIComplete


saveTemplateCode

public EmailTemplateService saveTemplateCode(string name, string code)
Save template code

Parameters:
name
code

templateExists

public boolean templateExists(string name)
Check if template exists

Parameters:
name

ContentBox Core API 1.6.0