usgm / sdk

v1.0.4 2026-07-17 05:38 UTC

Requires

• php: ^8.1
• ext-json: *
• guzzlehttp/guzzle: ^7.4

Requires (Dev)

• friendsofphp/php-cs-fixer: 3.5.0
• phpstan/phpstan: ^1.12
• phpunit/phpunit: ^9.0

MIT

• api
• sdk
• usglobalmail

Published on Packagist.org on 2026-07-17 05:38 UTC

README

The official PHP SDK for the US Global Mail API — manage your virtual mailbox, scans, shipments, folders, addresses, and account programmatically.

Requirements

PHP 8.1+

Installation

composer require usgm/sdk

Usage

<?php

use Usgm\UsglobalmailClient;

$client = new UsglobalmailClient($token);

// List mail in your mailbox
$mail = $client->mails->list();

The client exposes a sub-client per resource: $mails, $scans, $shipments, $folders, $addresses, $bankAccounts, $account, and $sandbox.

Authentication

Pass your API key as the $token constructor argument. Treat it like a password — keep it out of source control. See the documentation for details.

Documentation

• Guides: https://docs.usglobalmail.com
• API reference: https://docs.usglobalmail.com/api

License

MIT