kostikpenzin/samotpravil

Samotpravil for PHP library.

0.0.1 2024-11-24 00:30 UTC

Requires

• php: >=8.0
• guzzlehttp/guzzle: ^7

Requires (Dev)

• phpstan/phpstan: ^1.9

MIT

• Penzin Konstantin

• mail
• samotpravil
• smpt

README

This library is forked by kostikpenzin/samotpravil, it helps you send e-mails through Samotpravil in PHP 8.0 and above.

Official site: Samotpravil

Full documentation REST API: documentation.samotpravil.ru

Installation

Install the library using Composer:

$ composer require kostikpenzin/samotpravil

Usage

use kostikpenzin\samotpravil\Client;

require dirname(__DIR__) . '/vendor/autoload.php';

$secretKey = 'xxxx';
$client = new Client($secretKey);

sendEmail: Sends an email using the Samotpravil API.

$res = $client->sendEmail(
    '[e-mail]',
    ''Hi, Penzin Konstantin. How are you? 😊', 
    $body,
    '[e-mail]',
    [
        'params' => [
            'name_from' => 'Penzin Konstantin'
        ]
    ]
);

getStatus: Gets the status of sent emails.

$res = $client->getStatus(['email' => '[e-mail]']);
var_dump($res);

getStatistics: Gets statistics of sent emails between specified dates.

$res = $client->getStatistics('2025-01-01', '2025-01-31', 
    ['limit' => 100, 'cursor_next' => 0]);
var_dump($res);

getNonDeliveryByDate: Retrieves non-delivery report for emails between specified dates.

$res = $client->getNonDeliveryByDate('2025-01-01', '2025-01-31', 
    ['limit' => 100, 'cursor_next' => 0]);
var_dump($res);

getFblReportByDate: Retrieves FBL report for emails between specified dates.

$res = $client->getFblReportByDate('2025-01-01', '2025-01-31', 
    ['limit' => 100, 'cursor_next' => 0]);
var_dump($res);

stopListSearch: Searches for an email in the stop list.

$res = $client->stopListSearch('[e-mail]');
var_dump($res);

stopListAdd: Adds an email to the stop list.

$res = $client->stopListAdd('[e-mail]', "samotpravil.ru");
var_dump($res);

stopListRemove: Removes an email from the stop list.

$res = $client->stopListRemove('[e-mail]', "samotpravil.ru");
var_dump($res);

getDomains: Gets a list of all domains that have been added to the list of allowed domains.

$res = $client->getDomains();
var_dump($res);

domainAdd: Adds a domain to the list of allowed domains.

$res = $client->domainAdd('samotpravil.ru');
var_dump($res);

domainRemove: Removes a domain from the list of allowed domains.

$res = $client->domainRemove('samotpravil.ru');
var_dump($res);

domainCheckVerification: Verifies the given domain using Samotpravil API.

$res = $client->domainCheckVerification('samotpravil.ru');
var_dump($res);