ctsoft/laravel-letter-xpress

LetterXpress connection for Laravel.

v1.1.0 2022-03-14 19:40 UTC

Requires

• php: ^7.2|^8.0
• illuminate/config: ^7.0|^8.0|^9.0
• illuminate/contracts: ^7.0|^8.0|^9.0
• illuminate/http: ^7.0|^8.0|^9.0
• illuminate/support: ^7.0|^8.0|^9.0

MIT

• CTSoft

• laravel
• letterxpress

README

This package connects Laravel to the LetterXpress API.

Install

Install this package via Composer:

composer require ctsoft/laravel-letter-xpress

Add the following lines to your .env file and insert your own API credentials:

LETTER_XPRESS_API_USER=[username]
LETTER_XPRESS_API_KEY=[apikey]

If you want to use the sandbox add this line to your .env file:

LETTER_XPRESS_API_URL=https://sandbox.letterxpress.de/v1/

Usage

To set a new job:

use CTSoft\Laravel\LetterXpress\Facades\LetterXpress;
use CTSoft\Laravel\LetterXpress\Models\Letter;

$letter = (new Letter())
    ->setFile('document.pdf')           // Use one of this functions
    ->setDocument('PDF BINARY STRING')  // to set the document
    ->setColor(true)
    ->setDuplex(true);
...

$letter = LetterXpress::setJob($letter);
echo $letter->getJobId();
echo $letter->getPrice();
...

Notes

• Currently only set of a new job is supported
• Feel free to make a PR for additional features or ask for it via an issue

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

License

This package is open-sourced software licensed under the MIT license.