📧 Email Provider Configuration Guide
Learn how to connect your email provider to enable automated emails from your system.
🔍 What is an Email Provider?
An email provider allows your system to send automated transactional emails such as:
- Invoices & receipts
- Appointment confirmations
- System notifications
- Customer communications
Once configured, emails are sent automatically without opening your email app.
⚙️ How Email Sending Works
- You select an email provider (e.g. Brevo, SendGrid)
- You enter the provider credentials
- The system securely connects to the provider
- Emails are sent automatically from your app
💡 If no provider is configured, the system will fall back to your device’s default email app.
✅ Supported Email Providers
🧩 Common Email Provider Fields
| Field | Description | Example |
|---|---|---|
| Provider | The email service you are using | brevo, sendgrid |
| API Key | Main authentication key | xkeysib-xxxxx |
| API Secret | Secondary key (if required) | xxxxxxxx |
| From Email | Email address emails are sent from | noreply@company.com |
| Domain | Required for some providers | mg.company.com |
| Region | Used by cloud providers like SES | eu-west-1 |
⬇️ Continue below for step-by-step setup for each provider
🟢 Brevo Email Provider Setup
Brevo (formerly Sendinblue) is the recommended email provider for most users due to its simple setup, reliability, and excellent deliverability.
🔍 Provider Overview
Brevo is a cloud-based email service designed for transactional and automated emails. It is well suited for:
- Invoices & receipts
- Appointment confirmations
- Password resets & notifications
- System-generated emails
🌐 Official Website: https://www.brevo.com
Step 1 — Create or Access Your Brevo Account
- Open the Brevo website:
https://www.brevo.com - Sign up for a new account or log in
- Confirm your account email address
⚠️ Emails will not be delivered until your Brevo account and sender email are verified.
Step 2 — Verify Your Sender Email
- Log in to the Brevo dashboard
- Navigate to Settings → Senders & IPs
- Add the email address you want to send emails from
- Confirm the verification email sent by Brevo
💡 Example sender email:
noreply@yourcompany.comStep 3 — Generate an API Key
- Open the Brevo dashboard
- Go to SMTP & API
- Select API Keys
- Click Create a new API key
- Copy the generated API key
🔐 Treat this API key like a password. Do not share it publicly.
Step 4 — Enter Configuration in the JSON Editor
In your system settings, open the Email Provider JSON editor and enter the following configuration:
{
"provider": "brevo",
"api_key": "xkeysib-xxxxxxxxxxxxxxxxxxxx",
"from": "noreply@yourcompany.com"
}
| Field | Required | Description |
|---|---|---|
provider |
Yes | Must be exactly brevo |
api_key |
Yes | The API key generated in your Brevo dashboard |
from |
Yes | A verified sender email address |
🧪 Testing Your Configuration
- Save the JSON configuration
- Send a test email from your app
- Check the recipient inbox (and spam folder)
✅ If successful, emails will be sent automatically without opening your email client.
❌ Common Problems & Solutions
- 401 / Unauthorized → API key is incorrect
- Email not received → Sender email not verified
- Invalid JSON → Missing quotes or commas
🔵 SendGrid Email Provider Setup
SendGrid is one of the most widely used transactional email providers for SaaS platforms and enterprise systems.
🔍 Provider Overview
SendGrid is a cloud email service owned by Twilio, designed for high-volume and reliable email delivery. It is commonly used for:
- System notifications
- Transactional emails
- Customer communications
- High-volume SaaS platforms
🌐 Official Website: https://sendgrid.com
Step 1 — Create or Access Your SendGrid Account
- Visit the SendGrid website:
https://sendgrid.com - Create an account or sign in
- Complete the initial onboarding questions
⚠️ SendGrid requires sender verification before emails can be delivered.
Step 2 — Verify Your Sender Identity
- Log in to the SendGrid dashboard
- Go to Settings → Sender Authentication
- Choose Single Sender Verification or Domain Authentication
- Follow the on-screen steps to verify
💡 Recommended for beginners:
Single Sender Verification
Single Sender Verification
Step 3 — Create an API Key
- Open the SendGrid dashboard
- Navigate to Settings → API Keys
- Click Create API Key
- Select Full Access or Restricted Access
- Copy the generated API key
🔐 This API key will only be shown once. Store it securely.
Step 4 — Enter Configuration in the JSON Editor
In your system settings, open the Email Provider JSON editor and enter the following:
{
"provider": "sendgrid",
"api_key": "SG.xxxxxxxxxxxxxxxxxxxxxxxxx",
"from": "noreply@yourcompany.com"
}
| Field | Required | Description |
|---|---|---|
provider |
Yes | Must be exactly sendgrid |
api_key |
Yes | Your SendGrid API key |
from |
Yes | A verified sender email address |
🧪 Testing Your SendGrid Configuration
- Save the JSON configuration
- Send a test email from your system
- Check inbox and spam folder
✅ If configured correctly, SendGrid will deliver emails automatically.
❌ Common Issues & Fixes
- 403 Forbidden → API key permissions are too restrictive
- Email rejected → Sender not verified
- No delivery → Check SendGrid Activity feed
🟣 Mailgun Email Provider Setup
Mailgun is a developer-focused email provider that uses domain-based sending and offers powerful delivery controls.
🔍 Provider Overview
Mailgun is designed for transactional and system emails and is commonly used by technical teams. It is ideal for:
- Developers who want full control over email delivery
- Applications sending emails from a custom domain
- Systems requiring detailed logs and diagnostics
🌐 Official Website: https://www.mailgun.com
Step 1 — Create or Access Your Mailgun Account
- Open the Mailgun website:
https://www.mailgun.com - Create an account or sign in
- Complete the onboarding process
⚠️ Mailgun requires domain verification before emails can be sent.
Step 2 — Add and Verify Your Sending Domain
- Log in to the Mailgun dashboard
- Navigate to Sending → Domains
- Click Add New Domain
- Enter your domain (e.g.
mg.yourcompany.com) - Add the DNS records provided by Mailgun to your domain
- Wait for domain verification to complete
💡 Using a subdomain (e.g.
mg.company.com) is recommended.Step 3 — Retrieve Your API Credentials
- Open the Mailgun dashboard
- Select your verified sending domain
- Go to Domain Settings → API Keys
- Copy the Private API Key
🔐 The Private API Key must be kept secret. Do not expose it publicly.
Step 4 — Enter Configuration in the JSON Editor
In your system settings, open the Email Provider JSON editor and enter the following configuration:
{
"provider": "mailgun",
"api_key": "unused",
"api_secret": "key-xxxxxxxxxxxxxxxxxxxx",
"domain": "mg.yourcompany.com",
"from": "noreply@yourcompany.com"
}
| Field | Required | Description |
|---|---|---|
provider |
Yes | Must be exactly mailgun |
api_secret |
Yes | Your Mailgun Private API Key |
domain |
Yes | Verified Mailgun sending domain |
from |
Yes | Email address under the verified domain |
🧪 Testing Your Mailgun Configuration
- Save the JSON configuration
- Send a test email
- Check Mailgun logs if delivery fails
✅ Once verified, Mailgun delivers emails reliably from your domain.
❌ Common Issues & Solutions
- Domain not verified → Check DNS records
- 401 Unauthorized → API key incorrect
- Email rejected → Sender email not under verified domain
🟠 Amazon SES Email Provider Setup
Amazon SES (Simple Email Service) is a cloud-based email service designed for high-volume, low-cost, and enterprise-grade email delivery.
🔍 Provider Overview
Amazon SES is part of Amazon Web Services (AWS) and is ideal for organisations sending large volumes of transactional email.
- Very low cost per email
- Highly reliable and scalable
- Best suited for technical or enterprise users
🌐 Official Website: https://aws.amazon.com/ses/
Step 1 — Create or Access an AWS Account
- Visit the AWS website:
https://aws.amazon.com - Create an AWS account or sign in
- Enable billing for your account
⚠️ AWS requires a valid payment method, even though SES is very inexpensive.
Step 2 — Open Amazon SES in the AWS Console
- Log in to the AWS Console
- Search for SES (Simple Email Service)
- Select the AWS region you want to use (e.g.
eu-west-1)
💡 The region you choose must be entered exactly in the JSON configuration.
Step 3 — Verify Your Sender Identity
- In SES, go to Verified identities
- Choose to verify either:
- An email address (simplest)
- A domain (recommended for production)
- Complete the verification steps
⚠️ SES will not send emails until the sender identity is verified.
Step 4 — Create AWS Access Keys
- Open the AWS Console
- Go to IAM → Users
- Create a new user with Programmatic access
- Attach a policy that allows SES sending
- Copy the Access Key ID and Secret Access Key
🔐 These keys grant access to your AWS account. Keep them secure.
Step 5 — Enter Configuration in the JSON Editor
In your system settings, open the Email Provider JSON editor and enter the following configuration:
{
"provider": "ses",
"api_key": "AKIAxxxxxxxxxxxxxxxx",
"api_secret": "xxxxxxxxxxxxxxxxxxxx",
"region": "eu-west-1",
"from": "noreply@yourcompany.com"
}
| Field | Required | Description |
|---|---|---|
provider |
Yes | Must be exactly ses |
api_key |
Yes | AWS Access Key ID |
api_secret |
Yes | AWS Secret Access Key |
region |
Yes | AWS region used for SES |
from |
Yes | Verified email or domain sender |
🧪 Testing Your SES Configuration
- Save the JSON configuration
- Send a test email
- Check AWS SES sending statistics
ℹ️ New SES accounts may start in Sandbox Mode, which restricts recipients.
❌ Common Issues & Fixes
- Sandbox mode → Request production access in SES
- Access denied → IAM policy missing SES permissions
- Email not delivered → Sender identity not verified
⚙️ Custom Email Provider (Advanced)
This option allows you to connect any email service that provides an HTTP API, even if it is not officially listed.
👤 Who Should Use a Custom Provider?
- Advanced or technical users
- Companies with an internal email gateway
- Users of regional or private email services
- Users migrating from legacy systems
⚠️ This option assumes you understand how your email provider’s API works.
🔍 How the Custom Provider Works
Internally, the system sends email by calling a backend API endpoint with the following data:
{
"from": "sender@email.com",
"to": "recipient@email.com",
"subject": "Email subject",
"message": "HTML content
",
"provider": "custom",
"api_key": "...",
"api_secret": "..."
}
When you use a custom provider, the system:
- Reads your JSON configuration
- Passes the credentials to the backend email API
- Routes the request to a custom provider handler
- Sends the email using your provider’s API
🧩 Required JSON Fields
| Field | Required | Description |
|---|---|---|
provider |
Yes | Must be set to custom |
api_key |
Usually | Main authentication key for your provider |
api_secret |
Optional | Secondary key or token (if required) |
from |
Yes | Sender email address |
📝 Example Custom Provider Configuration
{
"provider": "custom",
"api_key": "your-api-key-here",
"api_secret": "your-api-secret-here",
"from": "noreply@yourcompany.com",
"endpoint": "https://api.your-email-service.com/send"
}
💡 Additional fields (like
endpoint) can be stored here for reference or future integration.✅ When to Use a Custom Provider
- Your provider is not listed
- You are using a private/internal email API
- You want full control over delivery logic
- You plan to extend the backend later
🔁 Fallback Behaviour
If the custom provider fails or is misconfigured:
- The system will report an error
- No email will be sent
- You may optionally fall back to device email (mailto)
💡 It is recommended to test custom providers in a staging environment first.
🏁 Final Notes & Best Practices
- Always store API keys securely
- Use dedicated sender emails
- Monitor delivery logs
- Test after every configuration change