Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swissup/module-email
Configure Magento 2 to send email using SMTP protocol throught Gmail, Amazon Simple Email Service (SES) and many other SMTP (Simple Mail Transfer Protocol) servers
https://github.com/swissup/module-email
gmail magento2 magento2-extension magento2-smtp mandrill ses smtp
Last synced: about 2 months ago
JSON representation
Configure Magento 2 to send email using SMTP protocol throught Gmail, Amazon Simple Email Service (SES) and many other SMTP (Simple Mail Transfer Protocol) servers
- Host: GitHub
- URL: https://github.com/swissup/module-email
- Owner: swissup
- Created: 2015-12-09T13:06:33.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-11T09:20:54.000Z (5 months ago)
- Last Synced: 2024-12-11T12:24:36.328Z (about 2 months ago)
- Topics: gmail, magento2, magento2-extension, magento2-smtp, mandrill, ses, smtp
- Language: PHP
- Homepage:
- Size: 234 KB
- Stars: 11
- Watchers: 10
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Email
Magento2 module for email providers integration.
Following email services are supported:
- Amazon SES
- Gmail
- Mandrill
- Sendmail
- Manual SMTP settings
### Installation
Run the following commands:
```bash
cd
composer require swissup/module-email
bin/magento module:enable Swissup_Email
bin/magento setup:upgrade
bin/magento setup:di:compile
```
### Usage
1. Navigate to "Marketing → Communications → Email Services"
2. Press "Add New" button
3. Create service
- Specify the Name
- Choose Type from drop-down
- Fill all required fields
- Press "Check Service" button and wait for response
- If everything works fine, press "Save" button
4. Navigate "Stores → Configurations → Advanced → System → Mail Sending Settings"
5. Select new service in the "Default Transport Email Service" drop-down
6. Save
#### Gmail Service Setup
If `Type` selects `Gmail`. Use an [App Password](https://security.google.com/settings/security/apppasswords): Generate a new App Password for your Gmail account.
[Sign in with App Passwords](https://support.google.com/accounts/answer/185833)
#### Gmail API with Google OAuth 2.0 Support Service Setup
> - [Beginning September 30, 2024, third-party apps that use only a password to access Google Accounts and Google Sync will no longer be supported.](https://workspaceupdates.googleblog.com/2023/09/winding-down-google-sync-and-less-secure-apps-support.html)
>
> - [Transition from less secure apps to OAuth](https://support.google.com/a/answer/14114704?hl=en)
If the `Type` field is set to `Gmail OAuth 2.0`, please follow the [Google instructions](https://developers.google.com/identity/openid-connect/openid-connect#registeringyourapp) to create the required credentials. In your credentials, you need to add `Authorized redirect URIs` with at least one URI, such as `https://localhost/swissup_oauth2client/google/getToken/` (replace `localhost` with your Magento store URL).
###### Customize the User Consent Screen
In the `OAuth consent screen`, you need to enable the `Gmail API` scope. . Also, add your Gmail email address as a Test User.
After setting up your credentials, enter the following fields:
- `Client ID` in `User (key)`
- `Client secret` in `Password (secure key)`
In the `Email (from)` field, enter your Gmail email address.
### Logging
1. Navigate "Stores → Configurations → Advanced → System → Mail Sending Settings"
2. "Logging Enable" set Yes
3. Navigate to "Marketing → Communications → Email Logs"
##### [Using MailHog via Docker for testing email](https://akrabat.com/using-mailhog-via-docker-for-testing-email/)
I recently needed to modify the emails that a client project sends out. It was set up to send via SMTP and so the easiest way to do this for me was to add a local MailHog instance and point the application at it.
Manually running via Docker
The quickest and easiest way to do this is via Docker.
Manually, we can do:
```
$ docker run -p 8025:8025 -p 1025:1025 mailhog/mailhog
```
This will run MailHog with the SMTP port exposed on localhost port 1025 and the web interface on 8025.
Now you can configure the app’s SMTP config and away you go.
Option | Value
----------|-------
Type | Smtp
Host | 0.0.0.0 or mailhog
Port | 1025
Auth Type | None
Secure | None