{"id":20040464,"url":"https://github.com/postalserver/postal-rails","last_synced_at":"2025-05-05T08:32:00.300Z","repository":{"id":110402711,"uuid":"88880172","full_name":"postalserver/postal-rails","owner":"postalserver","description":"A Rails library for the Postal e-mail platform","archived":false,"fork":false,"pushed_at":"2018-05-28T04:45:02.000Z","size":4,"stargazers_count":23,"open_issues_count":3,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-08T19:46:48.327Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/postalserver.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":"2017-04-20T15:15:57.000Z","updated_at":"2025-04-05T20:29:36.000Z","dependencies_parsed_at":"2023-03-10T15:15:18.057Z","dependency_job_id":null,"html_url":"https://github.com/postalserver/postal-rails","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postalserver%2Fpostal-rails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postalserver%2Fpostal-rails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postalserver%2Fpostal-rails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postalserver%2Fpostal-rails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/postalserver","download_url":"https://codeload.github.com/postalserver/postal-rails/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252466685,"owners_count":21752412,"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":"2024-11-13T10:42:20.129Z","updated_at":"2025-05-05T08:32:00.292Z","avatar_url":"https://github.com/postalserver.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Postal for Rails\n\nPostal for Rails allows you to integrate Postal directly into Action Mailer in a Rails application. There's no need to change any of your existing mailers, you just need to update your environment config.\n\n## Installation\n\nAdd the `postal-rails` gem to your Gemfile and run `bundle install` to install it.\n\n```ruby\ngem 'postal-rails', '~\u003e 1.0'\n```\n\n## Configuration\n\nOpen up your `config/environment/production.rb` or `config/environment/development.rb` and change the delivery method to `postal`.\n\n```ruby\nconfig.action_mailer.delivery_method = :postal\n```\n\nYou'll also need to provide your server key. If you don't have a server key, login to your web interface and generate a credential for the server you wish to send messages through.\n\nYou also need to set the `POSTAL_KEY` environment variable to include key and `POSTAL_HOST` to include the hostname of your Postal service.\n\nAlternatively, you can configure it as shown below in your environment configuration file along with the `delivery_method`.\n\n```ruby\nconfig.action_mailer.postal_settings = {:host =\u003e \"postal.yourdomainc.com\", :server_key =\u003e \"xxxxx\"}\n```\n\nThat's it! Send an email to test everything is working as you'd expect. Remember, if you have `raise_delivery_errors` set to false you might not see any errors. Use `deliver!` when running your tests so any exceptions are raised.\n\nDon't forget, you need to make sure that you're sending mail from domains that are added \u0026 verified to your Postal domain.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpostalserver%2Fpostal-rails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpostalserver%2Fpostal-rails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpostalserver%2Fpostal-rails/lists"}