{"id":15025117,"url":"https://github.com/exonos/mailapi","last_synced_at":"2026-03-01T02:01:59.737Z","repository":{"id":242454265,"uuid":"809609300","full_name":"exonos/mailapi","owner":"exonos","description":"MailAPI provides an API for email sending as a microservice","archived":false,"fork":false,"pushed_at":"2024-07-03T03:38:40.000Z","size":32,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-16T12:21:51.125Z","etag":null,"topics":["api","api-client","api-rest","exonhos","exonos","laravel","laravel-framework","laravel-package","mailapi"],"latest_commit_sha":null,"homepage":"https://x.com/abdielsoy","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/exonos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2024-06-03T05:26:59.000Z","updated_at":"2024-06-20T17:42:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"86506fcb-f1ac-40d2-9a71-1daa7059b7cf","html_url":"https://github.com/exonos/mailapi","commit_stats":null,"previous_names":["exonos/mailapi"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/exonos/mailapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exonos%2Fmailapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exonos%2Fmailapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exonos%2Fmailapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exonos%2Fmailapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/exonos","download_url":"https://codeload.github.com/exonos/mailapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exonos%2Fmailapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29958394,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T01:47:18.291Z","status":"online","status_checked_at":"2026-03-01T02:00:07.437Z","response_time":124,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","api-rest","exonhos","exonos","laravel","laravel-framework","laravel-package","mailapi"],"created_at":"2024-09-24T20:01:32.361Z","updated_at":"2026-03-01T02:01:59.707Z","avatar_url":"https://github.com/exonos.png","language":"PHP","funding_links":["https://buymeacoffee.com/exonos"],"categories":[],"sub_categories":[],"readme":"\u003ch1 style=\"max-width: 42rem; margin-bottom: 1.5rem; font-size: 2.25rem; font-weight: 800; letter-spacing: -0.025em; line-height: 1; color: #1a202c;\"\u003e\n    \u003cspan style=\"font-weight: 800;\"\u003e\n        \u003cp style=\"color: #1679af;\"\u003eMail\u003cspan style=\"color: #333333;\"\u003eAPI\u003c/span\u003e\u003c/p\u003e\n    \u003c/span\u003e\n\u003c/h1\u003e\n\n## Meet MailAPI\n\nMailAPI is a Laravel package that provides an API for email sending as a microservice, designed to efficiently handle multiple email clients without the need to repeat configurations. This tool allows businesses to centrally and seamlessly manage their transactional emails, offering a robust and scalable solution for customer communication.\n\n## Key Features:\n- Email Sending Microservice:\nMailAPI is conceived as a microservice, enabling easy integration with various applications and services, optimizing email management from a single platform.\n\n- Centralized Configuration:\nEliminates configuration redundancy by centralizing all email sending settings in one place. This simplifies administration and reduces configuration errors.\n\n- Queues and Jobs:\nImplements queues and jobs for email sending, ensuring efficient delivery of messages and optimally handling large volumes of emails.\n\n- Logging and Monitoring:\nIncludes features for logging and monitoring sent emails, allowing businesses to track the status and history of emails, as well as manage errors and exceptions.\n\n## Project setup\n\n## Install all dependencies\n```\ncomposer require exonos\\mailapi\n```\n\n### Run all migrations\n```\nphp artisan migrate\n```\n\n### To send a mail, create a client, this generates a secret that is used in the API.\n\n```\nphp artisan mail:client\n```\n\n### Send a POST request to http://{your local address}/api/v1/email with the payload\n\n```\n{\n    \"from\": \"father doe\",\n    \"to\": [\n        {\n            \"email\": \"john@doe.com\",\n            \"name\": \"John doe\"\n        }\n    ],\n    \"subject\": \"Hi from {$company}\",\n    \"text\": \"test\",\n    \"html\": \"\u003ch1\u003e{$company} is saying hi\u003c/h1\u003e\u003cp\u003etesting html with {$company}\u003c/p\u003e\",\n    \"variables\": [\n        {\n            \"email\": \"john@doe.com\",\n            \"substitutions\": [\n                {\n                    \"var\": \"company\",\n                    \"value\": \"MailAPI\"\n                }\n            ]\n        }\n    ],\n    \"attachments\" : [\n       {\n          \"filename\" : \"test.jpg\",\n          \"content\" : \"base 64 file content\"\n       }\n    ]\n}\n```\n### With Headers\n```\nsecret: {generated secret}\nAccept: application/json\n```\n\n### Note\n\n- attachments is optional\n- You can either send a text or a html not both\n- The package will take the default credentials of the Laravel application defined in the .env, make sure to configure your connection correctly.\n- if you add a variable kindly provide it's substitution, if this is not done nothing will be substituted and ignored from recipients.\n## Security Vulnerabilities\n\nIf you discover a security vulnerability in MailAPI, please help us maintain the security of this project by responsibly disclosing it to us. To report a security vulnerability, please send an email to [hh.abdiel@gmail.com](mailto:hh.abdiel@gmail.com). We'll address the issue as promptly as possible.\n\n## Credits\n\n- [Abdiel Hernandez](https://github.com/exonos)\n\n## Support My Work \n\nIf you find MailAPI helpful and would like to support my work, you can buy me a coffee. Your support will help keep this project alive and thriving. It's a small token of appreciation that goes a long way.\n\n[![Buy me a coffee](https://cdn.buymeacoffee.com/buttons/default-orange.png)](https://buymeacoffee.com/exonos)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e \u003cb\u003eMade with ❤️ from Mexico\u003c/b\u003e \u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexonos%2Fmailapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexonos%2Fmailapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexonos%2Fmailapi/lists"}