idesigning/smtpbz-client

dev-master 2024-06-25 11:58 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors

• php
• api
• sdk
• swagger

README

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.5.1
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
$config = Smtpbz\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Smtpbz\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Smtpbz\Client\Api\LogApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$messageid = "messageid_example"; // string | ID письма

try {
    $apiInstance->getMessage($messageid);
} catch (Exception $e) {
    echo 'Exception when calling LogApi->getMessage: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.smtp.bz/v1

Class	Method	HTTP request	Description
LogApi	getMessage	GET /log/message/{messageid}	Получить отправленное письмо по ID
LogApi	getMessages	GET /log/message	Получить отправленные письма
SMTPApi	smtpMass	POST /smtp/mass	Массовая отправка писем
SMTPApi	smtpSend	POST /smtp/send	Отправка письма
UnsubscribeApi	addUnsubscribe	POST /unsubscribe/add	Добавление email в список отписчиков
UnsubscribeApi	getUnsubscribe	GET /unsubscribe	Получить список отписчиков
UnsubscribeApi	removeUnsubscribe	POST /unsubscribe/remove	Удаление email-адреса из списка отписчиков
UnsubscribeApi	removeallUnsubscribe	POST /unsubscribe/removeall	Удаление всего списка отписчиков
UserApi	addDomain	POST /user/domain/add	Добавление домена отправителя
UserApi	getUserData	GET /user	Данные о пользователи
UserApi	getUserDomain	GET /user/domain/{domain}	Домен отправителя
UserApi	getUserDomains	GET /user/domain	Домены отправителя
UserApi	getUserIp	GET /user/ip/{ip}	Выделенный IP-адрес пользователя
UserApi	getUserIps	GET /user/ip	Выделенные IP-адреса пользователя
UserApi	getUserStats	GET /user/stats	Статистика по рассылкам
UserApi	verifyDomain	POST /user/domain/verify	Верификация и проверка записей домена отправителя
ValidateApi	getValidate	GET /check/email/{email}	Валидации email-адреса

Documentation For Models

Documentation For Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author