View · Index

ACS Mail Lite

Package Specification Summary for Package: acs-mail-lite

Summary:	Simplified reliable email transmission with bounce management.
Description:	This package provides a service for sending and receiving messages, messages are queued in the database to ensure reliable sending and make sending a message 'transactional'. Replacement for acs-mail.
Documentation:	Package Documentation
Maturity:	Mature and Standard
This package depends on:	acs-kernel acs-service-contract acs-tcl
Packages that depend on acs-mail-lite:	acs-admin acs-authentication acs-messaging acs-subsite bulk-mail contacts dotlrn forums mail-tracking notifications postcard project-manager simulation
Package parameters:	IMAP: IMAPHost IMAP Host to be used for sending emails (default localhost, type string, scope instance) IMAP: IMAPPassword IMAP Password to be used for sending emails (default , type string, scope instance) IMAP: IMAPPort IMAP Port to be used for sending emails (default 25, type number, scope instance) IMAP: IMAPTimeout IMAP Timeout. Waiting time until we give up with the mailserver. (default 60, type number, scope instance) IMAP: IMAPUser IMAP User to be used for sending emails (default , type string, scope instance) SMTP: SMTPHost SMTP Host to be used for sending emails (default localhost, type string, scope instance) SMTP: SMTPPassword SMTP Password to be used for sending emails (default , type string, scope instance) SMTP: SMTPPort SMTP Port to be used for sending emails (default 25, type number, scope instance) SMTP: SMTPTimeout SMTP Timeout. Waiting time until we give up with the mailserver. (default 60, type number, scope instance) SMTP: SMTPUser SMTP User to be used for sending emails (default , type string, scope instance) email: BounceDomain Email Domain for outgoing messages (default , type string, scope instance) email: BounceMailDir Location of the maildir location that accepts incoming bounces (default , type string, scope instance) email: BounceScanQueue How often (in seconds) to scan for new bounces (default 120, type number, scope instance) email: EnvelopePrefix The prefix for sending mail that will be handled by this instance. Use alphanumeric characters only. (default bounce, type string, scope instance) email: FilesystemAttachmentsRoot Path of a folder in the filesystem into which files are allowed to be read and sent as attachments. Trying to send attachments residing outside this folder will throw an error. Set this parameter to the root of your filesystem will disable this restriction. Default for the empty value of this parameter will be to allow only files into the temporary folder of the system, as in '[ns_tmpdir]' (default , type string, scope instance) email: FixedFont Font definition (after the font tag) that will always be wrapped around HTML e-mail. Example: face=Verdana size=2. Default is empty (default , type string, scope instance) email: FixedSenderEmail Email address that will be always the email stored in the sender. Default is empty (default , type string, scope instance) email: FolderID Folder ID of a folder in the content repository that contains files that can be included using checkboxes in each e-mail send out of the system. This effects /lib/email (default , type number, scope instance) email: MMEncodeBin Location of mmencode executable. (default /usr/bin/mmencode, type string, scope instance) email: MaxBounceCount Number of bounced emails after resulting in disabling an email-address (default 10, type number, scope instance) email: MaxDaysToBounce Number of days after mail sending a bounce is expected at the very latest (default 2, type number, scope instance) email: MaxNotificationCount Number of times the user will get a notification that his email got disabled in the system (default 4, type number, scope instance) email: NotificationInterval Number of days the users with bouncing email will be notified again on how to re-enable the email again (default 7, type number, scope instance) email: NotificationSender Sender of the notification email (default , type string, scope instance) email: OriginatorEmail Answers question: What value gets assigned to Originator header? Choices are: fixed_sender, from_address, message_id, reply_to, or bounce_address (value returned from acs_mail_lite::bounce_address). Originator defined in rfc2822 section 3.6.2 (default bounce_address, type string, scope instance) email: send_immediately Boolean value to say whether new mails should be send out immediately or stored in the db before send out. (default 0, type number, scope instance) inbound_email: IncomingDomain Email Domain for incoming messages (default , type string, scope instance) inbound_email: IncomingFilterProcName Procedure name for custom filtering of incoming email. Default is empty string. (default , type string, scope instance) inbound_email: IncomingMailDir Location of the maildir location that accepts incoming bounces (default , type string, scope instance) inbound_email: IncomingMaxAge Maximum time to accept replies from sent email before expiring. 604800 is 1 week of (seconds). 0 = does not expire (default 604800, type number, scope instance) inbound_email: IncomingMode Incoming email mode. Choices are: legacy (same behavior up to OpenACS 5.9.1. Deprecated, will be removed in future versions), maildir (use a MailDir location for incoming email), imap (use IMAP for incoming email). (default maildir, type string, scope instance) inbound_email: IncomingScanRate Duration between scans for new email (seconds) (default 120, type number, scope instance) rollout_support: EmailAllow Tcl list of email addresses that are allowed to receive messages when delivery mode is set to filter (default , type string, scope instance) rollout_support: EmailDeliveryMode Set how message will be delivered. default: Email messages are sent via the tcllib smtpd implementation. nssmtpd: try to send mail via SMTP based on the NaviServer nssmtpd module. log: Email messages are written to the server's error log. ignore: just write a single line per ignored mail delivery attempt. redirect: Email messages are redirected to the addresses specified by the EmailRedirectTo parameter. If this list is absent or empty, email messages are written to the server's error log. filter: Email messages are sent via SMTP if the recipient appears in the EmailAllow parameter, otherwise they are logged. The setting 'filter' and 'redirect' can be combined with 'nssmtpd' as in 'filter nssmtpd' to specify the delivery implementation (default default, type string, scope instance) rollout_support: EmailRedirectTo Tcl list of email addresses to redirect to (default , type string, scope instance)

Bug Tracker Summary for Package: acs-mail-lite

Open Bugs:	4
All Tracked Issues:	30
Latest Bug Opened:	2019-06-19 Mail server down — no retry?
Latest Bug Fixed:	2021-08-27 redirect does not work in acs-mail-lite 5.10.0d12.
Top Bug Submitters:	Jade Rubick (4) Benjamin Brink (3) Martin Magerl (2) Dirk Gomez (1) Brian Fenton (1)
Top Bug Fixers:	Malte Sussdorff (7) Gustaf Neumann (6) Jade Rubick (3) Dave Bauer (2) Caroline Meeks (1) Rocael Hernández Rizzardini (1) Torben Brosten (1)

Code Metrics Summary for Package: acs-mail-lite

# Tcl Procs	67
# Tcl Lines	5800
# Tcl Blank Lines	765
# Tcl Comment Lines	948
# Automated Tests	2
# Stored Procedures	PG: 0 ORA: 0
# SQL Lines	PG: 433 (blank 48 comments 216) ORA: 423 (blank 39 comments 213)
# ADP pages	1
# ADP lines	14
# Include pages (acs-mail-lite/lib/)	0
# Documentation pages	55 (Package Documentation)
# Documentation lines	2572
Browse Source	API-browser
Github Repository:	https://github.com/openacs/openacs-core

Commands for ds/shell to test, whether you mail setup is correct:

set to_addr [party::get -party_id [ad_conn user_id] -element email]
set from_addr [parameter::get -parameter HostAdministrator -package_id $::acs::kernel_id]

acs_mail_lite::send_immediately -to_addr $to_addr -from_addr $from_addr -body "hi" -subject "testing with send_immediately"

Popular tags

17 (1), 5.10 (1), 5.10.0 (2), 5.10.1 (1), 5.9.0 (3), 5.9.1 (4), ad_form (1), ADP (1), ajax (1), aolserver (1), asynchronous (2), bgdelivery (3), bootstrap (1), bugtracker (1), CentOS (1), COMET (1), compatibility (1), CSP (1), CSRF (1), cvs (3), debian (7), docker (2), docker-compose (1), emacs (2), engineering-standards (1), exec (1), fedora (1), FreeBSD (1), guidelines (1), host-node-map (1)

No registered users in community xowiki
in last 30 minutes

Contributors

OpenACS.org

References to this Page: en:.LRN_2.2_Release Categories: Core Packages (OpenACS.org)