Minecraft Email Integration

Connect your Minecraft server to the Sendlix email platform with our official BungeeCord plugin. Enable players to subscribe to newsletters, receive server notifications, and stay connected with your community through automated email campaigns.

🎮 Download Plugin | 📚 GitHub Repository

Why Use Sendlix Minecraft Email Integration?

Transform your Minecraft server into a connected community platform with powerful email features:

Player Newsletter Subscriptions: Allow players to subscribe with simple in-game commands
Enterprise Email Security: Bank-grade encryption and spam protection
High-Performance Architecture: Asynchronous processing with zero server lag
Built-in Protection: Rate limiting and email validation prevent abuse
Multi-Server Support: Perfect for BungeeCord networks and server clusters
Email Analytics: Track engagement and delivery rates through Sendlix dashboard

Plugin Overview

The Sendlix Newsletter Plugin seamlessly integrates your Minecraft server with professional email marketing capabilities. Built specifically for BungeeCord networks, this plugin enables server owners to build engaged communities through automated email communication.

Core Email Features

One-Command Subscription: Players subscribe with /newsletter <email> command
Smart Email Validation: Automatic format verification and domain checking
Asynchronous Processing: Non-blocking API calls maintain server performance
Secure gRPC Communication: Enterprise-grade encryption with Sendlix backend
Multi-Language Support: Customizable success and error messages
Plugin Message API: Advanced server-to-server communication
Flexible Configuration: Complete customization through YAML config
Automatic Player Data: Minecraft username automatically added as {{mc_username}} substitution
Email Verification: Optional email validation with unique verification codes

Quick Installation Guide

System Requirements

Minecraft Server: BungeeCord 1.20+ or Velocity 3.0+
Java Version: Java 11 or higher

Minecraft Server Funding Support

For funding assistance with your Minecraft server hosting, please contact our team at info@sendlix.com. We offer special rates for gaming communities.

Step-by-Step Setup

Download Plugin: Get the latest release from GitHub Releases
- Download the .jar file from the assets section
- Verify compatibility with your BungeeCord version
Plugin Installation: Place the .jar file in your plugins/ directory
Server Restart: Restart your BungeeCord proxy server
Configuration: Edit the auto-generated plugins/Sendlix Newsletter/config.yml
API Setup: Configure your Sendlix credentials (see configuration section below)

Plugin Configuration

The plugin automatically creates a config.yml file on first startup. Here's the complete configuration guide:

# Sendlix API Configuration
apiKey: "your_sendlix_api_key_here"
groupId: "your_newsletter_group_id_here"

# Security & Performance Settings
rateLimitSeconds: 5 # Cooldown between subscription attempts

# Legal Compliance (GDPR/CAN-SPAM)
privacyPolicyUrl: "https://yourdomain.com/privacy-policy"

Add Email Verification

To enable email verification, add the following configuration to your config.yml:

# Enable email verification (default: false)
emailValidation: true

# Sender email address for verification emails
emailFrom: "noreply@yourdomain.com"

Enabling email verification ensures that new subscribers receive a verification email with a unique code. They must enter this code to complete their subscription.

When email verification is enabled, an emails folder is created in the config directory. This folder contains customizable email templates for verification emails.

The following variables are automatically replaced in the email templates:

{{code}}: The unique verification code.
{{username}}: The player's username.

Getting Your Sendlix API Credentials

Create Sendlix Account: Register at sendlix.com
Generate API Key:
- Navigate to Dashboard → API Keys
- Create new key with group.insert permission
- Copy the generated API key
Create Newsletter Group:
- Go to Dashboard → Groups
- Create new group for Minecraft newsletter subscribers
- Copy the Group ID
Update Configuration: Replace placeholder values in config.yml

Required Permissions

The API key must have group.insert permission to allow player newsletter subscriptions. Configure this in your Sendlix dashboard under API Key settings. If you are using the email verification feature, ensure the API key also has sender permission.

Player Commands & Usage

Basic Syntax:

/newsletter <email> [--agree-privacy] [--silent]

Command Parameters:

Parameter	Type	Description
`<email>`	Required	Valid email address (e.g., player@gmail.com)
`--agree-privacy`	Optional	Accept privacy policy (required if configured)
`--silent`	Optional	Hide success messages, show only errors

Usage Examples:

# Basic subscription
/newsletter john.doe@gmail.com

# With privacy policy agreement
/newsletter player@server.com --agree-privacy

# Silent mode (no success messages)
/newsletter admin@domain.com --silent

# Combined flags
/newsletter user@email.com --silent --agree-privacy

Required Permission: sendlix.newsletter.add

Automatic Player Data

When a player subscribes to the newsletter, their Minecraft username is automatically added as a substitution with the placeholder {{mc_username}}. This allows you to personalize emails with the player's in-game name.

Advanced Plugin Message API

Enable cross-server communication and advanced integrations with the Plugin Message API.

Communication Setup

Channel Name: sendlix:newsletter
Protocol: Bidirectional communication (BungeeCord ↔ Backend Servers)
Data Format: UTF-8 strings and byte arrays

Status Messages (BungeeCord → Backend Server)

When newsletter subscription status changes, BungeeCord sends automatic updates to the player's current backend server.

Message Structure:

Channel: "sendlix:newsletter"
Data: Status enum as byte array

Status Types:

Status	Description
`email_added`	✅ Email successfully subscribed to newsletter
`email_not_added`	❌ Subscription failed (validation/API error)
`email_already_exists`	⚠️ Email already subscribed to newsletter
`email_verification_sent`	📧 Verification email sent (if enabled)
`email_verification_failed`	❌ Verification failed (invalid code)

Trigger Commands (Backend Server → BungeeCord)

Backend servers can initiate newsletter subscriptions by sending plugin messages.

Message Format:

Channel: "sendlix:newsletter"
Data: Command arguments as UTF-8 string

Command Examples:

"user@example.com"
"user@example.com --agree-privacy"
"user@example.com --silent"
"user@example.com --silent --agree-privacy"

Backend Server Integration Examples

Bukkit/Spigot Plugin Integration

public class NewsletterIntegration extends JavaPlugin implements PluginMessageListener {

    @Override
    public void onEnable() {
        // Register plugin message channels
        getServer().getMessenger().registerOutgoingPluginChannel(this, "sendlix:newsletter");
        getServer().getMessenger().registerIncomingPluginChannel(this, "sendlix:newsletter", this);
    }

    // Trigger newsletter subscription from backend server
    public void subscribePlayerToNewsletter(Player player, String email, boolean silent) {
        ByteArrayDataOutput out = ByteStreams.newDataOutput();
        String command = email + " --agree-privacy";
        if (silent) command += " --silent";

        out.writeUTF(command);
        plugin.getServer().sendPluginMessage(this, "sendlix:newsletter", out.toByteArray());
    }

    // Handle status updates from BungeeCord
    @Override
    public void onPluginMessageReceived(String channel, Player player, byte[] message) {
        if (channel.equals("sendlix:newsletter")) {
            String status = new String(message, StandardCharsets.UTF_8);

            switch (status) {
               case "email_added":
                    player.sendMessage("§a✓ Successfully subscribed to newsletter!");
                    // Award achievement, update database, etc.
                    // Player's username is automatically available as {{mc_username}} in emails
                    giveNewsletterReward(player);
                    break;

                case "email_already_exists":
                    player.sendMessage("§e⚠ You're already subscribed!");
                    break;

                case "email_not_added":
                    player.sendMessage("§c✗ Subscription failed. Please try again.");
                    break;
            }
        }
    }

    private void giveNewsletterReward(Player player) {
        // Example: Give player rewards for subscribing
        player.getInventory().addItem(new ItemStack(Material.DIAMOND, 5));
        player.sendMessage("§6Thank you for subscribing! Here are 5 diamonds as a welcome gift!");
    }
}

Technical Specifications

API Integration Details

The plugin leverages modern technologies for optimal performance and security:

🔌 Protocol: gRPC over HTTP/2 for efficient communication
🔐 Authentication: Token-based API authentication with Sendlix
🛡️ Encryption: TLS/SSL encrypted connections for data security
📊 Data Format: Protocol Buffers for fast serialization
⚡ Performance: Asynchronous processing prevents server lag
👤 Player Data: Automatic Minecraft username substitution ({{mc_username}})

Email Personalization

Every player subscription automatically includes the following substitution:

Placeholder	Description	Example Value
`{{mc_username}}`	Player's Minecraft username	`Steve_2024`

This allows you to create personalized email content such as:

<h1>Hello {{mc_username}}!</h1>
<p>Thanks for playing on our server! Your recent achievements...</p>

Security Features

Rate Limiting: Configurable cooldowns prevent spam and abuse
Email Validation: Server-side format and domain verification
Secure Communication: All API calls use TLS encryption
Token Authentication: Secure API access with revocable tokens
Audit Logging: Complete subscription attempt logging for security

Contributing

The Sendlix Minecraft plugin is open source and welcomes contributions:

Source Code: GitHub Repository
License: Open source under standard terms
Pull Requests: Community contributions welcome
Feature Requests: Submit ideas via GitHub Issues

Transform your Minecraft server into a connected community platform with Sendlix email integration. Start building stronger player relationships today!

Why Use Sendlix Minecraft Email Integration?​

Plugin Overview​

Core Email Features​

Quick Installation Guide​

System Requirements​

Step-by-Step Setup​

Plugin Configuration​

Add Email Verification​

Getting Your Sendlix API Credentials​

Player Commands & Usage​

Newsletter Subscription Command​

Advanced Plugin Message API​

Communication Setup​

Status Messages (BungeeCord → Backend Server)​

Trigger Commands (Backend Server → BungeeCord)​

Backend Server Integration Examples​

Bukkit/Spigot Plugin Integration​

Technical Specifications​

API Integration Details​

Email Personalization​

Security Features​

Contributing​