{"id":24440085,"url":"https://github.com/interserver/mailbaby-client-php","last_synced_at":"2025-07-25T17:38:58.981Z","repository":{"id":45194555,"uuid":"362552757","full_name":"interserver/mailbaby-client-php","owner":"interserver","description":"MailBaby API PHP Client","archived":false,"fork":false,"pushed_at":"2024-02-26T17:58:28.000Z","size":209,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-21T10:03:29.076Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/interserver.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-28T17:24:58.000Z","updated_at":"2022-01-01T23:21:14.000Z","dependencies_parsed_at":"2024-02-26T19:09:36.226Z","dependency_job_id":null,"html_url":"https://github.com/interserver/mailbaby-client-php","commit_stats":{"total_commits":26,"total_committers":2,"mean_commits":13.0,"dds":"0.038461538461538436","last_synced_commit":"0df004b07e41843fef392234a1d9e71685a459e1"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interserver%2Fmailbaby-client-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interserver%2Fmailbaby-client-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interserver%2Fmailbaby-client-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/interserver%2Fmailbaby-client-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/interserver","download_url":"https://codeload.github.com/interserver/mailbaby-client-php/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243505959,"owners_count":20301618,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-20T20:28:14.122Z","updated_at":"2025-03-14T01:12:49.199Z","avatar_url":"https://github.com/interserver.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MailBaby\n\n**Send emails fast and with confidence through our easy to use [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) API interface.**\n# Overview\nThis is the API interface to the [Mail Baby](https//mail.baby/) Mail services provided by [InterServer](https://www.interserver.net). To use this service you must have an account with us at [my.interserver.net](https://my.interserver.net).\n# Authentication\nIn order to use most of the API calls you must pass credentials from the [my.interserver.net](https://my.interserver.net/) site.\nWe support several different authentication methods but the preferred method is to use the **API Key** which you can get from the [Account Security](https://my.interserver.net/account_security) page.\n\n\nFor more information, please visit [https://www.mail.baby/contact/](https://www.mail.baby/contact/).\n\n## Installation \u0026 Usage\n\n### Requirements\n\nPHP 7.4 and later.\nShould also work with PHP 8.0.\n\n### Composer\n\nTo install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:\n\n```json\n{\n  \"repositories\": [\n    {\n      \"type\": \"vcs\",\n      \"url\": \"https://github.com/interserver/mailbaby-client-php.git\"\n    }\n  ],\n  \"require\": {\n    \"interserver/mailbaby-client-php\": \"*@dev\"\n  }\n}\n```\n\nThen run `composer install`\n\n### Manual Installation\n\nDownload the files and include `autoload.php`:\n\n```php\n\u003c?php\nrequire_once('/path/to/MailBaby/vendor/autoload.php');\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```php\n\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n\n\n// Configure API key authorization: apiKeyAuth\n$config = Interserver\\Mailbaby\\Configuration::getDefaultConfiguration()-\u003esetApiKey('X-API-KEY', 'YOUR_API_KEY');\n// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n// $config = Interserver\\Mailbaby\\Configuration::getDefaultConfiguration()-\u003esetApiKeyPrefix('X-API-KEY', 'Bearer');\n\n\n$apiInstance = new Interserver\\Mailbaby\\Api\\BlockingApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n$type = 'type_example'; // string | The type of deny rule.\n$data = 'data_example'; // string | The content of the rule.  If a domain type rule then an example would be google.com. For a begins with type an example would be msgid-.  For the email typer an example would be user@server.com.\n$user = 'user_example'; // string | Mail account username that will be tied to this rule.  If not specified the first active mail order will be used.\n\ntry {\n    $result = $apiInstance-\u003eaddRule($type, $data, $user);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling BlockingApi-\u003eaddRule: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n```\n\n## API Endpoints\n\nAll URIs are relative to *https://api.mailbaby.net*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BlockingApi* | [**addRule**](docs/Api/BlockingApi.md#addrule) | **POST** /mail/rules | Creates a new email deny rule.\n*BlockingApi* | [**deleteRule**](docs/Api/BlockingApi.md#deleterule) | **DELETE** /mail/rules/{ruleId} | Removes an deny mail rule.\n*BlockingApi* | [**delistBlock**](docs/Api/BlockingApi.md#delistblock) | **POST** /mail/blocks/delete | Removes an email address from the blocked list\n*BlockingApi* | [**getMailBlocks**](docs/Api/BlockingApi.md#getmailblocks) | **GET** /mail/blocks | displays a list of blocked email addresses\n*BlockingApi* | [**getRules**](docs/Api/BlockingApi.md#getrules) | **GET** /mail/rules | Displays a listing of deny email rules.\n*HistoryApi* | [**getStats**](docs/Api/HistoryApi.md#getstats) | **GET** /mail/stats | displays a list of blocked email addresses\n*HistoryApi* | [**viewMailLog**](docs/Api/HistoryApi.md#viewmaillog) | **GET** /mail/log | displays the mail log\n*SendingApi* | [**sendAdvMail**](docs/Api/SendingApi.md#sendadvmail) | **POST** /mail/advsend | Sends an Email with Advanced Options\n*SendingApi* | [**sendMail**](docs/Api/SendingApi.md#sendmail) | **POST** /mail/send | Sends an Email\n*ServicesApi* | [**getMailOrders**](docs/Api/ServicesApi.md#getmailorders) | **GET** /mail | displays a list of mail service orders\n*StatusApi* | [**pingServer**](docs/Api/StatusApi.md#pingserver) | **GET** /ping | Checks if the server is running\n\n## Models\n\n- [DenyRuleNew](docs/Model/DenyRuleNew.md)\n- [DenyRuleRecord](docs/Model/DenyRuleRecord.md)\n- [DenyRuleRecordAllOf](docs/Model/DenyRuleRecordAllOf.md)\n- [EmailAddress](docs/Model/EmailAddress.md)\n- [GenericResponse](docs/Model/GenericResponse.md)\n- [GetMailOrders401Response](docs/Model/GetMailOrders401Response.md)\n- [GetStats200ResponseInner](docs/Model/GetStats200ResponseInner.md)\n- [MailBlockClickHouse](docs/Model/MailBlockClickHouse.md)\n- [MailBlockRspamd](docs/Model/MailBlockRspamd.md)\n- [MailBlocks](docs/Model/MailBlocks.md)\n- [MailLog](docs/Model/MailLog.md)\n- [MailLogEntry](docs/Model/MailLogEntry.md)\n- [MailOrder](docs/Model/MailOrder.md)\n- [SendMail](docs/Model/SendMail.md)\n- [SendMailAdv](docs/Model/SendMailAdv.md)\n\n## Authorization\n\nAuthentication schemes defined for the API:\n### apiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: X-API-KEY\n- **Location**: HTTP header\n\n\n## Tests\n\nTo run the tests, use:\n\n```bash\ncomposer install\nvendor/bin/phpunit\n```\n\n## Author\n\nsupport@interserver.net\n\n## About this package\n\nThis PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: `1.1.0`\n    - Package version: `1.0.0`\n- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterserver%2Fmailbaby-client-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finterserver%2Fmailbaby-client-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finterserver%2Fmailbaby-client-php/lists"}