{"id":13463329,"url":"https://github.com/Sandglaz/maktoub","last_synced_at":"2025-03-25T06:31:52.503Z","repository":{"id":422677,"uuid":"2602888","full_name":"Sandglaz/maktoub","owner":"Sandglaz","description":"A simple newsletter engine for Rails","archived":false,"fork":false,"pushed_at":"2023-01-19T11:17:45.000Z","size":186,"stargazers_count":312,"open_issues_count":13,"forks_count":29,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-10-29T13:50:53.453Z","etag":null,"topics":["engine","newsletter","rails","ruby"],"latest_commit_sha":null,"homepage":"http://blog.sandglaz.com/maktoub-a-simple-newsletter-engine-for-rails/","language":"Ruby","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/Sandglaz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rdoc","contributing":null,"funding":null,"license":"MIT-LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-10-18T23:37:16.000Z","updated_at":"2024-03-19T07:17:26.000Z","dependencies_parsed_at":"2023-02-10T23:05:11.421Z","dependency_job_id":null,"html_url":"https://github.com/Sandglaz/maktoub","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sandglaz%2Fmaktoub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sandglaz%2Fmaktoub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sandglaz%2Fmaktoub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sandglaz%2Fmaktoub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sandglaz","download_url":"https://codeload.github.com/Sandglaz/maktoub/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245414261,"owners_count":20611357,"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":["engine","newsletter","rails","ruby"],"created_at":"2024-07-31T13:00:51.110Z","updated_at":"2025-03-25T06:31:52.086Z","avatar_url":"https://github.com/Sandglaz.png","language":"Ruby","funding_links":[],"categories":["Rails Plugins"],"sub_categories":["User Messaging Systems"],"readme":"# Maktoub\n\nMaktoub is a Ruby on Rails engine for email newsletters.\n* Write your newsletter as you would write any view (erb partial)\n* Maktoub sends your email in multipart as both html and text\n\n\n## Installation\n\n  ```ruby\n  # Add this line to your Gemfile\n  gem 'maktoub'\n  ```\n\nThen `bundle install`\n\n## Compatibility\n  \nCompatible with Rails 4+. For Rails 3.1+ use version 0.3.1\n\n## Usage\n\n### Configuration\n\nYou can run `rails generate maktoub:config` to generate the configuration file. This task creates a `matkoub.rb` initializer file (in config/initializer)\nFollow instructions inside the file to configure it the way you want.\n\n### Authoring\n\nCreate a newsletter as a normal view partial in `app/views/maktoub/newsletters/.`\nThe subject of the newsletter will be automatically deduced from the partial's name.\n\n### Editing Styles\n\nCreate a view partial in `app/views/layouts/maktoub/_styles.erb`. Note that this completely overrides the styles that come with maktoub. \nYou can copy the built-in styles and override them.\n\n### Sending messages\nMaktoub comes with two rake tasks to allow you to:\n* send a test message to the \"from\" address of your newsletter.\n\n  ```ruby\n  rake maktoub:test['name_of_my_newsletter_partial']\n  ```\n\n* publish the newsletter to all your subscribers. If you have delayed_job installed then it will use it to deliver each email as a background job\n\n  ```ruby\n   rake maktoub:mail['name_of_my_newsletter_parial']\n  ```\n\nAlternatively you have access to a Maktoub::NewsletterMailer ActionMailer object with a publish method\n  ```ruby\n   Maktoub::NewsletterMailer.publish('my_newsletter_partial', name: 'User name', email: 'user@example.com')\n  ```\n\n### View in browser\nTo be able to view your newsletter in a browser add it to routes.rb.\n  - mount the engine at a path of your choice. e.g. `mount Maktoub::Engine =\u003e '/'`\n  - you would access the newsletter at: `http://example.com/\u003cmounted_path\u003e/newsletter/my_awesome_newletter`\n  \n\n### Contributing\nSend a pull request including documentation changes and tests. \n\n## TODO\n- create github page for project\n- allow management of multiple lists\n- allow rendering of newletter from remotely hosted views (e.g. S3)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSandglaz%2Fmaktoub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSandglaz%2Fmaktoub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSandglaz%2Fmaktoub/lists"}