notification-email-procs.tcl

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

notification::email::address_domain (public)
notification::email::bounce_mail_message (public)
notification::email::get_package_id (public)
notification::email::get_parameter (public, deprecated)
notification::email::load_qmail_mail_queue (private)
notification::email::manage_notifications_url (public)
notification::email::parse_email_address (private)
notification::email::parse_reply_address (private)
notification::email::qmail_mail_queue_dir (private)
notification::email::reply_address (private)
notification::email::reply_address_prefix (public)
notification::email::scan_replies (private)
notification::email::send (public)

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):

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):

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):

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:

parameter::get

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

Testcases:
No testcase defined.

notification::email::load_qmail_mail_queue (private)

 notification::email::load_qmail_mail_queue -queue_dir queue_dir

Scans qmail incoming email queue and queues up messages using acs-mail.

Switches:

-queue_dir (required)
The location of the qmail mail queue in the file-system.

Authors:

ben@openforce.net

dan.wickstrom@openforce.net

Created:

22 Sept, 2001

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

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):

Testcases:
No testcase defined.

notification::email::parse_email_address (private)

 notification::email::parse_email_address email

Strip out the user's name (in angle brackets) from an e-mail address if it exists.

Parameters:

email (required)

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

Testcases:
No testcase defined.

notification::email::parse_reply_address (private)

 notification::email::parse_reply_address -reply_address reply_address

This takes a reply address, checks it for consistency, and returns a list of object_id and type_id

Switches:

-reply_address (required)

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

Testcases:
No testcase defined.

notification::email::qmail_mail_queue_dir (private)

 notification::email::qmail_mail_queue_dir

Shorthand proc to return the email qmail-style mail queue (i.e. a Maildir directory)

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

Testcases:
No testcase defined.

notification::email::reply_address (private)

 notification::email::reply_address -object_id object_id \
    -type_id type_id

Build an object/type-specific e-mail address that the user can reply to.

Switches:

-object_id (required)
-type_id (required)

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

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):

Testcases:
No testcase defined.

notification::email::scan_replies (private)

 notification::email::scan_replies

scan for replies

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

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):

Testcases:
No testcase defined.

[ show source ]