{"id":20508467,"url":"https://github.com/exbil/mailcow-php-api","last_synced_at":"2025-07-13T22:03:33.396Z","repository":{"id":198502425,"uuid":"700923484","full_name":"Exbil/mailcow-php-api","owner":"Exbil","description":"A full-featured implementation of the MailCow API","archived":false,"fork":false,"pushed_at":"2025-03-26T22:42:04.000Z","size":41,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"development","last_synced_at":"2025-05-16T01:46:38.805Z","etag":null,"topics":["api","api-client","exbil","mailcow","mailcow-api","mailcow-api-client","php","rest","rest-api"],"latest_commit_sha":null,"homepage":"https://www.exbil.net","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Exbil.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2023-10-05T14:58:21.000Z","updated_at":"2025-04-16T13:28:07.000Z","dependencies_parsed_at":"2024-10-18T19:15:08.618Z","dependency_job_id":"433386d0-ed62-47ba-8068-d877ed61ffcf","html_url":"https://github.com/Exbil/mailcow-php-api","commit_stats":null,"previous_names":["exbil/mailcow-php-api"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Exbil/mailcow-php-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exbil%2Fmailcow-php-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exbil%2Fmailcow-php-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exbil%2Fmailcow-php-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exbil%2Fmailcow-php-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Exbil","download_url":"https://codeload.github.com/Exbil/mailcow-php-api/tar.gz/refs/heads/development","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exbil%2Fmailcow-php-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265212407,"owners_count":23728529,"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":["api","api-client","exbil","mailcow","mailcow-api","mailcow-api-client","php","rest","rest-api"],"created_at":"2024-11-15T20:18:50.047Z","updated_at":"2025-07-13T22:03:33.138Z","avatar_url":"https://github.com/Exbil.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mailcow PHP API Client\r\n\r\n## Getting Started\r\n\r\n### Requirements\r\n\r\n* [**PHP 8.3+**](https://www.php.net/downloads.php)\r\n* Extensions: [Composer](https://getcomposer.org/), [PHP-JSON](https://www.php.net/manual/en/book.json.php)\r\n\r\nIn the root of your project execute the following:\r\n\r\n```sh\r\n$ composer require exbil/mailcow-php-api\r\n```\r\n\r\nor add this to your `composer.json` file:\r\n\r\n```json\r\n{\r\n    \"require\": {\r\n        \"exbil/mailcow-php-api\": \"^0.14.2\"\r\n    }\r\n}\r\n```\r\n\r\nThen perform the installation:\r\n\r\n```sh\r\n$ composer install --no-dev\r\n```\r\n\r\n## Usage\r\n\r\nSearch for the API Documentation [here](https://demo.mailcow.email/api/) or your own mailcow instance via `https://domain.com/api`.  \r\nYou need an API Key for that which can be found in an self-hosted instance within the admin dashboard.\r\n\r\n### Example\r\n\r\n```php\r\n\u003c?php\r\n// Require the autoloader\r\nrequire_once 'vendor/autoload.php';\r\n\r\n// Use the library namespace\r\nuse Exbil\\MailCowAPI;\r\n\r\n// Then simply pass your API-Token when creating the API client object.\r\n$client = new MailCowAPI('mailcow-with-https.example.com','MAILCOW_API_KEY');\r\n\r\n// Then you are able to perform a request\r\nvar_dump($client-\u003edomains()-\u003egetDomains());\r\n?\u003e\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexbil%2Fmailcow-php-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexbil%2Fmailcow-php-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexbil%2Fmailcow-php-api/lists"}