Helpers and Event Handlers
This section describes Boomerang Notification Framework developer-level objects, such as miscellaneous SQL stored procedures/functions and event handlers. These objects are made to help you speed up and simplify development and to extend hooks on which you can build additional functionality.
Helper Procedures and Functions
Name | Type | Description |
sp_Add_Email_List | Procedure | Adds a comma (or semicolon) separated string of e-mails in a single call |
sp_Resubmit_Email | Procedure | Assigns new execution time and releases a given e-mail job |
sp_Add_vCalendar | Procedure | Adds a calendar event attachment to an existing e-mail object. This procedure creates an RFC 2445 VCALENDAR VEVENT object and may be called any time after an e-mail job has been created |
sp_Add_vCalendar_Attendee | Procedure | Adds a single optional attendee to a given calendar event attachment |
sp_Resubmit_Fax | Procedure | Assigns new execution time and releases a given fax job |
sp_Resubmit_File | Procedure | Assigns new execution time and releases a given file job |
sp_Resubmit_Print | Procedure | Assigns new execution time and releases a given print job |
sp_Resubmit_Sms | Procedure | Assigns new execution time and releases a given SMS job |
fn_Get_Email_Key | Scalar Function | Searches a string (i.e. body section of an incoming e-mail message) for keys to related outgoing e-mail job |
fn_Get_Text_Before_Token | Scalar Function | Searches a string (i.e. body section of an incoming e-mail message) for a given text pattern and returns a substring before first occurance of such text pattern |
fn_Get_Reply_Text | Scalar Function | Searches a string (i.e. body section of an incoming e-mail message) for string of keys and returns the top text before string of keys |
Event Handlers
The following event handlers may be triggered by Boomerang services.
Name | Type | Description |
sp_After_Email_Job | Procedure | Triggered upon completion of an e-mail job |
sp_After_Fax_Job | Procedure | Triggered upon completion of a fax job |
sp_After_File_Job | Procedure | Triggered upon completion of a file job |
sp_After_Print_Job | Procedure | Triggered upon completion of a print job |
sp_After_Sms_Job | Procedure | Triggered upon completion of a sms job |
sp_On_Fax_Status | Procedure | Triggered when notification received from the fax server upon a fax job progress |
sp_On_Email_In | Procedure | Triggered after the new incoming e-mail message is received |
sp_On_Sms_In | Procedure | Triggered after the new incoming text (SMS) message is received |
sp_On_Sms_Status | Procedure | Triggered when a status of an inbound SMS message has been changed |
sp_On_Twit_In | Procedure | Triggered after a new Twitter status updated has been received |