Skip to content

DevsJony/emails-forwarder

Repository files navigation

Emails Forwarder

A small program that forwards emails from mailboxes to a Discord channel.

Features

  • Forwards emails to a specified Discord channel using webhooks.
  • Supports both received and sent emails.

Usage

  1. Create an env-config.json file in the root directory of the project.
  2. Add your IMAP account details and webhook URLs to the env-config.json file. The file should look like this:
{
  "instances": [
    {
      "mailAccount": {
        "host": "imap.example.com",
        "port": 993,
        "secure": true,
        "auth": {
          "user": "[email protected]",
          "pass": "your-email-password"
        }
      },
      "webhooks": [
        {
          "url": "https://discord.com/api/webhooks/your-webhook-id/your-webhook-token",
          "threadId": "optional-thread-id"
        }
      ]
    }
  ]
}
  1. We recommend running the program using Docker. Here is an example docker-compose.yml
name: "emails-forwarder"

services:
  emails-forwarder:
    image: ghcr.io/devsjony/emails-forwarder:master
    restart: unless-stopped
    volumes:
      - type: bind
        source: ./env-config.json
        target: /app/env-config.json

You can also run this manually using node:

For development:

pnpm run start:dev

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •