Download the PHP package postalsys/emailengine-php without Composer

On this page you can find all versions of the php package postalsys/emailengine-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of postalsys/emailengine-php

Informations about the package emailengine-php

EmailEngine PHP SDK

Tests PHP Version

Modern PHP SDK for EmailEngine - the self-hosted email gateway that provides a REST API for IMAP and SMTP operations.

Requirements

Installation

Quick Start

Configuration

Constructor Parameters

Factory Method (Legacy Compatibility)

Resources

The SDK provides access to all EmailEngine API endpoints through resource classes:

Resource Description
$client->accounts Account management (CRUD, sync, reconnect)
$client->messages Message operations (list, read, send, search)
$client->mailboxes Mailbox management (create, rename, delete)
$client->outbox Queued message management
$client->settings System and webhook settings
$client->tokens Access token management
$client->templates Email template management
$client->gateways SMTP gateway configuration
$client->oauth2 OAuth2 application management
$client->webhooks Webhook route management
$client->stats System statistics and utilities
$client->blocklists Blocklist management

Examples

Account Management

Messages

Sending Emails

Download Attachments

Mailbox Management

Webhook Settings

Hosted Authentication

Generate URLs for EmailEngine's hosted authentication form. This method calls the EmailEngine API to generate a secure authentication URL with server-side nonce and timestamp for replay attack protection.

Available Parameters

Parameter Type Description
account string|null Account ID (null to auto-generate)
name string Display name for the account
email string Email address hint
redirectUrl string Override default redirect URL
type string Account type (e.g., 'imap', 'gmail', 'outlook')
delegated bool Enable delegated access
syncFrom string ISO 8601 date to sync messages from
notifyFrom string ISO 8601 date to send notifications from
subconnections array List of shared mailboxes to connect
path string|array Mailbox path(s) to monitor

Webhook Signature Verification

Verify webhook signatures to ensure requests are authentically from EmailEngine. Requires the serviceSecret to be configured.

Outbox Management

System Statistics

Error Handling

The SDK throws specific exceptions for different error types:

Raw API Requests

For endpoints not covered by resource classes:

Testing

Local Testing

Docker Testing

Test across multiple PHP versions using Docker:

Integration Testing

Integration tests run against a real EmailEngine instance:

Note: EmailEngine without a license suspends workers after 15 minutes. Integration tests are designed to complete within this time window. If you need more time, restart EmailEngine:

Manual Integration Testing

To run integration tests against your own EmailEngine instance:

Legacy Compatibility

The SDK maintains backward compatibility with the old API:

License

MIT License - see LICENSE file.

Links

All versions of emailengine-php with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
guzzlehttp/guzzle Version ^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package postalsys/emailengine-php contains the following files

Loading the files please wait ...