Download the PHP package maileroo/maileroo-php-sdk without Composer

Maileroo PHP SDK

Maileroo is a robust email delivery platform designed for effortless sending of transactional and marketing emails. This PHP SDK offers a straightforward interface for working with the Maileroo API, supporting basic email formats, templates, bulk sending, and scheduling capabilities.

Features

• Send basic HTML or plain text emails with ease
• Use pre-defined templates with dynamic data
• Send up to 500 personalized emails in bulk
• Schedule emails for future delivery
• Manage scheduled emails (list & delete)
• Add tags, custom headers, and reference IDs
• Attach files to your emails
• Support for multiple recipients, CC, BCC, and Reply-To
• Enable or disable open and click tracking
• Built-in input validation and error handling

Requirements

• PHP 7.0 or higher
• cURL extension (ext-curl)
• JSON extension (ext-json)

Installation

Install via Composer:

Quick Start

Usage Examples

1. Basic Email with Attachments

2. Template Email

3. Bulk Email Sending (With Plain and HTML)

4. Bulk Email Sending (With Template ID)

5. Working with Attachments

6. Scheduling Emails

You can schedule emails for future delivery by adding a scheduled_at field with an RFC 3339 formatted datetime string.

7. Managing Scheduled Emails

8. Deleting Scheduled Email

API Reference

MailerooClient

Constructor

Methods

• sendBasicEmail(array $data): string - Send a basic email, returns reference ID
• sendTemplatedEmail(array $data): string - Send a template email, returns reference ID
• sendBulkEmails(array $data): array - Send bulk emails, returns result data
• deleteScheduledEmail(string $reference_id): void - Cancel a scheduled email
• getScheduledEmails(int $page = 1, int $per_page = 10): array - Get scheduled emails
• getReferenceId(): string - Generate a unique reference ID

EmailAddress

• getAddress(): string
• getDisplayName(): ?string
• toArray(): array

Attachment

Static factory methods:

• Attachment::fromFile(string $path, ?string $content_type = null, bool $inline = false)
• Attachment::fromContent(string $file_name, string $content, ?string $content_type = null, bool $inline = false, bool $is_base64 = false)
• Attachment::fromStream(string $file_name, resource $stream, ?string $content_type = null, bool $inline = false)

Error Handling

The SDK throws exceptions for various error conditions:

Documentation

For detailed API documentation, including all available endpoints, parameters, and response formats, please refer to the Maileroo API Documentation.

License

This SDK is released under the MIT License.

Support

Please visit our support page for any issues or questions regarding Maileroo. If you find any bugs or have feature requests, feel free to open an issue on our GitHub repository.