Upgrade SDK v.2.0 [BC BREAK]

[gaalferov]

Motivation

Make a similar architecture with other libraries.
Add a layer for quick creation of email client depending on parameters
Add native support for adding a template and its variables

Changes

• [BC BREAK] PHP 7.4 will no longer be supported (PHP 8.0+) (only 2% of customers are using this version)
• • They can still use the previous version 1.*, which supports PHP 7.4.
• improve codebase to support PHP 8.0 features
• Rebuild Bridge (Laravel&Symfony) to support new architecture + more tests
• Added a short method to get the Email layer depending on config params MailtrapClient::initSendingEmails()
• Added MailtrapEmail wrapper (MIME) for easy add category, custom variables, template uuid, etc + tests
• [BC BREAK] Rebuild ALL Emails layers to use the inbox ID at the client level + tests
• [BC BREAK] Rebuild SANDBOX Projects & Messages & Attachments & Inboxes layers + tests
• [BC BREAK] Rebuild GENERAL Accounts & Permissions & Users layers + tests

How to test

composer test

OR install and run some examples from the new version of library

composer require railsware/mailtrap-php:dev-feature/v.2.0.0 symfony/http-client nyholm/psr7

<?php

use Mailtrap\Helper\ResponseHelper;
use Mailtrap\MailtrapClient;
use Mailtrap\Mime\MailtrapEmail;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;
use Symfony\Component\Mime\Header\UnstructuredHeader;

require __DIR__ . '/vendor/autoload.php';

// Mailtrap SENDING client (real)
$mailtrap = MailtrapClient::initSendingEmails(
    apiKey: getenv('MAILTRAP_API_KEY') # your API token from here https://mailtrap.io/api-tokens
);

$email = (new MailtrapEmail())
    ->from(new Address('[email protected]', 'Mailtrap Test'))
    ->to(new Address('[email protected]', 'Jon'))
    ->category('Integration Test')
    ->customVariables([
        'user_id' => '45982',
        'batch_id' => 'PSJ-12'
    ])
;

try {
    $response = $mailtrap->send($email);

    var_dump(ResponseHelper::toArray($response)); // body (array)
} catch (Exception $e) {
    echo 'Caught exception: ',  $e->getMessage(), "\n";
}

// OR -> Mailtrap BULK SENDING client (real)
try {
    $mailtrapBulkSending = MailtrapClient::initSendingEmails(
        apiKey: getenv('MAILTRAP_API_KEY'), # your API token from here https://mailtrap.io/api-tokens
        isBulk: true # Bulk sending (@see https://help.mailtrap.io/article/113-sending-streams)
    );

    $response = $mailtrapBulkSending->send($email);

    var_dump(ResponseHelper::toArray($response)); // body (array)
} catch (Exception $e) {
    echo 'Caught exception: ',  $e->getMessage(), "\n";
}

// OR -> Mailtrap Testing client (sandbox)
try {
    $mailtrapTesting = MailtrapClient::initSendingEmails(
        apiKey: getenv('MAILTRAP_API_KEY'), # your API token from here https://mailtrap.io/api-tokens
        isSandbox: true, # Sandbox sending (@see https://help.mailtrap.io/article/109-getting-started-with-mailtrap-email-testing)
        inboxId: getenv('MAILTRAP_INBOX_ID') # required param for sandbox sending
    );

    $response = $mailtrapTesting->send($email);

    var_dump(ResponseHelper::toArray($response)); // body (array)
} catch (Exception $e) {
    echo 'Caught exception: ',  $e->getMessage(), "\n";
}

[VladimirTaytor]

Looks good 👍

Integration between products is seamless right now 🎖️