{"id":15813629,"url":"https://github.com/skn0tt/railmail","last_synced_at":"2025-04-01T01:44:12.427Z","repository":{"id":38843924,"uuid":"141245244","full_name":"Skn0tt/RailMail","owner":"Skn0tt","description":"A Reactive Mail dispatcher written in F#.","archived":false,"fork":false,"pushed_at":"2023-12-15T14:32:11.000Z","size":75,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-06T04:03:25.256Z","etag":null,"topics":["amqp","fsharp","mail","rabbitmq","reactive"],"latest_commit_sha":null,"homepage":null,"language":"F#","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/Skn0tt.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":"2018-07-17T06:57:50.000Z","updated_at":"2021-11-16T19:27:21.000Z","dependencies_parsed_at":"2024-10-26T09:46:23.161Z","dependency_job_id":"ef928098-6b6e-4fb0-ab49-6fe8ab7279dc","html_url":"https://github.com/Skn0tt/RailMail","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skn0tt%2FRailMail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skn0tt%2FRailMail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skn0tt%2FRailMail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skn0tt%2FRailMail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Skn0tt","download_url":"https://codeload.github.com/Skn0tt/RailMail/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246569006,"owners_count":20798341,"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":["amqp","fsharp","mail","rabbitmq","reactive"],"created_at":"2024-10-05T04:03:41.954Z","updated_at":"2025-04-01T01:44:12.410Z","avatar_url":"https://github.com/Skn0tt.png","language":"F#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RailMail\n\n\u003e Etymology: (*Reactive Mail* -\u003e Rail) + Mail, just for the rhymes.\n\nRailMail is a Reactive Mail dispatcher written in F#.\nIt takes Mail requests from AMQP/RabbitMQ and a REST API.\nDispatch happens over SMTP.\n\n- [Blog Post](https://simonknott.de/articles/fsharp-railmail)\n\n## API\n\nEnvelope information is transmitted in the following JSON format:\n\n```json\n{\n  \"recipients\": \"test@test.com\",\n  \"subject\": \"Funky Mail Dispatcher!\",\n  \"body\": {\n    \"text\": \"Hey Flo, I found that great service called RailMail! Check it out!\",\n    \"html\": \"Hey \u003cb\u003eFlo\u003c/b\u003e, ... \"\n  }\n}\n```\nThis JSON is sent either to the specified AMQP Queue or POSTed to the REST Endpoint \"/mail\".\n\n```sh\ncurl \\\n  -X POST \\\n  --data '{ \"recipient\": ... }' \\\n  http://railmail:5000/mail\n```\n\n## Configuration\n\n| Env           | Default         | Needed |\n| ------------- | --------------- | ------ |\n| SMTP_HOST     |                 | x      |\n| SMTP_PORT     | 587             |        |\n| SMTP_USERNAME |                 | x      |\n| SMTP_PASSWORD |                 | x      |\n| SMTP_SENDER   |                 | x      |\n| AMQP_HOST     |                 | x      |\n| AMQP_PORT     | 5672            |        |\n| AMQP_USERNAME |                 | x      |\n| AMQP_PASSWORD |                 | x      |\n| AMQP_QUEUE    | RAILMAIL_INGEST |        |\n\nRailmail's standard port is `5000`.\n\n\n## Build and test the application\n\n### Windows\n\nRun the `build.bat` script in order to restore, build and test (if you've selected to include tests) the application:\n\n```\n\u003e ./build.bat\n```\n\n### Linux/macOS\n\nRun the `build.sh` script in order to restore, build and test (if you've selected to include tests) the application:\n\n```\n$ ./build.sh\n```\n\n## Run the application\n\nAfter a successful build you can start the web application by executing the following command in your terminal:\n\n```\ndotnet run src/RailMail\n```\n\nAfter the application has started visit [http://localhost:5000](http://localhost:5000) in your preferred browser.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskn0tt%2Frailmail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskn0tt%2Frailmail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskn0tt%2Frailmail/lists"}