PHPackages                             pyzit/tempmail - 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 & Notifications](/categories/mail)
4. /
5. pyzit/tempmail

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

pyzit/tempmail
==============

Official PHP SDK for the Pyzit disposable email detector API

0.1.1(2mo ago)01MITPHP ^8.1CI passing

Since May 25Compare

[ Source](https://github.com/pyzit-org/temp-mail-detector-sdk-php)[ Packagist](https://packagist.org/packages/pyzit/tempmail)[ Docs](https://temp-mail-detector.pyzit.com)[ RSS](/packages/pyzit-tempmail/feed)WikiDiscussions Synced 3w ago

READMEChangelog (1)Dependencies (2)Versions (3)Used By (0)

pyzit/tempmail — PHP SDK
========================

[](#pyzittempmail--php-sdk)

Official PHP client for the [Pyzit Disposable Email Detector API](https://temp-mail-detector.pyzit.com). Detect throwaway and temporary email addresses before they reach your database.

[![PHP](https://camo.githubusercontent.com/3e41095f4ad1c6ad78f988bd1c107f87972f334143c3ba814165a03e1f43a63c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e312532422d3737374242343f6c6f676f3d706870266c6f676f436f6c6f723d7768697465)](https://php.net)[![License](https://camo.githubusercontent.com/f8df3091bbe1149f398a5369b2c39e896766f9f6efba3477c63e9b4aa940ef14/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d677265656e)](LICENSE)[![Tests](https://camo.githubusercontent.com/bd5aa488de4b578ffe7161c8f46d2c7d226c42ced91e949ae8f63a4971f909a3/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74657374732d383125323070617373696e672d627269676874677265656e)](#testing)

```
$client = new TempMailClient('YOUR_API_TOKEN');
$result = $client->check('user@mailnator.com');

if ($result->isDisposable) {
    throw new \RuntimeException('Disposable emails are not allowed.');
}
```

---

Table of Contents
-----------------

[](#table-of-contents)

- [Requirements](#requirements)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Authentication](#authentication)
- [Methods](#methods)
    - [check()](#check--free-tier)
    - [detailed()](#detailed--pro-tier)
    - [bulk()](#bulk--business-tier)
- [Response Models](#response-models)
- [Error Handling](#error-handling)
- [Framework Integration](#framework-integration)
- [Configuration](#configuration)
- [Testing](#testing)
- [Project Structure](#project-structure)

---

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

[](#requirements)

RequirementVersionPHP≥ 8.1ext-curlanyext-jsonanyNo other runtime dependencies.

---

Installation
------------

[](#installation)

```
composer require pyzit/tempmail
```

---

Quick Start
-----------

[](#quick-start)

```