{"id":19098016,"url":"https://github.com/swissup/module-email","last_synced_at":"2025-09-25T18:54:39.114Z","repository":{"id":41281144,"uuid":"47691904","full_name":"swissup/module-email","owner":"swissup","description":"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","archived":false,"fork":false,"pushed_at":"2025-09-23T11:16:05.000Z","size":270,"stargazers_count":14,"open_issues_count":0,"forks_count":9,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-09-23T13:09:33.509Z","etag":null,"topics":["gmail","magento2","magento2-extension","magento2-smtp","mandrill","ses","smtp"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swissup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2015-12-09T13:06:33.000Z","updated_at":"2025-09-23T11:16:09.000Z","dependencies_parsed_at":"2025-05-28T13:19:03.996Z","dependency_job_id":"ba0591e4-d546-46f3-aa2d-1bddf0e842ba","html_url":"https://github.com/swissup/module-email","commit_stats":{"total_commits":200,"total_committers":10,"mean_commits":20.0,"dds":0.275,"last_synced_commit":"9836b06ea1b9a81dd9ff3aac1257ca93e7984126"},"previous_names":[],"tags_count":60,"template":false,"template_full_name":null,"purl":"pkg:github/swissup/module-email","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swissup%2Fmodule-email","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swissup%2Fmodule-email/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swissup%2Fmodule-email/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swissup%2Fmodule-email/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swissup","download_url":"https://codeload.github.com/swissup/module-email/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swissup%2Fmodule-email/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276622482,"owners_count":25675125,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-23T02:00:09.130Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gmail","magento2","magento2-extension","magento2-smtp","mandrill","ses","smtp"],"created_at":"2024-11-09T03:43:50.327Z","updated_at":"2025-09-25T18:54:39.081Z","avatar_url":"https://github.com/swissup.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Email\n\nMagento2 module for email providers integration.\n\n![example](https://user-images.githubusercontent.com/412612/40238625-6bdf426c-5abc-11e8-98ca-9b459efa3fa4.png)\n\nFollowing email services are supported:\n\n -  Gmail\n -  Manual SMTP settings\n -  Gmail OAuth 2.0\n -  Sendmail\n\n### Installation\n\nRun the following commands:\n\n```bash\ncd \u003cmagento_root\u003e\ncomposer require swissup/module-email\nbin/magento module:enable Swissup_Email\nbin/magento setup:upgrade\nbin/magento setup:di:compile\n```\n\n### Usage\n\n 1. Navigate to \"Marketing → Communications → Email Services\"\n ![example1](https://user-images.githubusercontent.com/412612/40238984-6f0b1262-5abd-11e8-89af-8de7a6a93fa7.png)\n 2. Press \"Add New\" button\n 3. Create service\n    - Specify the Name\n    - Choose Type from drop-down\n    - Fill all required fields\n    - Press \"Check Service\" button and wait for response\n    - If everything works fine, press \"Save\" button\n ![example](https://user-images.githubusercontent.com/412612/40238625-6bdf426c-5abc-11e8-98ca-9b459efa3fa4.png)\n 4. Navigate \"Stores → Configurations → Advanced → System → Mail Sending Settings\"\n 5. Select new service in the \"Default Transport Email Service\" drop-down\n ![config](https://user-images.githubusercontent.com/412612/40239232-2b0aaf5e-5abe-11e8-94c5-b96862d7ccc9.png)\n 6. Save\n\n#### Gmail Service Setup\n\nIf `Type` selects `Gmail`. Use an [App Password](https://security.google.com/settings/security/apppasswords): Generate a new App Password for your Gmail account.\n[Sign in with App Passwords](https://support.google.com/accounts/answer/185833)\n\n#### Gmail API with Google OAuth 2.0 Support Service Setup\n\u003e - [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)\n\u003e\n\u003e - [Transition from less secure apps to OAuth](https://support.google.com/a/answer/14114704?hl=en)\n\nIf 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).\n![Gmail OAuth2 Credential](https://github.com/swissup/module-email/assets/412612/47802486-2725-4642-91e2-8ff8ead58389)\n\n###### Customize the User Consent Screen\nIn the `OAuth consent screen`, you need to enable the `Gmail API` scope. ![Add Scope](https://github.com/swissup/module-email/assets/412612/84204084-a0be-4c54-8e1b-72e8c53c08e8). Also, add your Gmail email address as a Test User.\nAfter setting up your credentials, enter the following fields:\n- `Client ID` in `User (key)`\n- `Client secret` in `Password (secure key)`\n\nIn the `Email (from)` field, enter your Gmail email address.\n\n### Logging\n\n 1. Navigate \"Stores → Configurations → Advanced → System → Mail Sending Settings\"\n 2. \"Logging Enable\" set Yes\n 3. Navigate to \"Marketing → Communications → Email Logs\"\n\n\n##### [Using MailHog via Docker for testing email](https://akrabat.com/using-mailhog-via-docker-for-testing-email/) \n\nI 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.\n\nManually running via Docker\nThe quickest and easiest way to do this is via Docker.\n\nManually, we can do:\n\n```\n$ docker run -p 8025:8025 -p 1025:1025 mailhog/mailhog\n```\nThis will run MailHog with the SMTP port exposed on localhost port 1025 and the web interface on 8025.\n\nNow you can configure the app’s SMTP config and away you go.\n\nOption    | Value\n----------|-------\nType      | Smtp\nHost      | 0.0.0.0 or mailhog\nPort      | 1025\nAuth Type | None\nSecure    | None\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswissup%2Fmodule-email","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswissup%2Fmodule-email","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswissup%2Fmodule-email/lists"}