Email Bulk Sender Plugin

A Strapi plugin that allows sending bulk email campaigns using HTML templates.

Description

Email Bulk Sender is a Strapi v5 plugin that provides functionality for mass sending personalized email messages. The plugin includes:

- Administrative interface for selecting recipients and templates
- Template system with variable support
- Bulk sending with result tracking
- Security with template path validation

Features

- 📧 Bulk email sending with rate limiting
- 🎨 HTML template support with variables
- 👥 Recipient selection from various collections
- 📊 Send result tracking
- 🔒 Secure template file handling and authentication
- 🎯 Message personalization
- ✅ Email validation
- ⚡ Configurable rate limiting

Installation

1. Ensure the plugin is located in the src/plugins/strapi-plugin-email-bulk-sender/ folder
2. The plugin is automatically loaded by Strapi on startup

Configuration

$3

Add configuration to the config/plugins.ts file:

``typescript
export default {
// ... other plugins
'strapi-plugin-email-bulk-sender': {
enabled: true,
resolve: './src/plugins/strapi-plugin-email-bulk-sender'
},
// ... other settings
}
`

$3

Ensure that an email provider is configured in Strapi. Add configuration to config/plugins.ts:

`typescript
export default {
// ... other plugins
email: {
config: {
provider: 'nodemailer', // or another provider
providerOptions: {
// provider settings
},
settings: {
defaultFrom: 'noreply@yourdomain.com',
defaultReplyTo: 'noreply@yourdomain.com',
},
},
},
// ... other settings
}
`

$3

By default, the plugin looks for templates in the templates/ folder in the project root. You can customize various settings:

`typescript
export default {
// ... other plugins
'strapi-plugin-email-bulk-sender': {
enabled: true,
resolve: './src/plugins/strapi-plugin-email-bulk-sender',
config: {
emailTemplate: {
enabled: true,
path: 'templates', // path to templates folder
rateLimitDelay: 2000 // delay between emails in milliseconds (default: 1000)
}
}
},
// ... other settings
}
`

#### Configuration Options

- enabled: Enable/disable the email template functionality (default: true)
- path: Path to the templates folder relative to project root (default: 'templates')
- rateLimitDelay: Delay between email sends in milliseconds to prevent SMTP rate limiting (default: 1000)

Usage

$3

1. Create HTML files in the templates/ folder
2. Use variables in the format {{variableName}}
3. Available variables:
- {{email}} - recipient's email
- {{name}} - recipient's name
- Any additional fields from your document data (e.g., {{company}}, {{position}}, etc.)

Example template (templates/welcome.html):

`html








Hello {{name}}!

Your email: {{email}}

Welcome to our platform!

`

$3

1. Go to the Strapi admin panel
2. Open the list of users in Content Manager
3. Select recipients from available users using checkboxes
4. The “Send email” button will appear. Click it.
5. Choose a template for sending
6. Click "Send emails"

$3

#### Get Templates List
`
GET /api/strapi-plugin-email-bulk-sender/templates
`

#### Get Template Content
`
GET /api/strapi-plugin-email-bulk-sender/templates/:templatePath
`

#### Send Bulk Emails
`
POST /api/strapi-plugin-email-bulk-sender/send-bulk-emails
`

Request body:
`json
{
"template": "welcome",
"documents": [
{
"id": 1,
"email": "user@example.com",
"name": "John Doe"
}
]
}
`

Security Features

The plugin includes several security measures:

- Authentication Required: All email sending endpoints require admin authentication
- Email Validation: All email addresses are validated before sending
- Template Path Security: Template paths are validated to prevent directory traversal attacks
- Rate Limiting: Configurable delays between emails to prevent SMTP abuse
- Input Validation: Comprehensive validation of all input parameters

Project Structure

`
src/plugins/strapi-plugin-email-bulk-sender/
├── admin/ # Administrative interface
│ ├── src/
│ │ ├── components/ # React components
│ │ ├── pages/ # Admin pages
│ │ └── utils/ # Utilities
├── server/ # Server-side
│ ├── src/
│ │ ├── controllers/ # API controllers
│ │ ├── routes/ # Routes
│ │ ├── services/ # Services
│ │ └── config/ # Configuration
├── package.json
└── README.md
`

Development

$3

`bash
npm run build
`

$3

`bash
npm run watch
`

$3

`bash
npm run test:ts:front # for admin
npm run test:ts:back # for server
``

Requirements

- Strapi v5.23.3
- Node.js 18+
- Configured email provider in Strapi

License

MIT License

Author

denisgrushkin