ISSUE-345: doc

Author: tatevikg1

README.md

@@ -53,9 +53,11 @@ this code.
 ## Structure
 
 * [Class Docs][docs/phpdoc/]
+* [Mailer Transports](docs/mailer-transports.md) - How to use different email providers (Gmail, Amazon SES, Mailchimp, SendGrid)
 * [Class structure overview](docs/ClassStructure.md)
 * [Graphic domain model](docs/DomainModel/DomainModel.svg) and
   a [description of the domain entities](docs/DomainModel/Entities.md)
+* [Mailer Transports](docs/mailer-transports.md) - How to use different email providers (Gmail, Amazon SES, Mailchimp, SendGrid)
 
 
 ## Running the web server
@@ -203,6 +205,17 @@ phpList module), please use the
 [REST API](https://github.com/phpList/rest-api).
 
 
+## Email Configuration
+
+phpList supports multiple email transport providers through Symfony Mailer. The following transports are included:
+
+* Gmail
+* Amazon SES
+* Mailchimp Transactional (Mandrill)
+* SendGrid
+
+For detailed configuration instructions, see the [Mailer Transports documentation](docs/mailer-transports.md).
+
 ## Copyright
 
 phpList is copyright (C) 2000-2021 [phpList Ltd](https://www.phplist.com/).

docs/ClassStructure.md

@@ -21,7 +21,7 @@ database access code in these classes.
 
 ### Repository/
 
-These classes are reponsible for reading domain models from the database,
+These classes are responsible for reading domain models from the database,
 for writing them there, and for other database queries.
 
 

docs/MailerTransports.md

@@ -0,0 +1,105 @@
+# Using Different Mailer Transports in phpList
+
+This document explains how to use the various mailer transports that are included in the phpList core dependencies:
+
+- Google Mailer (Gmail)
+- Amazon SES
+- Mailchimp Transactional (Mandrill)
+- SendGrid
+
+## Configuration
+
+The phpList core uses Symfony Mailer for sending emails. The mailer transport is configured using the `MAILER_DSN` environment variable, which is defined in `config/parameters.yml`.
+
+## Available Transports
+
+### 1. Google Mailer (Gmail)
+
+To use Gmail as your email transport:
+
+```
+# Using Gmail with OAuth (recommended)
+MAILER_DSN=gmail://USERNAME:APP_PASSWORD@default
+
+# Using Gmail with SMTP
+MAILER_DSN=smtp://USERNAME:[email protected]:587
+```
+
+Notes:
+- Replace `USERNAME` with your Gmail address
+- For OAuth setup, follow [Symfony Gmail documentation](https://symfony.com/doc/current/mailer.html#using-gmail-to-send-emails)
+- For the SMTP method, you may need to enable "Less secure app access" or use an App Password
+
+### 2. Amazon SES
+
+To use Amazon SES:
+
+```
+# Using API credentials
+MAILER_DSN=ses://ACCESS_KEY:SECRET_KEY@default?region=REGION
+
+# Using SMTP interface
+MAILER_DSN=smtp://USERNAME:[email protected]:587
+```
+
+Notes:
+- Replace `ACCESS_KEY` and `SECRET_KEY` with your AWS credentials
+- Replace `REGION` with your AWS region (e.g., us-east-1)
+- For SMTP, use the credentials generated in the Amazon SES console
+
+### 3. Mailchimp Transactional (Mandrill)
+
+To use Mailchimp Transactional (formerly Mandrill):
+
+```
+MAILER_DSN=mandrill://API_KEY@default
+```
+
+Notes:
+- Replace `API_KEY` with your Mailchimp Transactional API key
+- You can find your API key in the Mailchimp Transactional (Mandrill) dashboard
+
+### 4. SendGrid
+
+To use SendGrid:
+
+```
+# Using API
+MAILER_DSN=sendgrid://API_KEY@default
+
+# Using SMTP
+MAILER_DSN=smtp://apikey:[email protected]:587
+```
+
+Notes:
+- Replace `API_KEY` with your SendGrid API key
+- For SMTP, the username is literally "apikey" and the password is your actual API key
+
+## Testing Your Configuration
+
+After setting up your preferred mailer transport, you can test it using the built-in test command:
+
+```bash
+bin/console app:send-test-email [email protected]
+```
+
+## Switching Between Transports
+
+You can easily switch between different mailer transports by changing the `MAILER_DSN` environment variable. This can be done in several ways:
+
+1. Edit the `config/parameters.yml` file directly
+2. Set the environment variable in your server configuration
+3. Set the environment variable before running a command:
+   ```bash
+   MAILER_DSN=sendgrid://API_KEY@default bin/console app:send-test-email [email protected]
+   ```
+
+## Additional Configuration
+
+Some transports may require additional configuration options. Refer to the Symfony documentation for more details:
+
+- [Symfony Mailer Documentation](https://symfony.com/doc/current/mailer.html)
+- [Gmail Transport](https://symfony.com/doc/current/mailer.html#using-gmail-to-send-emails)
+- [Amazon SES Transport](https://symfony.com/doc/current/mailer.html#using-amazon-ses)
+- [Mailchimp Transport](https://symfony.com/doc/current/mailer.html#using-mailchimp)
+- [SendGrid Transport](https://symfony.com/doc/current/mailer.html#using-sendgrid)