- Publicity: Public Only All
acs-mail-lite-procs.tcl
Provides a simple API for reliably sending email.
- Location:
- packages/acs-mail-lite/tcl/acs-mail-lite-procs.tcl
- Created:
- 22 March 2002
- Author:
- Eric Lorenzo <eric@openforce.net>
- CVS Identification:
$Id: acs-mail-lite-procs.tcl,v 1.108.2.34 2024/07/30 08:55:29 antoniop Exp $
Procedures in this file
- acs_mail_lite::configured_p (public)
- acs_mail_lite::get_parameter (public, deprecated)
- acs_mail_lite::send (public)
- ns_sendmail (public, deprecated)
Detailed information
acs_mail_lite::configured_p (public)
acs_mail_lite::configured_p
Determine, whether the outgoing SMTPHost is configured and reachable.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
acs_mail_lite::get_parameter (public, deprecated)
acs_mail_lite::get_parameter -name name [ -default default ]
Deprecated. Invoking this procedure generates a warning.
Returns an apm-parameter value of this package Deprecated: just a wrapper for parameter::get
- Switches:
- Options:
- -name (required)
- -default (optional)
- -name
- parameter name
- -default
- default parameter value
- Returns:
- apm-parameter value of this package
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
acs_mail_lite::send (public)
acs_mail_lite::send [ -send_immediately ] [ -valid_email ] \
-to_addr to_addr -from_addr from_addr [ -subject subject ] \
-body body [ -mime_type mime_type ] [ -cc_addr cc_addr ] \
[ -bcc_addr bcc_addr ] [ -reply_to reply_to ] \
[ -package_id package_id ] [ -no_callback ] [ -file_ids file_ids ] \
[ -filesystem_files filesystem_files ] \
[ -delete_filesystem_files ] [ -extraheaders extraheaders ] \
[ -use_sender ] [ -object_id object_id ]Prepare an email to be sent. Various email attributes can be specified, such as subject, body, senders, recipients, attachments and so on. The proc relies on MIME and SMTP.
- Switches:
- -send_immediately (optional, boolean)
- The email is send immediately and not stored in the acs_mail_lite_queue
- -valid_email (optional, boolean)
- -to_addr (required)
- List of e-mail addresses to send this mail to.
- -from_addr (required)
- E-Mail address of the sender.
- -subject (optional)
- of the email
- -body (required)
- Text body of the email
- -mime_type (optional, defaults to
"text/plain")- MIME Type of the mail to send out. Can be "text/plain", "text/html".
- -cc_addr (optional)
- List of CC Users e-mail addresses to send this mail to.
- -bcc_addr (optional)
- List of CC Users e-mail addresses to send this mail to.
- -reply_to (optional)
- -package_id (optional)
- Package ID of the sending package
- -no_callback (optional, boolean)
- Boolean that indicates if callback should be executed or not. If you don't provide it it will execute callbacks
- -file_ids (optional)
- List of file ids (items or revisions) to be sent as attachments. This will only work with files stored in the file-storage.
- -filesystem_files (optional)
- List of regular files on the filesystem to be sent as attachments.
- -delete_filesystem_files (optional, boolean)
- -extraheaders (optional)
- List of keywords and their values passed in for headers. Interesting ones are: "Precedence: list" to disable autoreplies and mark this as a list message. This is as list of lists !!
- -use_sender (optional, boolean)
- Boolean indicating that from_addr should be used regardless of fixed-sender parameter
- -object_id (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- email_send
ns_sendmail (public, deprecated)
ns_sendmail to from subject body [ extraheaders ] [ bcc ]
Deprecated. Invoking this procedure generates a warning.
Replacement for ns_sendmail for backward compatibility.
- Parameters:
- to (required)
- from (required)
- subject (required)
- body (required)
- extraheaders (optional)
- bcc (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
