Getting Started
Table of Contents
Managing Role-Based Access Control (RBAC) API Keys
Welcome
Welcome to Mailgun!
Our goal is to provide developers worldwide with an accessible and straightforward way to send, receive, and track emails effortlessly.
APIs are at the heart of Mailgun. While most of the Mailgun service can be accessed through our RESTful HTTP API without the need to install any libraries, we have written libraries for a lot of the popular languages.
Features
Mailgun features can be accessed through Mailgun's Control Panel by logging in at https://app.mailgun.com/app/dashboard.
Here’s a lightweight overview of what Mailgun can do:
Email Sending
- Transactional Emails: Send automated emails like order confirmations, password resets, and notifications.
- Bulk Emails: Efficiently send large volumes of emails with optimized delivery performance.
- SMTP Integration: Seamlessly integrate Mailgun with your application via SMTP.
- Support for custom templates, mailing lists, etc.
Email Receiving
- Inbound Parsing: Parse incoming emails to your domains and route them to your application with ease.
- Route Management: Define rules for handling incoming emails, such as forwarding to a specific address or storing the email.
Email Tracking
- Open and Click Tracking: Monitor who opens your emails and clicks on links, providing insights into recipient engagement.
- Bounce Tracking: Identify and manage bounced emails to maintain a clean email list.
- Webhooks: Set up webhooks to receive real-time notifications about email events.
Analytics and Reporting
- Detailed Reports: Access comprehensive reports on email delivery, open rates, click rates, and more.
- Event Tracking: Track specific email events like deliveries, opens, clicks, and bounces for granular insights.
Security and Compliance
- DKIM and SPF: Authenticate your emails to improve deliverability and protect against spoofing.
- DMARC: Implement DMARC policies to monitor and protect your domain from email phishing and spoofing.
- Our full list of compliance certificates are available via our trust portal
Domain and IP management tools
- IP Pooling: Manage IP pools to optimize email delivery and maintain sender reputation.
- Suppression Management: Automatically handle unsubscribes, complaints, and bounces to maintain a clean email list.
- Domain management: Add US or EU based domains, as well as manage their settings and sending.
User-Friendly Control Panel
- Web Interface: Manage your email campaigns, view analytics, and configure settings through an intuitive web interface.
Please continue to read through the user manual to see all supported functionality, and if at any point in your journey you have questions or need help, please feel free to contact our Support Team here
Let's get started!
Managing Role-Based Access Control (RBAC) API Keys
Roles Based Access Control (RBAC) API Keys empower admin users to generate API keys utilizing predefined roles that dictate the access level of each key.
Note:
- Assigned roles cannot be updated. You will need to create a new key. Be sure to save the key in a safe place, as you will only be able to see it once when you create it.
- Role-Based Access Control is only available on specific plans. See our Pricing page for more details https://www.mailgun.com/pricing/
- Only Admins have read/write access. All other roles will have read access.
API Permissions
During the API key creation process, you will be able to select a predefined role. This role assigns certain access levels to various public API endpoints. Read and write privileges are based on the role assigned to the API key.
| Permission Type | Description |
|---|---|
| No Access | Will have no access to certain public API endpoints. |
| Read: | Allows the API key to access GET endpoints within the selected permission. |
| Read/Write: | Allows the API Key to access GET,PATCH,PUT,DELETE, and POST endpoints within the selected permission. |
RBAC API Key Permissions Based on Role
The assigned roles below determines the API key’s permissions (or access and rights) per public API endpoint.
| Endpoints | Admin | Analyst | Developer | Support |
|---|---|---|---|---|
| Domains | Read/Write | Read | Read/Write | Read |
| Messages | Read/Write | Read | Read/Write | Read |
| Webhooks | Read/Write | Read | Read/Write | Read |
| Events | Read/Write | Read | Read/Write | Read |
| Tags | Read/Write | Read | Read/Write | Read |
| Stats | Read/Write | Read | Read/Write | Read |
| Unsubscribes(suppressions) | Read/Write | No Access | Read/Write | Read/Write |
| Complaints (suppressions) | Read/Write | No Access | Read/Write | Read/Write |
| Bounces (suppressions) | Read/Write | No Access | Read/Write | Read/Write |
| Whitelist | Read/Write | Read | Read/Write | Read/Write |
| Routes | Read/Write | Read | Read/Write | Read |
| Mailing Lists | Read/Write | Read | Read/Write | Read/Write |
| Templates | Read/Write | Read | Read/Write | Read |
| IPs | Read/Write | Read | Read/Write | Read |
| IP Pools | Read/Write | Read | Read/Write | Read |
| Sub-Accounts | Read/Write | Read | Read/Write | Read |
| Validations | Read/Write | Read | Read/Write | Read |
| Secure Tracking | Read/Write | Read | Read/Write | Read |
| Custom Message Limits | Read/Write | Read | Read | Read |
Custom Message Limit
The Custom Message Limit imposes a hard limit on how many messages your account can send during a calendar month. The primary account holder will receive an e-mail notification when 50% and 75% of the limit has been crossed. After the limit has been reached, the account will be disabled until the beginning of the following month, or until it has been re-enabled in the dashboard or by modifying the message limit via API.
