SMTP Email Configuration

This guide outlines the process for configuring and managing SMTP (Simple Mail Transfer Protocol) email settings within the GimCore platform. Proper SMTP configuration is essential for system-generated emails, such as notifications, password resets, and reports.

Accessing the SMTP Email Configuration Screen

To access the SMTP Email configuration screen, navigate to the System menu in the left-hand navigation pane and select SMTP Email.

Upon entering the screen, you will be presented with a data table displaying the currently configured SMTP settings.

Managing SMTP Settings

The SMTP Email screen allows administrators to view, add, edit, and delete SMTP configurations. The primary actions are performed via the Page Header buttons and the Actions column within the data table.

The SMTP Email Data Table

The data table provides a consolidated view of all SMTP server configurations. It includes the following columns:

• Host: Displays the hostname or IP address of the SMTP server.
• Port: Shows the port number used for the SMTP connection.
• Encryption: Indicates the encryption method used (e.g., SSL, TLS, None).
• Username: Displays the username for authentication with the SMTP server.
• From Name: Shows the friendly name displayed as the sender.
• From Email: Displays the email address from which outgoing emails will be sent.
• Reply To Email: Shows the email address that will be used for replies.
• Is Default: Indicates whether this SMTP configuration is set as the system's default for outgoing emails.
• Actions: Contains inline actions for editing or deleting a specific SMTP entry.

Adding a New SMTP Configuration ➕

To add a new SMTP configuration:

1. Click the Add New button located in the Page Header.
2. A modal dialog will appear, presenting fields for the new SMTP settings.
3. Provide the following information:
   • Host: Enter the SMTP server hostname or IP address.
   • Port: Specify the port number for the SMTP server (commonly 25, 465 for SSL, or 587 for TLS).
   • Encryption: Select the desired encryption method from the dropdown (e.g., None, SSL, TLS).
   • Username: Enter the username required for authenticating with the SMTP server.
   • Password: Enter the password corresponding to the provided username. This is a sensitive field and should be handled securely.
   • Confirm Password: Re-enter the password to confirm accuracy.
   • From Name: Type the sender's name that will appear in outgoing emails.
   • From Email: Enter the email address that will be used as the sender.
   • Reply To Email: Provide the email address where replies should be directed.
   • Is Default: Check this box if this configuration should be the default SMTP server for all system-generated emails.
4. Optionally, click on the Test Connection button to verify the SMTP settings. A success or failure message will be displayed.
5. Click the Save button to create the new SMTP configuration.

Editing an Existing SMTP Configuration ✏️

To modify an existing SMTP configuration:

1. Locate the desired entry in the data table.
2. Click the Edit icon (pencil icon) in the Actions column for that entry.
3. A modal dialog will appear, pre-populated with the current settings.
4. Update the necessary fields as described in the 'Adding a New SMTP Configuration' section.
5. Click the Test Connection button to verify the updated settings.
6. Click the Save button to apply your changes.

Deleting an SMTP Configuration 🗑️

To remove an SMTP configuration:

1. Locate the entry you wish to delete in the data table.
2. Click the Delete icon (trash can icon) in the Actions column for that entry.
3. A confirmation dialog will appear. Confirm your decision to proceed with the deletion.
   • Note: Deleting the default SMTP configuration will require setting another configuration as default, or system emails will fail until a new default is established.