com.sebtools.NoticeMgr

Component NoticeMgr (Notices Manager)

I handle event-driven email notices.


hierarchy: WEB-INF.cftags.component
      com.sebtools.NoticeMgr
properties:
methods: init, addNotice, changeDataKeys, getDataMgr, getMailer, getNotice, getNotices, loadNotices, saveNotice, sendNotice


init
public NoticeMgr init ( required DataMgr DataMgr, required Mailer Mailer )

I instantiate and return this component.

Output: suppressed
Parameters:
   DataMgr: DataMgr, required, DataMgr
   Mailer: Mailer, required, Mailer

changeDataKeys
public any changeDataKeys ( required string Name, string DataKeys )

I change the Data Keys for the given notice.

Output: suppressed
Parameters:
   Name: string, required, Name - The name of this notice (must be unique)
   DataKeys: string, optional, DataKeys - A list of data keys for the component (the values to evaluate from within brackets in the email).

addNotice
public any addNotice ( required string Component, required string Name, required string Subject, string Text, string HTML, string DataKeys )

I add the given notice if it doesn't yet exist.

Output: suppressed
Parameters:
   Component: string, required, Component - The path to your component (example com.sebtools.NoticeMgr).
   Name: string, required, Name - The name of this notice (must be unique)
   Subject: string, required, Subject - The subject of the email.
   Text: string, optional, Text - The text of the email (for plan-text email).
   HTML: string, optional, HTML - The HTML for the email (for HTML email)
   DataKeys: string, optional, DataKeys - A list of data keys for the component (the values to evaluate from within brackets in the email).

getDataMgr
public any getDataMgr ( )

I get the DataMgr for this component.

Output: suppressed

getMailer
public any getMailer ( )

I get the Mailer for this component.

Output: suppressed

getNotice
public query getNotice ( string NoticeID, string Name )

I get the requested notice.

Output: suppressed
Parameters:
   NoticeID: string, optional, NoticeID - The database id for this notice.
   Name: string, optional, Name - The unique name for this notice.

getNotices
public query getNotices ( )

I get all of the notices.

Output: suppressed

loadNotices
public any loadNotices ( )

I load notices stored in the database into memory.

Output: suppressed

saveNotice
public string saveNotice ( required string Name, string Component, required string Subject, string Text, string HTML, string DataKeys )

I save a notice.

Output: suppressed
Parameters:
   Name: string, required, Name - The unique name for this notice.
   Component: string, optional, Component - The path to your component (example com.sebtools.NoticeMgr).
   Subject: string, required, Subject - The subject of the email.
   Text: string, optional, Text - The text of the email (for plan-text email).
   HTML: string, optional, HTML - The HTML for the email (for HTML email)
   DataKeys: string, optional, DataKeys - A list of data keys for the component (the values to evaluate from within brackets in the email).

sendNotice
public struct sendNotice ( required string name, struct data )

I send set/override any data based on the data given and send the given notice.

Output: suppressed
Parameters:
   name: string, required, name - The name of the notice you want to send.
   data: struct, optional, data - The data you want to use for this email message.