README

client for ahrdmail in php. Doesn't include auth yet.

The composer package distribution is integrated into github. To create a new version, once the code is pushed just do:

git tag v0.1.n
git push origin v0.1.n

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/swolebrain/ahrdmail-client-php.git"
    }
  ],
  "require": {
    "swolebrain/ahrdmail-client-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



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


$apiInstance = new AHRDMail\Client\Api\DefaultApi(
    // 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
);
$check_email_identity_dns_request_content = new \AHRDMail\Client\Model\CheckEmailIdentityDnsRequestContent(); // \AHRDMail\Client\Model\CheckEmailIdentityDnsRequestContent

try {
    $result = $apiInstance->checkEmailIdentityDns($check_email_identity_dns_request_content);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->checkEmailIdentityDns: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request
DefaultApi	checkEmailIdentityDns	POST /email-identity/check-dns
DefaultApi	createEmailIdentity	POST /email-identities
DefaultApi	createSubtenant	POST /subtenants
DefaultApi	deleteEmailIdentity	DELETE /email-identity
DefaultApi	listCampaignMetrics	GET /metrics/campaigns
DefaultApi	listEmailIdentities	GET /email-identities
DefaultApi	listSubtenantMetrics	GET /metrics/subtenants
DefaultApi	sendEmail	POST /email

Models

Authorization

Authentication schemes defined for the API:

smithy.api.httpApiKeyAuth

Type: API key
API key parameter name: x-api-key
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
- Generator version: 7.20.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

swolebrain/ahrdmail-client-php

包简介

关键字：

README 文档