Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 2.43 KB

README.md

File metadata and controls

87 lines (61 loc) · 2.43 KB
Logo - Strapi emailing plugin

Welcome to Strapi emailing plugin (v1.0)

A plugin for Strapi Headless CMS that provides end to end emailing feature.

Table of Contents

  1. ✨ Features
  2. ⏳ Installation
  3. 🖐 Requirements
  4. 🔧 Configuration
  5. 👨‍💻 Contributors
  6. 📝 License

✨ Features

  • Compose Emails to users: Elegant, entirely customizable and a fully extensible email sending.
  • Send Emails notfication to users: Entirely send simple notfication to your users.
  • Emails traces: Track the email if sent or not by your provider

⏳ Installation

Manual install

(Clone this repo to /src/plugins/. Learn more about how to use strapi plugins.)

cd /src/plugins/

git clone /~https://github.com/devwithmaya/strapi-plugin-emailing.git

yarn build 
or
npm run build

Via command line (Comming soon)

(Use yarn to install this plugin within your Strapi project (recommended). Install yarn with these docs.)

yarn add strapi-plugin-comments@latest

After successful installation you've to re-build your Strapi instance. To archive that simply use:

yarn build
yarn develop

or just run Strapi in the development mode with --watch-admin option:

yarn develop --watch-admin

🔧 Configuration

You can now enable and config the plugin by adding the following in ./config/plugins.ts ─────────────────────────────────────

export default {
  // ...
  'emailing': {
    enabled: true,
    resolve: './src/plugins/emailing'
  },
  // ...
}

─────────────────────────────────────

👨‍💻 Contributors

Thank you for considering contributing to this plugin The Contributors can be found below:

Othmane N. | Senior Developer

📝 License

MIT License Copyright (c) MAYA AGENCY & Strapi Solutions.