- Publicity: Public Only All
acs-mail-lite-callback-procs.tcl
Callback procs for acs-mail-lite
- Location:
- packages/acs-mail-lite/tcl/acs-mail-lite-callback-procs.tcl
- Created:
- 2005-06-15
- Author:
- Malte Sussdorff <sussdorff@sussdorff.de>
- CVS Identification:
$Id: acs-mail-lite-callback-procs.tcl,v 1.30.2.2 2021/02/22 15:05:53 antoniop Exp $
Procedures in this file
- callback::acs_mail_lite::email_form_elements::contract (private)
- callback::acs_mail_lite::email_inbound::contract (private)
- callback::acs_mail_lite::email_inbound::impl::acs-mail-lite (private)
- callback::acs_mail_lite::files::contract (private)
- callback::acs_mail_lite::incoming_email::contract (private)
- callback::acs_mail_lite::incoming_email::impl::acs-mail-lite (private, deprecated)
- callback::acs_mail_lite::incoming_object_email::contract (private)
- callback::acs_mail_lite::send::contract (private)
Detailed information
callback::acs_mail_lite::email_form_elements::contract (private)
callback::acs_mail_lite::email_form_elements::contract \ -varname varname
- Switches:
- -varname (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
callback::acs_mail_lite::email_inbound::contract (private)
callback::acs_mail_lite::email_inbound::contract \ -headers_array_name headers_array_name \ -parts_array_name parts_array_name [ -package_id package_id ] \ [ -object_id object_id ] [ -party_id party_id ] [ -other other ] \ [ -datetime_cs datetime_cs ]
Callback that is executed for inbound e-mails that are queued. package_id, object_id, party_id, other, and datetime_cs are populated only when information provided via a signed unique_id via acs_mail_lite::unique_id_create
- Switches:
- -headers_array_name (required)
- -parts_array_name (required)
- -package_id (optional)
- -object_id (optional)
- -party_id (optional)
- -other (optional)
- -datetime_cs (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
callback::acs_mail_lite::email_inbound::impl::acs-mail-lite (private)
callback::acs_mail_lite::email_inbound::impl::acs-mail-lite \ -headers_array_name headers_array_name \ -parts_array_name parts_array_name [ -package_id package_id ] \ [ -object_id object_id ] [ -party_id party_id ] [ -other other ] \ [ -datetime_cs datetime_cs ]
Example Implementation of acs_mail_lite::email_inbound. This is where documentation for callback goes.
- Switches:
- -headers_array_name (required)
- An array with all email headers.
- -parts_array_name (required)
- An array with info on files and bodies.
- -package_id (optional)
- The package_id of package that sent the original email.
- -object_id (optional)
- -party_id (optional)
- -other (optional)
- -datetime_cs (optional)
- Not all inbound email are expected to be replies.
- Created:
- 2017-10-17
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
callback::acs_mail_lite::files::contract (private)
callback::acs_mail_lite::files::contract -varname varname \ -recipient_ids recipient_ids
- Switches:
- -varname (required)
- -recipient_ids (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
callback::acs_mail_lite::incoming_email::contract (private)
callback::acs_mail_lite::incoming_email::contract -array array \ [ -package_id package_id ]
Callback that is executed for incoming e-mails if the email is *NOT* like $object_id@servername
- Switches:
- -array (required)
- -package_id (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
callback::acs_mail_lite::incoming_email::impl::acs-mail-lite (private, deprecated)
callback::acs_mail_lite::incoming_email::impl::acs-mail-lite \ -array array -package_id package_id
Deprecated. Invoking this procedure generates a warning.
Implementation of the interface acs_mail_lite::incoming_email for acs-mail-lite. This proc takes care of emails bounced back from mailer daemons. The required syntax for the To header is as follows: EnvelopPrefix-user_id-signature-package_id@myhost.com. This email was set for the Return-Path header of the original email. The signature is created by calculating the SHA value of the original Message-Id header. Thus an email is valid if the signature is correct and the user is known. If this is the case we record the bounce.
- Switches:
- -array (required)
- An array with all headers, files and bodies. To access the array you need to use upvar.
- -package_id (required)
- The package instance that registered the prefix
- Returns:
- nothing
- Error:
- Author:
- Nima Mazloumi <nima.mazloumi@gmx.de>
- Created:
- 2005-07-15
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
callback::acs_mail_lite::incoming_object_email::contract (private)
callback::acs_mail_lite::incoming_object_email::contract -array array \ -object_id object_id
Callback that is executed for incoming e-mails if the email is like $object_id@servername
- Switches:
- -array (required)
- -object_id (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
callback::acs_mail_lite::send::contract (private)
callback::acs_mail_lite::send::contract -package_id package_id \ -message_id message_id -from_addr from_addr -to_addr to_addr \ -body body [ -mime_type mime_type ] [ -subject subject ] \ [ -cc_addr cc_addr ] [ -bcc_addr bcc_addr ] [ -file_ids file_ids ] \ [ -filesystem_files filesystem_files ] \ [ -delete_filesystem_files_p delete_filesystem_files_p ] \ [ -object_id object_id ] [ -status status ] [ -errorMsg errorMsg ]
Callback for executing code after an email has been send using the send mechanism.
- Switches:
- -package_id (required)
- Package ID of the sending package
- -message_id (required)
- the generated message_id for this mail
- -from_addr (required)
- email of the sender
- -to_addr (required)
- list of emails to whom did we send this email
- -body (required)
- Text body of the email
- -mime_type (optional, defaults to
"text/plain"
)- Mime type of the email body
- -subject (optional)
- of the email
- -cc_addr (optional)
- list of emails to whom did we send this email in CC
- -bcc_addr (optional)
- list of emails to whom did we send this email in BCC
- -file_ids (optional)
- List of file ids sent as attachments.
- -filesystem_files (optional)
- -delete_filesystem_files_p (optional)
- -object_id (optional)
- The ID of the object that is responsible for sending the mail in the first place
- -status (optional, defaults to
"ok"
)- Status of the send operation ("ok" or "error")
- -errorMsg (optional)
- Error Details
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.