{"id":48308464,"url":"https://github.com/hmlendea/nucinotifications-api","last_synced_at":"2026-04-26T13:04:37.815Z","repository":{"id":341524023,"uuid":"1170446879","full_name":"hmlendea/nucinotifications-api","owner":"hmlendea","description":"Notification service API for sending and managing notifications.","archived":false,"fork":false,"pushed_at":"2026-04-19T13:42:14.000Z","size":54,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-04-19T15:28:47.569Z","etag":null,"topics":["api","csharp","dotnet","messaging","notifications","nuciapi","rest","rest-api","self-hosted"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hmlendea.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":null,"patreon":"hmlendea","open_collective":null,"ko_fi":"hmlendea","tidelift":null,"community_bridge":null,"liberapay":"HMlendea","issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":"hmlendea","thanks_dev":null,"custom":"https://hmlendea.go.ro/fund.html"}},"created_at":"2026-03-02T06:06:16.000Z","updated_at":"2026-04-19T13:38:52.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/hmlendea/nucinotifications-api","commit_stats":null,"previous_names":["hmlendea/nucinotifications-api"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/hmlendea/nucinotifications-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmlendea%2Fnucinotifications-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmlendea%2Fnucinotifications-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmlendea%2Fnucinotifications-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmlendea%2Fnucinotifications-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hmlendea","download_url":"https://codeload.github.com/hmlendea/nucinotifications-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmlendea%2Fnucinotifications-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32297939,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T09:34:17.070Z","status":"ssl_error","status_checked_at":"2026-04-26T09:34:00.993Z","response_time":129,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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","csharp","dotnet","messaging","notifications","nuciapi","rest","rest-api","self-hosted"],"created_at":"2026-04-05T00:12:39.147Z","updated_at":"2026-04-26T13:04:37.785Z","avatar_url":"https://github.com/hmlendea.png","language":"C#","funding_links":["https://patreon.com/hmlendea","https://ko-fi.com/hmlendea","https://liberapay.com/HMlendea","https://buymeacoffee.com/hmlendea","https://hmlendea.go.ro/fund.html"],"categories":[],"sub_categories":[],"readme":"[![Donate](https://img.shields.io/badge/-%E2%99%A5%20Donate-%23ff69b4)](https://hmlendea.go.ro/fund.html) [![Latest GitHub release](https://img.shields.io/github/v/release/hmlendea/nucinotifications-api)](https://github.com/hmlendea/nucinotifications-api/releases/latest) [![Build Status](https://github.com/hmlendea/nucinotifications-api/actions/workflows/dotnet.yml/badge.svg)](https://github.com/hmlendea/nucinotifications-api/actions/workflows/dotnet.yml)\n\n# About\n\nSmall ASP.NET Core HTTP API that sends plain-text emails via SMTP.\n\nIt’s meant to be deployed as a tiny “notifications gateway” that other apps can call, instead of giving each app direct SMTP credentials.\n\n## Features\n\n- Single endpoint: `POST /Email`\n- SMTP delivery with TLS (`EnableSsl = true`)\n- Retry on SMTP timeouts (configurable max attempts + delay)\n- Request authorization via API key\n- Optional HMAC request signing support (via `NuciSecurity.HMAC`)\n- Logging via `NuciLog`\n\n## Requirements\n\n- .NET SDK 10\n- Access to an SMTP server (host/port/username/password)\n\n## Configuration\n\nConfiguration is read from `appsettings.json` and can be overridden using standard ASP.NET Core configuration providers (environment variables, mounted secrets, etc.).\n\n### `SecuritySettings`\n\n- `ApiKey` - API key used to authorize calls to the API\n\n### `SmtpSettings`\n\n- `Host` - SMTP host\n- `Port` - SMTP port (default: 587)\n- `Username` - SMTP username (also used as the email sender)\n- `Password` - SMTP password\n- `SenderName` - Default sender name, if not specified in the request (default: Notifier)\n- `MaximumAttempts` - how many times to retry when an SMTP timeout occurs (default: 3)\n- `DelayBetweenAttemptsInSeconds` - delay between timeout retries (default: 5)\n\nExample `appsettings.json`:\n\n```json\n{\n\t\"securitySettings\": {\n\t\t\"apiKey\": \"53d77dc5-8b49-49fa-97ac-2505c01ce435\"\n\t},\n\t\"smtpSettings\": {\n\t\t\"host\": \"[[SMTP_HOST]]\",\n\t\t\"port\": 587,\n\t\t\"username\": \"[[SMTP_USERNAME]]\",\n\t\t\"password\": \"[[SMTP_PASSWORD]]\",\n        \"senderName\": \"Notifier\",\n\t\t\"maximumAttempts\": 3,\n\t\t\"delayBetweenAttemptsInSeconds\": 5\n\t}\n}\n```\n\nExample environment variable overrides:\n\n- `SecuritySettings__ApiKey`\n- `SmtpSettings__Host`\n- `SmtpSettings__Port`\n- `SmtpSettings__Username`\n- `SmtpSettings__Password`\n\n## Run locally\n\n```bash\ndotnet restore\ndotnet run\n```\n\nKestrel will listen on the default ASP.NET Core URLs for your environment.\n\n## API\n\n### `POST /Email`\n\nSends a plain-text email.\n\nRequest body:\n\n```json\n{\n    \"sender\": \"Sender User\",\n\t\"recipient\": \"user@example.com\",\n\t\"subject\": \"Hello\",\n\t\"body\": \"Test message\"\n}\n```\n\nNotes:\n\n- `sender` is optional. If it's not specified, the default one from the configuration (see `smtpSettings.senderName`) will be used instead.\n- `recipient`, `subject` and `body` are required.\n- Authorisation is enforced via an API key (see `securitySettings.apiKey`). The exact way the key (and optional HMAC token) is passed is defined by the `NuciAPI.Controllers` authorization implementation used by this project.\n\n## License\n\nGPL-3.0-only. See `LICENSE`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmlendea%2Fnucinotifications-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhmlendea%2Fnucinotifications-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmlendea%2Fnucinotifications-api/lists"}