• Publicity: Public Only All

notification-email-procs.tcl

Notifications Email Delivery Method

Location:
packages/notifications/tcl/notification-email-procs.tcl
Created:
2002-06-20
Author:
Ben Adida
CVS Identification:
$Id: notification-email-procs.tcl,v 1.47.2.8 2024/07/15 12:04:49 gustafn Exp $

Procedures in this file

Detailed information

notification::email::address_domain (public)

 notification::email::address_domain

Get the domain name to use for e-mail. The package parameter "EmailDomain" is preferred, but if it doesn't exist, we build one using the system URL.

Partial Call Graph (max 5 caller/called nodes):
%3 notification::email::bounce_mail_message notification::email::bounce_mail_message (public) notification::email::address_domain notification::email::address_domain notification::email::bounce_mail_message->notification::email::address_domain notification::email::reply_address notification::email::reply_address (private) notification::email::reply_address->notification::email::address_domain ad_url ad_url (public) notification::email::address_domain->ad_url notification::email::get_package_id notification::email::get_package_id (public) notification::email::address_domain->notification::email::get_package_id parameter::get parameter::get (public) notification::email::address_domain->parameter::get

Testcases:
No testcase defined.

notification::email::bounce_mail_message (public)

 notification::email::bounce_mail_message -to_addr to_addr \
    -from_addr from_addr -body body -message_headers message_headers \
    [ -reason reason ]

This sends a bounce message indicating a failure while sending a message to the system.

Switches:
-to_addr (required)
who the bounce is going to
-from_addr (required)
who the bouncing message as sent to
-body (required)
the message body
-message_headers (required)
the headers of the message
-reason (optional)
(defaults to nothing). Reason for bounce
Author:
mkovach@alal.com
Created:
05 Nov 2003

Partial Call Graph (max 5 caller/called nodes):
%3 callback::acs_mail_lite::incoming_email::impl::notifications callback::acs_mail_lite::incoming_email::impl::notifications (private) notification::email::bounce_mail_message notification::email::bounce_mail_message callback::acs_mail_lite::incoming_email::impl::notifications->notification::email::bounce_mail_message notification::email::load_qmail_mail_queue notification::email::load_qmail_mail_queue (private) notification::email::load_qmail_mail_queue->notification::email::bounce_mail_message acs_mail_lite::send acs_mail_lite::send (public) notification::email::bounce_mail_message->acs_mail_lite::send notification::email::address_domain notification::email::address_domain (public) notification::email::bounce_mail_message->notification::email::address_domain notification::email::parse_email_address notification::email::parse_email_address (private) notification::email::bounce_mail_message->notification::email::parse_email_address

Testcases:
No testcase defined.

notification::email::get_package_id (public)

 notification::email::get_package_id

Get the package id for notifications (depends on this being a singular package)

Partial Call Graph (max 5 caller/called nodes):
%3 notification::email::address_domain notification::email::address_domain (public) notification::email::get_package_id notification::email::get_package_id notification::email::address_domain->notification::email::get_package_id notification::email::get_parameter notification::email::get_parameter (public, deprecated) notification::email::get_parameter->notification::email::get_package_id notification::email::qmail_mail_queue_dir notification::email::qmail_mail_queue_dir (private) notification::email::qmail_mail_queue_dir->notification::email::get_package_id notification::email::reply_address_prefix notification::email::reply_address_prefix (public) notification::email::reply_address_prefix->notification::email::get_package_id notification::email::send notification::email::send (public) notification::email::send->notification::email::get_package_id apm_package_id_from_key apm_package_id_from_key (public) notification::email::get_package_id->apm_package_id_from_key

Testcases:
No testcase defined.

notification::email::get_parameter (public, deprecated)

 notification::email::get_parameter -name name [ -default default ]
Deprecated. Invoking this procedure generates a warning.

Shorthand proc to return a given notifications package parameter. Deprecated: just a wrapper for parameter::get

Switches:
-name (required)
-default (optional)
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) notification::email::get_package_id notification::email::get_package_id (public) parameter::get parameter::get (public) notification::email::get_parameter notification::email::get_parameter notification::email::get_parameter->ad_log_deprecated notification::email::get_parameter->notification::email::get_package_id notification::email::get_parameter->parameter::get

Testcases:
No testcase defined.

notification::email::manage_notifications_url (public)

 notification::email::manage_notifications_url

Build a URL to the "manage notifications" script.

Partial Call Graph (max 5 caller/called nodes):
%3 notification::email::send notification::email::send (public) notification::email::manage_notifications_url notification::email::manage_notifications_url notification::email::send->notification::email::manage_notifications_url ad_url ad_url (public) notification::email::manage_notifications_url->ad_url apm_package_url_from_key apm_package_url_from_key (public) notification::email::manage_notifications_url->apm_package_url_from_key notification::package_key notification::package_key (public) notification::email::manage_notifications_url->notification::package_key

Testcases:
No testcase defined.

notification::email::reply_address_prefix (public)

 notification::email::reply_address_prefix

Shorthand proc to return the email reply address prefix parameter value.

Partial Call Graph (max 5 caller/called nodes):
%3 notification::email::parse_reply_address notification::email::parse_reply_address (private) notification::email::reply_address_prefix notification::email::reply_address_prefix notification::email::parse_reply_address->notification::email::reply_address_prefix notification::email::reply_address notification::email::reply_address (private) notification::email::reply_address->notification::email::reply_address_prefix notification::email::get_package_id notification::email::get_package_id (public) notification::email::reply_address_prefix->notification::email::get_package_id parameter::get parameter::get (public) notification::email::reply_address_prefix->parameter::get

Testcases:
No testcase defined.

notification::email::send (public)

 notification::email::send from_user_id to_user_id reply_object_id \
    notification_type_id subject content_text content_html file_ids

Send the actual email.

Parameters:
from_user_id (required)
The user_id of the user that the email should be sent as. Provide empty for the standard mailer from address.
to_user_id (required)
reply_object_id (required)
notification_type_id (required)
subject (required)
content_text (required)
content_html (required)
file_ids (required)

Partial Call Graph (max 5 caller/called nodes):
%3 AcsSc.notificationdeliverymethod.send.notification_email AcsSc.notificationdeliverymethod.send.notification_email (private) notification::email::send notification::email::send AcsSc.notificationdeliverymethod.send.notification_email->notification::email::send acs_mail_lite::send acs_mail_lite::send (public) notification::email::send->acs_mail_lite::send ad_html_qualify_links ad_html_qualify_links (public) notification::email::send->ad_html_qualify_links lang::system::site_wide_locale lang::system::site_wide_locale (public) notification::email::send->lang::system::site_wide_locale lang::user::site_wide_locale lang::user::site_wide_locale (public) notification::email::send->lang::user::site_wide_locale lang::util::localize lang::util::localize (public) notification::email::send->lang::util::localize

Testcases:
No testcase defined.
[ show source ]