swissup/module-email

Magento2 email providers integration (smtp, mandrill, amazon ses)

0.6.3 2024-09-11 09:20 UTC

Requires

• laminas/laminas-mail: ^2.9.0
• laminas/laminas-mime: ^2.5.0
• magento/framework: ^102.0.5|^103.0
• magento/module-backend: ^101.0|^102.0
• magento/module-config: ^101.1
• magento/module-email: ^101.0
• magento/module-store: ^101.0
• magento/module-ui: ^101.1
• psr/log: *
• swissup/module-oauth2-client: ^1.0.1

Requires (Dev)

• aws/aws-sdk-php-zf2: >=1.0.1
• slm/mail: ~1.5

Suggests

• aws/aws-sdk-php-zf2: If you need to use Amazon SES (composer require aws/aws-sdk-php-zf2:>=1.0.1)
• slm/mail: If you need to use Mandrill or Amazon SES (composer require slm/mail:~1.5)

OSL-3.0

• email
• smtp
• mandrill
• gmail
• sendmail
• Amazon SES

README

Magento2 module for email providers integration.

Following email services are supported:

• Amazon SES
• Gmail
• Mandrill
• Sendmail
• Manual SMTP settings

Installation

Run the following commands:

cd <magento_root>
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: Generate a new App Password for your Gmail account. Sign in with App Passwords

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.

• Transition from less secure apps to OAuth

If the Type field is set to Gmail OAuth 2.0, please follow the Google instructions 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

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.