acs-messaging-procs.tcl

Utility procs for working with messages

Location:
packages/acs-messaging/tcl/acs-messaging-procs.tcl
Created:
2000-09-01
Author:
John Prevost
CVS Identification:
$Id: acs-messaging-procs.tcl,v 1.9.2.5 2022/09/08 16:17:02 antoniop Exp $

Procedures in this file

Detailed information

acs_message_p (public)

 acs_message_p message_id

Check if an integer is a valid OpenACS message id.

Parameters:
message_id

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_messaging_message_p acs_messaging_message_p (test acs-messaging) acs_message_p acs_message_p test_acs_messaging_message_p->acs_message_p db_0or1row db_0or1row (public) acs_message_p->db_0or1row ad_page_contract_filter_proc_acs_message_id ad_page_contract_filter_proc_acs_message_id (public, deprecated) ad_page_contract_filter_proc_acs_message_id->acs_message_p

Testcases:
acs_messaging_message_p

acs_messaging_first_ancestor (public)

 acs_messaging_first_ancestor message_id

Takes the message_id of an acs_message and returns the message_id of the first ancestor message (i.e. the message that originated the thread).

Parameters:
message_id

Partial Call Graph (max 5 caller/called nodes):
%3 db_1row db_1row (public) acs_messaging_first_ancestor acs_messaging_first_ancestor acs_messaging_first_ancestor->db_1row

Testcases:
No testcase defined.

acs_messaging_format_as_html (private)

 acs_messaging_format_as_html mime_type content

Returns a string of HTML which appropriately renders the content given its mime content-type. This function supports three content types, "text/plain", "text/plain; format=flowed", and "text/html"

Parameters:
mime_type - MIME content-type of content
content - Text to view

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_messaging_format_as_html acs_messaging_format_as_html (test acs-messaging) acs_messaging_format_as_html acs_messaging_format_as_html test_acs_messaging_format_as_html->acs_messaging_format_as_html ad_text_to_html ad_text_to_html (public) acs_messaging_format_as_html->ad_text_to_html

Testcases:
acs_messaging_format_as_html

acs_messaging_process_queue (private)

 acs_messaging_process_queue

Process the message queue, sending any reasonable messages.

Partial Call Graph (max 5 caller/called nodes):
%3 acs_mail_lite::send acs_mail_lite::send (public) db_dml db_dml (public) db_foreach db_foreach (public) acs_messaging_process_queue acs_messaging_process_queue acs_messaging_process_queue->acs_mail_lite::send acs_messaging_process_queue->db_dml acs_messaging_process_queue->db_foreach

Testcases:
No testcase defined.

acs_messaging_send_query (public)

 acs_messaging_send_query -message_id message_id -query query \
    [ -bind bind ]

Given an SQL query returning columns recipient_id, grouping_id, and wait_until, arrange for all to be sent for this message. Example: acs_message_send_query -message_id $new_message -query { select subscriber_id as recipient_id, forum_id as grouping_id, bboard_util.next_period(period) as wait_until from bboard_forum_subscribers where forum_id = :forum_id } -bind [list forum_id $forum_id] Assuming bboard_util.next_period(period) returns the next date at which a digest should be sent, the above will enter info to send all subscriptions for a single message. The bind argument, if given, must be a list, NOT an ns_set.

Switches:
-message_id
(required)
-query
(required)
-bind
(optional)

Partial Call Graph (max 5 caller/called nodes):
%3 db_dml db_dml (public) acs_messaging_send_query acs_messaging_send_query acs_messaging_send_query->db_dml

Testcases:
No testcase defined.

acs_messaging_timezone_offset (private)

 acs_messaging_timezone_offset

Returns a best guess of the timezone offset for the machine.

Partial Call Graph (max 5 caller/called nodes):
%3

Testcases:
No testcase defined.

ad_page_contract_filter_proc_acs_message_id (public, deprecated)

 ad_page_contract_filter_proc_acs_message_id name value_varname
Deprecated. Invoking this procedure generates a warning.

Checks whether the value (assumed to be an integer) is the id of an already-existing OpenACS message. DEPRECATED: OpenACS now has a generic filter object_type.

Parameters:
name
value_varname
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 acs_message_p acs_message_p (public) ad_complain ad_complain (public) ad_log_deprecated ad_log_deprecated (public) ad_page_contract_filter_proc_acs_message_id ad_page_contract_filter_proc_acs_message_id ad_page_contract_filter_proc_acs_message_id->acs_message_p ad_page_contract_filter_proc_acs_message_id->ad_complain ad_page_contract_filter_proc_acs_message_id->ad_log_deprecated

Testcases:
No testcase defined.
[ show source ]