Skip to content

README.md

Latest commit

 

History

History
344 lines (262 loc) · 10.8 KB

README.md

File metadata and controls

344 lines (262 loc) · 10.8 KB

EmailBot

Discord Email Verify

A powerful Email Verification Bot for Discord servers

Build Status License GitHub forks GitHub stars

Report Bug · Request Feature

🌐 Website

📋 Table of Contents
  1. About
  2. Built With
  3. Usage
  4. Commands
  5. Self Hosting
  6. Contributors
  7. Support the Project

📖 About

This bot verifies that a Discord user owns an email address with a specific domain (e.g., verify name@university.edu emails). This is useful for servers that need to restrict access to verified members only, such as:

  • University/College servers - Verify students with .edu emails
  • Company servers - Verify employees with corporate emails
  • Organization servers - Verify members with organization emails

How it works:

  1. User clicks a verification button
  2. Bot sends a DM asking for their email address
  3. A verification code is sent to the email
  4. User enters the code to receive the verified role

🚀 Usage

Invite the Bot

Use this link to invite the bot to your server:

Invite Bot

Quick Setup

  1. Invite the bot using the link above
  2. Add a default role: /role add @Verified (given to all verified users)
  3. Add allowed domains: /domain add @university.edu (use @*.edu for all .edu domains)
  4. Create a verification button: /button #verification-channel "Click to Verify"
  5. Done! Users can now verify themselves

Advanced: Domain-Specific Roles

You can assign different roles based on which email domain the user verifies with:

/domainrole add domain:@staff.company.com role:@Staff
/domainrole add domain:@*.edu role:@Student

Users will receive their domain-specific roles plus any default roles you've configured.

📝 Commands

👤 User Commands

Command Description
/verify Start the email verification process
/data delete-user Delete your verification data and remove verified status

👥 Role Configuration

Command Description
/role add <role> Add a default role given to all verified users
/role remove <role> Remove a role from the default roles list
/role list View all default roles
/role unverified [role] Set or view the optional role for unverified members

🎭 Domain-Specific Roles

Assign different roles based on email domain:

Command Description
/domainrole add <domain> <role> Add a role for a specific email domain
/domainrole remove <domain> <role> Remove a role from a domain
/domainrole list View all domain-role mappings
/domainrole clear <domain> Remove all roles for a domain

💡 Example: /domainrole add @*.edu @Student gives the Student role to anyone with a .edu email

📧 Domain Management

Command Description
/domain add <domains> Add allowed email domains (supports * wildcard)
/domain remove <domains> Remove allowed domains
/domain list View all allowed domains
/domain clear Remove all allowed domains

💡 Wildcard Example: Use @*.edu to allow any .edu email address

🚫 Blacklist Management

Command Description
/blacklist add <patterns> Block email patterns (supports * wildcard)
/blacklist remove <patterns> Unblock patterns
/blacklist list View all blacklisted entries
/blacklist clear Remove all blacklist entries

💡 Wildcard Examples: *@tempmail.* blocks all tempmail domains, *spam* blocks emails containing "spam"

⚙️ Settings

Command Description
/settings language <lang> Change the bot's language
/settings log-channel [channel] Set or disable the verification log channel
/settings verify-message [message] Set or reset custom message in verification emails
/settings auto-verify <enable> Auto-prompt new members to verify on join
/settings auto-unverified <enable> Auto-assign unverified role to new members

🛡️ Moderation & Setup

Command Description
/button <channel> <buttontext> Create a verification button embed in a channel
/manualverify <user> <email> Manually verify a user without email confirmation
/set_error_notify Configure where error notifications are sent

📊 Information

Command Description
/status View bot configuration, statistics, and check for issues
/help Show setup instructions and command overview

⚠️ Data Management

Command Description
/data delete-user Delete your personal verification data
/data delete-server Delete all server data and remove the bot

⚠️ Note: Most commands require administrator permissions

Important: Role Hierarchy

The EmailBot role must be higher in the role hierarchy than the verified and unverified roles, otherwise you'll get a Can't find roles. Please contact the admin! error.

Role Hierarchy Example

🐳 Self Hosting

If you want to self-host the bot, you have two options: Docker (recommended) or Manual Installation.

💖 Enjoying the bot? If you find this project useful, please consider buying me a pizza to support ongoing development!

Docker (Recommended)

The easiest way to self-host is using Docker with the pre-built image.

1. Create a directory for the bot

mkdir emailverify && cd emailverify

2. Create the config file

mkdir config
nano config/config.json

Add your configuration:

{
  "token": "<Discord Bot Token>",
  "clientId": "<Discord Bot Client ID>",
  "email": "<Email Address>",
  "username": "<Mail Server Username>",
  "password": "<Email Password>",
  "smtpHost": "<SMTP Server>",
  "isGoogle": false
}

3. Create docker-compose.yml

version: '3'
services:
  emailverify:
    image: ghcr.io/lkaesberg/emailverify:latest
    ports:
      - 8181:8181
    volumes:
      - ./config:/usr/app/config
    restart: always

4. Start the bot

docker-compose up -d

Docker CLI Alternative

docker run -d \
  --name emailverify \
  -p 8181:8181 \
  -v $(pwd)/config:/usr/app/config \
  --restart always \
  ghcr.io/lkaesberg/emailverify:latest

Manual Installation

Requirements: Node.js v16.15.0 or higher

1. Clone the repository

git clone https://github.com/lkaesberg/EmailVerify.git
cd EmailVerify

2. Create the config file

nano config/config.json
{
  "token": "<Discord Bot Token>",
  "clientId": "<Discord Bot Client ID>",
  "email": "<Email Address>",
  "username": "<Mail Server Username>",
  "password": "<Email Password>",
  "smtpHost": "<SMTP Server>",
  "isGoogle": false
}

3. Install dependencies and start

npm install
npm start

Configuration Options

Option Description
token Your Discord Bot Token from the Discord Developer Portal
clientId Your Discord Bot's Client ID
email The email address that will send verification codes
username SMTP server username (usually your email address)
password SMTP server password or App Password
smtpHost Your SMTP server (e.g., smtp.gmail.com)
isGoogle Set to true if using Gmail
topggToken (Optional) Your Top.gg API token

💡 Gmail Users: You need to create an App Password and use that instead of your regular password.

Debugging

Type email in the console to see debugging messages for email errors.

👥 Contributors

Developer

Translators

Language Contributor
🇬🇧 English Lars Kaesberg
🇩🇪 German Lars Kaesberg
🇪🇸 Spanish gus2131
🇵🇱 Polish kploskonka
🇮🇱 Hebrew Norma1Name
🇰🇷 Korean iplayagain
🇫🇷 French Charles Van
🇹🇷 Turkish EmreSoftware

Want to add a new language?

Create an issue with your translation file using the English template as a reference.

💖 Support the Project

If you're self-hosting this bot and find it useful, please consider supporting the development! Your contribution helps keep the project maintained and improved.

Buy Me A Pizza

Made with ❤️ by Lars Kaesberg