noticegw

NoticeGW Daemon

NoticeGW is the gateway between applications and the outside notification world.

The daemon is responsible for sending communication to the user outside any immediately application that the user may be using. Notices include e-mail, instant messaging (including texting), and notices in the userman application.

Daemon Parameters

NoticeGW reads these commhub attributes (that originate from the commhub.ini file):

Keyword	Value
metavar.URL	Value to use the for meta-variable URL. This is the site's URL. For example: http://maeappsite.com
metavar.WebSite	Value to use the for meta-variable WebSite. This is the site's name. For example: World of MAE
metavar.FromEmail	Value to use the for meta-variable FromEmail. This is the e-mail address from which e-mail appears. For example: info@maeappsite.com
metavar.StaffEmail	Value to use the for meta-variable StaffEmail. This is the e-mail address to contact the website's staff. The user does not see this e-mail. The value may be a comma separated list (no spaces). For example: info@abc.com
cmd.email	The command line to send an e-mail to a User of the system. For example: /usr/mae/bin/notice.email
cmd.facebook	The command line to send a Facebook message to a User of the system. For example: /usr/mae/bin/notice.facebook
cmd.im	The command line to send an IM message to a User of the system. For example: /usr/mae/bin/notice.im
cmd.txt	The command line to send a (SMS) text message to a User of the system. For example: /usr/mae/bin/notice.txt

Programming API to NoticeGW

Use the NoticeAPI class to post notifications to users.

Database Tables

NotifyGW uses these database tables:

Table Name	Description
User	Table of users using the system.
UserSettings	A table of user preferences that includes notification preferences. In particular, the domain of the user.
UserNotice	A notification record that tracks what notices are sent to which users.
UserComment	A table of user provided feedback. That user feedback is a notification source.

Messages Received and Processed (notice)

The following messages may be received on the notice channel.

Server API Messages (notice)

MsgTag

Description

notice

Post a notice.

notice - a UserNotice structure

comment