• Publicity: Public Only All

legacy-inbound-procs.tcl

Provides a simple API for reliably sending email. (Legacy and deprecated procs)

Location:
packages/acs-mail-lite/tcl/legacy-inbound-procs.tcl
Created:
21 June 2018
Author:
Hector Romojaro <hector.romojaro@gmail.com>
CVS Identification:
$Id: legacy-inbound-procs.tcl,v 1.2.2.6 2021/02/22 15:05:53 antoniop Exp $

Procedures in this file

Detailed information

acs_mail_lite::autoreply_p (public, deprecated)

 acs_mail_lite::autoreply_p [ -subject subject ] [ -from from ]
Deprecated. Invoking this procedure generates a warning.

Parse the subject, from and body to determine if the email is an auto reply Typical autoreplies are "Out of office" messages. This is what the procedure does

Switches:
-subject (optional)
Subject of the Email that will be scanned for "out of office"
-from (optional)
From address which will be checked if it is coming from a mailer daemon
Returns:
1 if this is actually an autoreply

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 acs_mail_lite::load_mails acs_mail_lite::load_mails (public, deprecated) acs_mail_lite::autoreply_p acs_mail_lite::autoreply_p acs_mail_lite::load_mails->acs_mail_lite::autoreply_p ad_get_tcl_call_stack ad_get_tcl_call_stack (public) acs_mail_lite::autoreply_p->ad_get_tcl_call_stack

Testcases:
No testcase defined.

acs_mail_lite::bouncing_email_p (public, deprecated)

 acs_mail_lite::bouncing_email_p -email email
Deprecated. Invoking this procedure generates a warning.

Checks if email address is bouncing mail

Switches:
-email (required)
Options:
-email
email address to be checked for bouncing
Returns:
boolean 1 if bouncing 0 if ok.

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 acs_mail_lite::bouncing_user_p acs_mail_lite::bouncing_user_p (private) ad_get_tcl_call_stack ad_get_tcl_call_stack (public) party::get_by_email party::get_by_email (public) acs_mail_lite::bouncing_email_p acs_mail_lite::bouncing_email_p acs_mail_lite::bouncing_email_p->acs_mail_lite::bouncing_user_p acs_mail_lite::bouncing_email_p->ad_get_tcl_call_stack acs_mail_lite::bouncing_email_p->party::get_by_email

Testcases:
No testcase defined.

acs_mail_lite::load_mails (public, deprecated)

 acs_mail_lite::load_mails -queue_dir queue_dir
Deprecated. Invoking this procedure generates a warning.

Scans for incoming email. The function requires incoming emails that comply to the following syntax rule:

        [<SitePrefix>][-]<ReplyPrefix>-Whatever@<BounceDomain>

        [] = optional
        <> = Package Parameters
        
If no SitePrefix is set we assume that there is only one OpenACS installation. Otherwise only messages are dealt with which contain a SitePrefix. ReplyPrefixes are provided by packages that implement the callback acs_mail_lite::incoming_email and provide a package parameter called ReplyPrefix. Only implementations are considered where the implementation name is equal to the package key of the package. Also we only deal with messages that contain a valid and registered ReplyPrefix. These prefixes are automatically set in the acs_mail_lite_prefixes table.

Switches:
-queue_dir (required)
Options:
-queue_dir
The location of the qmail mail (BounceMailDir) queue in the file-system i.e. /home/service0/mail.
Author:
Nima Mazloumi <nima.mazloumi@gmx.de>
Created:
2005-07-15

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 acs_mail_lite::scan_replies acs_mail_lite::scan_replies (public, deprecated) acs_mail_lite::load_mails acs_mail_lite::load_mails acs_mail_lite::scan_replies->acs_mail_lite::load_mails acs_mail_lite::autoreply_p acs_mail_lite::autoreply_p (public, deprecated) acs_mail_lite::load_mails->acs_mail_lite::autoreply_p acs_mail_lite::parse_email acs_mail_lite::parse_email (private) acs_mail_lite::load_mails->acs_mail_lite::parse_email acs_mail_lite::parse_email_address acs_mail_lite::parse_email_address (private) acs_mail_lite::load_mails->acs_mail_lite::parse_email_address acs_object::object_p acs_object::object_p (public) acs_mail_lite::load_mails->acs_object::object_p ad_get_tcl_call_stack ad_get_tcl_call_stack (public) acs_mail_lite::load_mails->ad_get_tcl_call_stack

Testcases:
No testcase defined.

acs_mail_lite::parse_bounce_address (public, deprecated)

 acs_mail_lite::parse_bounce_address -bounce_address bounce_address
Deprecated. Invoking this procedure generates a warning.

This takes a reply address, checks it for consistency, and returns a list of user_id, package_id and bounce_signature found

Switches:
-bounce_address (required)
Options:
-bounce_address
bounce address to be checked
Returns:
tcl-list of user_id package_id bounce_signature

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 callback::acs_mail_lite::incoming_email::impl::acs-mail-lite callback::acs_mail_lite::incoming_email::impl::acs-mail-lite (private, deprecated) acs_mail_lite::parse_bounce_address acs_mail_lite::parse_bounce_address callback::acs_mail_lite::incoming_email::impl::acs-mail-lite->acs_mail_lite::parse_bounce_address acs_mail_lite::bounce_prefix acs_mail_lite::bounce_prefix (private) acs_mail_lite::parse_bounce_address->acs_mail_lite::bounce_prefix ad_get_tcl_call_stack ad_get_tcl_call_stack (public) acs_mail_lite::parse_bounce_address->ad_get_tcl_call_stack

Testcases:
No testcase defined.

acs_mail_lite::record_bounce (public, deprecated)

 acs_mail_lite::record_bounce [ -user_id user_id ] [ -email email ]
Deprecated. Invoking this procedure generates a warning.

Records that an email bounce for this user

Switches:
-user_id (optional)
-email (optional)

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 callback::acs_mail_lite::incoming_email::impl::acs-mail-lite callback::acs_mail_lite::incoming_email::impl::acs-mail-lite (private, deprecated) acs_mail_lite::record_bounce acs_mail_lite::record_bounce callback::acs_mail_lite::incoming_email::impl::acs-mail-lite->acs_mail_lite::record_bounce acs_mail_lite::bouncing_user_p acs_mail_lite::bouncing_user_p (private) acs_mail_lite::record_bounce->acs_mail_lite::bouncing_user_p ad_get_tcl_call_stack ad_get_tcl_call_stack (public) acs_mail_lite::record_bounce->ad_get_tcl_call_stack db_dml db_dml (public) acs_mail_lite::record_bounce->db_dml db_resultrows db_resultrows (public) acs_mail_lite::record_bounce->db_resultrows party::get_by_email party::get_by_email (public) acs_mail_lite::record_bounce->party::get_by_email

Testcases:
No testcase defined.

acs_mail_lite::scan_replies (public, deprecated)

 acs_mail_lite::scan_replies
Deprecated. Invoking this procedure generates a warning.

Scheduled procedure that will scan for bounced mails


See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 acs_mail_lite::load_mails acs_mail_lite::load_mails (public, deprecated) acs_mail_lite::mail_dir acs_mail_lite::mail_dir (private) ad_get_tcl_call_stack ad_get_tcl_call_stack (public) ad_try ad_try (public) acs_mail_lite::scan_replies acs_mail_lite::scan_replies acs_mail_lite::scan_replies->acs_mail_lite::load_mails acs_mail_lite::scan_replies->acs_mail_lite::mail_dir acs_mail_lite::scan_replies->ad_get_tcl_call_stack acs_mail_lite::scan_replies->ad_try

Testcases:
No testcase defined.
[ show source ]