How do I send an email with attachments using Mailgun PHP?

Use the `messages()->send()` method with an array parameter that includes 'attachment' keys. The README provides basic sending examples, and detailed parameters are covered in the official Mailgun documentation for advanced use.

Mailgun PHP vs Symfony Mailer: which is better for my project?

Mailgun PHP offers direct, full access to Mailgun's API with PSR compliance, ideal for custom integrations. Symfony Mailer provides a higher-level abstraction with multi-provider support; choose Mailgun PHP for deep Mailgun-specific control.

How to handle errors and exceptions in Mailgun PHP SDK?

The SDK throws exceptions for non-200 responses by default, but exceptions are suppressed when using NoopHydrator. Always wrap API calls in try-catch blocks, as demonstrated in the subaccounts example for robust error handling.

Does Mailgun PHP work seamlessly with Laravel?

Laravel has built-in Mailgun driver support via its mail component. For more advanced use, you can integrate this SDK directly, and community packages exist for framework-specific enhancements.

How to debug API calls with Mailgun PHP?

Set the endpoint to a Postbin URL and enable debug mode using HttpClientConfigurator, as shown in the debugging section. This lets you capture and inspect raw HTTP traffic for troubleshooting.

What's the difference between US and EU servers in Mailgun PHP?

Instantiate the client with the appropriate endpoint URL: use 'https://api.mailgun.net' for US servers or 'https://api.eu.mailgun.net' for EU servers, as specified in the initial usage example to ensure regional compliance.

Open-Awesome

Mailgun

MITPHPv4.5.0

Official PHP SDK for interacting with the Mailgun email API, enabling email sending, analytics, and domain management.

Visit Website GitHub

1.1k stars315 forks0 contributors

What is Mailgun?

Mailgun PHP is the official PHP SDK for the Mailgun email service API. It provides a set of methods to send emails, manage domains, retrieve analytics, and handle subaccounts programmatically from PHP applications. It solves the problem of complex email API integration by offering a clean, object-oriented interface.

Target Audience

PHP developers building applications that require email sending, tracking, or domain management, such as web apps, e-commerce platforms, or marketing tools.

Value Proposition

Developers choose Mailgun PHP because it's the officially supported SDK, ensuring reliability and compatibility with Mailgun's API. It offers flexibility with PSR-18/PSR-7 compliance, detailed documentation, and framework integrations, reducing boilerplate code for email operations.

Overview

Mailgun's Official SDK for PHP

Use Cases

Best For

Sending transactional emails from PHP web applications
Integrating email analytics and tracking into dashboards
Managing multiple Mailgun domains or subaccounts programmatically
Building custom email marketing tools with PHP
Debugging email API calls with Postbin integration
Adding email functionality to Laravel, Symfony, or other PHP frameworks

Not Ideal For

Projects using alternative email services like SendGrid or Amazon SES, as this SDK is exclusively for Mailgun.
Teams seeking a zero-configuration SDK with a bundled HTTP client, since it requires manual setup of PSR-18/PSR-7 implementations.
Applications running on PHP versions below 7.4, due to the strict minimum version requirement.
Environments with strict dependency minimization goals, given the need for Composer and external PSR components.

Pros & Cons

Pros

PSR Standards Compliance

Adheres to PSR-18 and PSR-7, allowing integration with any compatible HTTP client and message implementation, as highlighted in the installation section for maximum flexibility.

Rich Domain Objects

Returns API responses as domain objects with getter methods, providing excellent IDE integration and easy data access without constantly referring to external documentation.

Comprehensive API Coverage

Supports all key Mailgun features including email sending, domain management, analytics, and subaccounts, making it a full-featured SDK for diverse use cases.

Debugging Tools

Includes Postbin integration for debugging API calls, enabling developers to inspect raw HTTP requests and responses, as shown in the debugging examples.

Cons

Setup Overhead

Requires manual installation of PSR-18/PSR-7 components like symfony/http-client and nyholm/psr7, adding complexity compared to SDKs with bundled defaults.

Vendor Lock-in

Tightly coupled to Mailgun's API specifics; switching to another email service would necessitate significant code changes and learning a new SDK.

Documentation Fragmentation

Critical examples and details are split between the README and external documentation sites, which can slow down onboarding and troubleshooting.

Frequently Asked Questions

Related Projects

Amazon Web Service SDK

Official repository of the AWS SDK for PHP (@awsforphp)

PHP library for the Stripe API.

Stars4,011

Forks890

Last commit17 hours ago

Github

A simple PHP GitHub API client, Object Oriented, tested and documented.

Stars2,202

Forks590

Last commit2 months ago

Twilio

A PHP library for communicating with the Twilio REST API and generating TwiML.

Stars1,633

Forks573

Last commit2 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub