erwane/whep-postal

Postal webhooks handler

2.2.0 2025-08-12 21:01 UTC

Requires

• php: ^8.1
• erwane/whep-client: ^2.2

Requires (Dev)

• cakephp/cakephp-codesniffer: ^5.0
• erwane/phpunit-resource-helper: ^2.0
• phpunit/phpunit: ^10.5
• symfony/var-dumper: ^v6.0

MIT

• Erwane

• webhook
• postal

README

Webhook handler for postal emailing provider.

Usage

composer require erwane/whep-postal

use WHEP\Exception\IpException;  
use WHEP\Exception\ProviderException;  
use WHEP\Factory;

try {
    $provider = Factory::provider('postal', [
        'allowed_ip' => ['my.postal.server.ipv4', 'my:postal:server::ipv6'],
        'client_ip' => $_SERVER['REMOTE_ADDR'] ?? null, // Use method from your framework to get the ServerRequest client ip.
        'callbacks' => [
            ProviderInterface::EVENT_BLOCKED => [$this, 'callbackInvalidate'],
            ProviderInterface::EVENT_BOUNCE_QUOTA => [$this, 'callbackUnsub'],
        ],
    ]);

    // process the data.
    $provider->process($webhookData);
    
    // Data available from provider getters.
    $recipient = $provider->getRecipient();
    
    // Launch callbacks
    $provider->callback();
} catch (IpException $e) {
    // log ?
} catch (ProviderException $e) {
    // log ?
}

See WHEP Client README for options and getters methods.