# flexi-mailer

[![codecov](https://codecov.io/github/lijukrks/flexi-mailer/graph/badge.svg?token=AOO9ICAYFH)](https://codecov.io/github/lijukrks/flexi-mailer)
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/lijukrks/flexi-mailer/badge)](https://scorecard.dev/viewer/?uri=github.com/lijukrks/flexi-mailer)
[![Maintainability](https://api.codeclimate.com/v1/badges/94b1997209c2c7f68ce0/maintainability)](https://codeclimate.com/github/lijukrks/flexi-mailer/maintainability)
[![NPM Version](https://img.shields.io/npm/v/flexi-mailer)](https://www.npmjs.com/package/flexi-mailer)
[![NPM Downloads](https://img.shields.io/npm/dy/flexi-mailer)](https://www.npmjs.com/package/flexi-mailer)
[![GitHub License](https://img.shields.io/github/license/lijukrks/flexi-mailer)](https://github.com/lijukrks/flexi-mailer/blob/main/LICENSE)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/lijukrks/flexi-mailer/issues)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/lijukrks/flexi-mailer/main.yml)](https://github.com/lijukrks/flexi-mailer/actions/workflows/main.yml)

A versatile email service supporting multiple providers, including SMTP, AWS SES, Mailgun, Postmark, and SendGrid.

## Features

- Supports multiple email providers
- Easy to configure with environment variables
- Modular and extensible design
- TypeScript support

## Installation

To install the package, use npm:

```bash
npm install flexi-mailer
```

## Usage

First, set up your environment variables for the providers you plan to use. You can do this by creating a `.env` file in your project root:

```env
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_USER=your_smtp_user
SMTP_PASS=your_smtp_pass
SMTP_FROM=no-reply@example.com

AWS_REGION=us-east-1
AWS_SOURCE_EMAIL=no-reply@example.com

MAILGUN_API_KEY=your_mailgun_api_key
MAILGUN_DOMAIN=your_mailgun_domain
MAILGUN_FROM=no-reply@example.com

POSTMARK_API_KEY=your_postmark_api_key
POSTMARK_FROM=no-reply@example.com

SENDGRID_API_KEY=your_sendgrid_api_key
SENDGRID_FROM=no-reply@example.com
```

### Example

```typescript
import { EmailService, ProviderType } from 'flexi-mailer';

// Create an instance of EmailService with the desired provider
const emailService = new EmailService(ProviderType.smtp);

// Send an email
emailService
  .sendEmail('recipient@example.com', 'Test Subject', 'Test Body')
  .then(() => console.log('Email sent successfully'))
  .catch((error) => console.error('Failed to send email:', error));
```

## Supported Providers

- **SMTP**: `ProviderType.smtp`
- **AWS SES**: `ProviderType.ses`
- **Mailgun**: `ProviderType.mailGun`
- **Postmark**: `ProviderType.postmark`
- **SendGrid**: `ProviderType.sendGrid`

## Environment Variables

### SMTP

- `SMTP_HOST`: SMTP server host.
- `SMTP_PORT`: SMTP server port.
- `SMTP_USER`: SMTP server username.
- `SMTP_PASS`: SMTP server password.
- `SMTP_FROM`: Sender email address.

### AWS SES

- `AWS_REGION`: AWS region.
- `AWS_SOURCE_EMAIL`: Source email address for sending emails.

### Mailgun

- `MAILGUN_API_KEY`: Mailgun API key.
- `MAILGUN_DOMAIN`: Mailgun domain.
- `MAILGUN_FROM`: Sender email address.

### Postmark

- `POSTMARK_API_KEY`: Postmark API key.
- `POSTMARK_FROM`: Sender email address.

### SendGrid

- `SENDGRID_API_KEY`: SendGrid API key.
- `SENDGRID_FROM`: Sender email address.

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/lijukrks/flexi-mailer/blob/main/LICENSE) file for details.

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.

## Issues

If you encounter any issues, please [open an issue](https://github.com/lijukrks/flexi-mailer/issues) on GitHub.

## Maintainers

- [Liju Kuriakose](https://github.com/lijukrks)