PHPackages                             filippo-toso/preview-my-email - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail &amp; Notifications](/categories/mail)
4. /
5. filippo-toso/preview-my-email

ActiveLibrary[Mail &amp; Notifications](/categories/mail)

filippo-toso/preview-my-email
=============================

PreviewMyEmail.com Email Design Test API

v1.0.7(8y ago)023MITPHPPHP ^5.6 || ^7.0

Since Aug 2Pushed 8y agoCompare

[ Source](https://github.com/filippotoso/preview-my-email)[ Packagist](https://packagist.org/packages/filippo-toso/preview-my-email)[ RSS](/packages/filippo-toso-preview-my-email/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependencies (1)Versions (9)Used By (0)

PreviewMyEmail API Client
=========================

[](#previewmyemail-api-client)

A simple client for previewmyemail.com API.

Requirements
------------

[](#requirements)

- PHP 5.6+
- guzzlehttp/guzzle 6.2+

Installing
----------

[](#installing)

Use Composer to install it:

```
composer require filippo-toso/composer require filippo-toso/preview-my-email

```

Using It
--------

[](#using-it)

Create the client

```
use FilippoToso\PreviewMyEmail\Client as PreviewMyEmail;

$client = new PreviewMyEmail('apikey');

```

Returns the list of email clients available for email design testing

```
$clients = $client->retrieveEmailClients();

```

Returns the list of email design test requests you have done so far. Please note: we are wiping design tests every six months.

```
$previews = $client->getPreviewList();

```

Returns the current status of email design test servers.

```
$status = $client->systemStatus();

```

This public API command will get your email content and take a small thumbnail screen shot of it. Useful for displaying a small thumbnail next your email campaigns. This API command will return a request ID. You can query this request ID with `GetThumbnail` API command in a few minutes to retrieve the URL of your email screen shot thumbnail.

```
$contentType = 'TEXT';
$content = 'Hello World!';
$request = $client->newThumbnail($contentType, $content)

```

This public API command will return the URL of the generated thumbnail. If it’s not ready yet, it will return an error.

```
$thumbnail = $client->getThumbnail($requestId);
$requestId = '20170810092854d834ebfe9af9dcac1eb781e668f295a6';

```

Returns the list of inbox monitor tests you have made so far.

```
$results = $client->getInboxMonitoringResults();

```

Creates a new email design test request. Please note: creating design test for all email applications on PreviewMyEmail, may delay API response to 1 minute, so keep your timings right.

```
$tag = 'filippo-toso-2';
$code = $client->createEmailAnalyticsCode($tag);

```

This API command returns total numbers such as opens, unique opens, forwards, prints, etc.

```
$tag = 'filippo-toso-2';
$statistics = $client->getEmailAnalyticsCounts($tag);

```

This API command returns “most hit” email applications/clients detected in your tag.

```
$tag = 'filippo-toso-2';
$topClients = $client->getEmailAnalyticsTopClients($tag);

```

This API command returns top geo-locations detected in your tag.

```
$tag = 'filippo-toso-2';
$topLocations = $client->getEmailAnalyticsTopLocations($tag);

```

This API command will return the list of email “open”, “print” and “forward” activities, that happened during some specific time. Maximum amount of returned entries is 150. If you wish to retrieve all records you will have to use time parser and retrieve 150 entries with every parsed-time request.

```
$tag = 'filippo-toso-2';
$feed = $client->getEmailAnalyticsFeed($tag);

```

Creates a new email design test request. Please note: creating design test for all email applications on PreviewMyEmail, may delay API response to 1 minute, so keep your timings right.

```
$emailBody = 'Hello World!';
$emailSubject = 'Hello World!';
$targetEmailApps = [74];
$preview = $client->createPreview($emailBody, $emailSubject, $targetEmailApps);

```

Get a preview job.

```
$jobId = 1718271789;
$job = $client->fetchPreview($jobId);

```

Runs the email design test again for the target email application. Please note: you cannot execute this command on target mail apps, that were not included when you created a design test.

```
$jobId = 1718267428;
$clientCode = 74;
$result = $client->retryEmailClient($jobId, $clientCode);

```

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~3 days

Total

8

Last Release

3235d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/55d89f2d44fb12225de2119994028ee69e36770bcf33c2b1ddf0d6672d28151b?d=identicon)[filippo.toso](/maintainers/filippo.toso)

---

Top Contributors

[![filippotoso](https://avatars.githubusercontent.com/u/26958813?v=4)](https://github.com/filippotoso "filippotoso (8 commits)")

### Embed Badge

![Health badge](/badges/filippo-toso-preview-my-email/health.svg)

```
[![Health](https://phpackages.com/badges/filippo-toso-preview-my-email/health.svg)](https://phpackages.com/packages/filippo-toso-preview-my-email)
```

###  Alternatives

[aws/aws-sdk-php

AWS SDK for PHP - Use Amazon Web Services in your PHP project

6.2k532.1M2.5k](/packages/aws-aws-sdk-php)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k656.1k34](/packages/neuron-core-neuron-ai)[craftcms/cms

Craft CMS

3.6k3.6M2.9k](/packages/craftcms-cms)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3741.3M46](/packages/tencentcloud-tencentcloud-sdk-php)[tempest/framework

The PHP framework that gets out of your way.

2.2k31.1k12](/packages/tempest-framework)[guanguans/notify

Push notification SDK(AnPush、Bark、Chanify、DingTalk、Discord、Gitter、GoogleChat、IGot、Lark、Mattermost、MicrosoftTeams、NotifyX、NowPush、Ntfy、Push、Pushback、PushBullet、PushDeer、PushMe、Pushover、PushPlus、QQ、RocketChat、ServerChan、ShowdocPush、SimplePush、Slack、Telegram、WeWork、WPush、XiZhi、YiFengChuanHua、ZohoCliq、ZohoCliqWebHook、Zulip).

686111.2k8](/packages/guanguans-notify)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
