README

API 用于发送和跟踪邮政信件。

它包括以下关键功能：

• 创建发送，
• 添加文档和收件人，
• 选择选项，
• 跟踪生产。

要了解与此 API 相关的通知（webhooks），请参阅 notification_center API 文档。

安装 & 使用

要求

PHP 7.4 及更高版本。也应该与 PHP 8.0 兼容。

Composer

要通过 Composer 安装绑定，请将以下内容添加到 composer.json

composer require jp10/maileva-simple-sdk

入门

请按照安装过程进行操作，然后运行以下命令

Maileva\Client\Maileva 类有 3 个功能

//Retourne un objet Maileva\Client\Api\EnvoiApi
$maileva->envoi();

//Retourne un objet Maileva\Client\Api\DocumentsApi
$maileva->documents():

//Retourne un objet Maileva\Client\Api\DestinatairesApi
$maileva->destinataires();

然后只需使用每个对象的端点即可。

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

$maileva = new \Maileva\Client\Maileva(
    '<YOU-MAILEVA-LOGIN>', 
    '<YOU-MAILEVA-PASSWORD>', 
    '<YOU-MAILEVA-client_id>', 
    '<YOU-MAILEVA-client_secret>', 
    new GuzzleHttp\Client(), 
    new \Maileva\Client\Configuration()
);

//Création d'une lettre
$body = new \Maileva\Client\Model\SendingCreation(
    [
        "name" => "Résiliation d'un abonnement téléphonique",
        "custom_id" => "order_1234",
        "custom_data" => "order_1234",
        "acknowledgement_of_receipt" => true,
        "acknowledgement_of_receipt_scanning" => true,
        "color_printing" => true,
        "duplex_printing" => true,
        "optional_address_sheet" => false,
        "notification_email" => "do_not_reply@maileva.com",
        "sender_address_line_1" => "Société Durand",
        "sender_address_line_2" => "M. Pierre DUPONT",
        "sender_address_line_3" => "Batiment B",
        "sender_address_line_4" => "10 avenue Charles de Gaulle",
        "sender_address_line_5" => "",
        "sender_address_line_6" => "94673 Charenton-Le-Pont",
        "sender_country_code" => "FR",
        "archiving_duration" => 3,
        "return_envelope_reference" => 123456
    ]
); // \Maileva\Client\Model\RecipientCreation | 

try {
    $result = $maileva->envoi()->sendingsPost($body);
    echo '<pre>';
    print_r($result);
    echo '</pre>';
} catch (Exception $e) {
    echo 'Exception when calling EnvoiApi->sendingsPost: ', $e->getMessage(), PHP_EOL;
}

$sending_id = $result->getId();

//Suppression d'une lettre
try {
    $result = $apiInstance->sendingsSendingIdDelete($sending_id);
    echo '<pre>';
    print_r($result);
    echo '</pre>';
} catch (Exception $e) {
    echo 'Exception when calling EnvoiApi->sendingsSendingIdDelete: ', $e->getMessage(), PHP_EOL;
}

//Récupération de toutes les lettres
try {
    $result = $maileva->envoi()->sendingsGet();
    echo '<pre>';
    print_r($result);
    echo '</pre>';
} catch (Exception $e) {
    echo 'Exception when calling EnvoiApi->sendingsSendingIdGet: ', $e->getMessage(), PHP_EOL;

API 端点

所有 URI 都相对于 https://api.sandbox.maileva.net/mail/v2

模型

• AcceptedImport
• CountryCode
• DeliveryStatusesResponse
• DeliveryStatusesResponseDeliveryStatusesInner
• DocumentResponse
• DocumentsOverrideItem
• DocumentsResponse
• EnvelopeType
• ErrorResponse
• ErrorsResponse
• ImportRecipients
• PagingResponse
• PostageType
• Priority
• RecipientCreation
• RecipientCreationImport
• RecipientPostageClass
• RecipientResponse
• RecipientStatus
• RecipientsCounts
• RecipientsImportResponse
• RecipientsResponse
• RejectedImport
• ReturnEnvelope
• ReturnEnvelopeOutput
• SendingCreation
• SendingResponse
• SendingStatus
• SendingUpdate
• SendingsResponse
• SendingsSendingIdDocumentsPostRequestMetadata

授权

为API定义的认证方案

bearerAuth

• 类型: 带证认证 (JWT)

oAuth2PasswordProduction

• 类型: OAuth
• 流程: password
• 授权URL: ``
• 作用域:
  • all: 资源CRUD操作

oAuth2PasswordSandbox

• 类型: OAuth
• 流程: password
• 授权URL: ``
• 作用域:
  • all: 资源CRUD操作

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

关于此包

此PHP包由OpenAPI Generator项目自动生成

• API版本: 2.8
• 构建包: org.openapitools.codegen.languages.PhpClientCodegen