Mail System Documentation

Overview

The Mail system is responsible for managing email communications within the application. It handles the configuration of SMTP settings and the sending of emails to users.

Back to top

Controller

The Comserv::Controller::Mail module handles the routing and logic for mail-related actions:

• Index: Provides a basic entry point for mail-related actions.
• Send Welcome Email: Sends a welcome email to a new user using the configured SMTP settings.
• Add Mail Config Form: Displays a form to add or update SMTP configuration settings.
• Add Mail Config: Processes the form submission to store SMTP configuration in the database.

Back to top

Model

The Comserv::Model::Mail module provides methods for interacting with SMTP configuration data and sending emails:

• Send Email: Sends an email using the SMTP configuration retrieved from the database.
• Get SMTP Config: Retrieves SMTP configuration details for a specific site from the database.

Back to top

Templates

The following templates are used in the Mail system:

• mail.add_mail_config_form.tt: The template for rendering the form to add or update SMTP configuration.
• mail.success.tt: Displays a success message upon successful configuration update.
• mail.error.tt: Shows error messages when configuration fails.

Back to top

Workflow

The typical workflow for managing mail involves displaying the SMTP configuration form, processing the configuration data, and sending emails using the configured settings. The system provides feedback through success and error messages to guide the user through the configuration and email sending process.

Back to top