PHPackages                             artisan-build/sink-client - 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. [Testing & Quality](/categories/testing)
4. /
5. artisan-build/sink-client

ActiveLibrary[Testing & Quality](/categories/testing)

artisan-build/sink-client
=========================

The capture transport side of Sink. Installed in Laravel apps whose outbound mail should be captured by a Sink server.

v0.1.0(yesterday)00MITPHPPHP ^8.3

Since Aug 24Pushed yesterdayCompare

[ Source](https://github.com/artisan-build/sink-client)[ Packagist](https://packagist.org/packages/artisan-build/sink-client)[ RSS](/packages/artisan-build-sink-client/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (12)Versions (2)Used By (0)

sink-client
===========

[](#sink-client)

> **Read-only mirror.** This repository is a read-only split of the [`artisan-build/sink`](https://github.com/artisan-build/sink) monorepo. Issues and pull requests are disabled here — please open them on the monorepo.

The **send side** of Sink. It provides the Laravel `sink` mail transport that captures outbound messages and posts them to a self-hosted Sink server instead of delivering them anywhere.

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

[](#installation)

```
composer require artisan-build/sink-client
```

Then configure the Sink server URL and token:

```
php artisan sink:install --url=https://sink.example.test --token=your-token
```

Enable capture explicitly in the host app:

```
MAIL_MAILER=sink
SINK_URL=https://sink.example.test
SINK_TOKEN=your-token
```

Installing the package alone does not change your default mailer. Sink only captures mail when the application selects `MAIL_MAILER=sink`.

Configuration
-------------

[](#configuration)

Publish the config if you need to tune retries, timeout, stream tagging, or message size limits:

```
php artisan vendor:publish --tag=sink-client-config
```

Available environment values:

- `SINK_URL`: Sink server base URL.
- `SINK_TOKEN`: Sink ingest token.
- `SINK_STREAM`: optional stream label for future per-run isolation.
- `SINK_RETRY_ATTEMPTS`: HTTP attempts before the send fails visibly. Default `3`.
- `SINK_RETRY_BASE_MS`: exponential backoff base in milliseconds. Default `200`.
- `SINK_TIMEOUT`: per-attempt HTTP timeout in seconds. Default `15`.
- `SINK_MAX_MESSAGE_BYTES`: raw MIME size ceiling before attachments are dropped or headers-only capture is used. Default `10485760`.

Production Fuse
---------------

[](#production-fuse)

Sink refuses to construct the transport in `production` unless you explicitly set:

```
SINK_ALLOW_PRODUCTION=true
```

This prevents production mail from being silently swallowed. If Sink cannot capture a selected message after retries are exhausted, the send throws so queued mail jobs fail visibly.

Compatibility
-------------

[](#compatibility)

Check server/client envelope compatibility with:

```
php artisan sink:update
```

If your Sink server does not expose `/capabilities` yet, the command reports that gracefully.

License
-------

[](#license)

MIT. See [LICENSE](LICENSE).

###  Health Score

38

—

LowBetter than 83% of packages

Maintenance100

Actively maintained with recent releases

Popularity0

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity38

Early-stage or recently created project

 Bus Factor1

Top contributor holds 83.3% 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

Unknown

Total

1

Last Release

1d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1053395?v=4)[Ed Grosvenor](/maintainers/edgrosvenor)[@edgrosvenor](https://github.com/edgrosvenor)

---

Top Contributors

[![edgrosvenor](https://avatars.githubusercontent.com/u/1053395?v=4)](https://github.com/edgrosvenor "edgrosvenor (5 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (1 commits)")

---

Tags

testinglaravelmailsink

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/artisan-build-sink-client/health.svg)

```
[![Health](https://phpackages.com/badges/artisan-build-sink-client/health.svg)](https://phpackages.com/packages/artisan-build-sink-client)
```

###  Alternatives

[laravel/framework

The Laravel Framework.

34.9k556.2M21.6k](/packages/laravel-framework)[psalm/plugin-laravel

Psalm plugin for Laravel

3345.4M354](/packages/psalm-plugin-laravel)[laravel/ai

The official AI SDK for Laravel.

1.1k4.6M341](/packages/laravel-ai)[laravel/mcp

Rapidly build MCP servers for your Laravel applications.

80427.1M249](/packages/laravel-mcp)[laravel/reverb

Laravel Reverb provides a real-time WebSocket communication backend for Laravel applications.

1.6k17.8M121](/packages/laravel-reverb)[api-platform/laravel

API Platform support for Laravel

58190.1k21](/packages/api-platform-laravel)

PHPackages © 2026

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