{"id":18026825,"url":"https://github.com/yegor256/mailanes","last_synced_at":"2025-03-27T01:31:28.868Z","repository":{"id":62722669,"uuid":"146325869","full_name":"yegor256/mailanes","owner":"yegor256","description":"Smart E-mail Delivery System (helps me manage subscribers to my blog and send them monthly newsletters)","archived":false,"fork":false,"pushed_at":"2025-03-20T20:34:13.000Z","size":1376,"stargazers_count":36,"open_issues_count":14,"forks_count":9,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-20T22:03:52.888Z","etag":null,"topics":["elegantobjects","email","email-sender","ruby","sinatra"],"latest_commit_sha":null,"homepage":"https://www.mailanes.com","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/yegor256.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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-08-27T16:41:28.000Z","updated_at":"2025-03-10T13:29:54.000Z","dependencies_parsed_at":"2023-11-06T08:23:29.083Z","dependency_job_id":"e8409af8-98e3-4a43-a11f-937d1171e5a4","html_url":"https://github.com/yegor256/mailanes","commit_stats":null,"previous_names":[],"tags_count":72,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yegor256%2Fmailanes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yegor256%2Fmailanes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yegor256%2Fmailanes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yegor256%2Fmailanes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yegor256","download_url":"https://codeload.github.com/yegor256/mailanes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245764715,"owners_count":20668466,"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":["elegantobjects","email","email-sender","ruby","sinatra"],"created_at":"2024-10-30T08:08:11.785Z","updated_at":"2025-03-27T01:31:28.858Z","avatar_url":"https://github.com/yegor256.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://www.mailanes.com/logo.svg\" width=\"92px\" height=\"92px\"/\u003e\n\n[![EO principles respected here](http://www.elegantobjects.org/badge.svg)](http://www.elegantobjects.org)\n[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/mailanes)](http://www.rultor.com/p/yegor256/mailanes)\n[![We recommend RubyMine](http://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)\n\n[![rake](https://github.com/yegor256/mailanes/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/mailanes/actions/workflows/rake.yml)\n[![PDD status](http://www.0pdd.com/svg?name=yegor256/mailanes)](http://www.0pdd.com/p?name=yegor256/mailanes)\n[![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/mailanes.svg)](https://codecov.io/github/yegor256/mailanes?branch=master)\n[![Maintainability](https://api.codeclimate.com/v1/badges/451556110dacf73cc6f6/maintainability)](https://codeclimate.com/github/yegor256/mailanes/maintainability)\n[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/mailanes/blob/master/LICENSE.txt)\n[![Availability at SixNines](https://www.sixnines.io/b/8f0c)](https://www.sixnines.io/h/8f0c)\n[![Hits-of-Code](https://hitsofcode.com/github/yegor256/mailanes)](https://hitsofcode.com/view/github/yegor256/mailanes)\n\nIt's an e-mail sending web app.\n\nRead this blog post, it explains how it works:\n[_Mailanes.com Helps Manage Newsletters and Mailing Lists_](https://www.yegor256.com/2018/10/30/mailanes.html).\n\n## How to Configure?\n\nThere are few entities you can configure via simple [YAML](http://yaml.org/)\nsettings, including lists, lanes, campaigns, letters, and recipients.\n\n### List\n\n```yaml\ntitle: My subscribers\nnotify:\n  # Notify this email every time a new subscriber\n  # is added to the list through the /subscribe URL\n  email: yegor256@gmail.com\n  # Notify in Telegram chat. You can get this number\n  # just by starting a chat with https://t.me/mailanes_bot\n  telegram: 136544085\n  # You may ignore some notifications\n  ignore:\n    - subscribe\n    - unsubscribe\n    - add\n    - comment\n    - download\n    - upload\n    - bounce\n# List of GitHub account who also have access to this list\n# and can add recipients to it, via /add?list=ID URL.\nfriends:\n  - yegor256\n# If this is set to TRUE an email right after being added\n# to this list will be de-activated in all other lists\nexclusive: true\n# If this is TRUE, all new recipients that get into the list via the\n# /subscribe link, will be marked as non-yet-confirmed. They will have\n# to click the link, which is available in your Markdown template\n# as {{confirm}} (similar to the {{unsubsribe}} you have there).\n# The default is FALSE.\nconfirmation_required: true\n```\n\n### Lane\n\n```yaml\ntitle: Monthly newsletters\n# The FROM field of all letters to be sent from this\n# Lane. This can be overwritten by each individual Letter.\nfrom: Yegor Bugayenko \u003cyegor256@gmail.com\u003e\n# The CC of the email to be sent\ncc:\n  - Yegor Bugayenko \u003cyegor256@gmail.com\u003e\n# The BCC of the email to be sent\nbcc:\n  - Yegor Bugayenko \u003cyegor256@gmail.com\u003e\n# The TO field of all emails to be sent, which\n# you don't need to specify usually, since this\n# address is taken from the recipient details, but sometimes\n# you may need this.\nto: Yegor Bugayenko \u003cyegor256@gmail.com\u003e\n# The email to collect all bounces (the default is `reply@mailanes.com`)\nbounces: reply@mailanes.com\n# SMTP parameters of the email sending server\nsmtp:\n  host: email-smtp.us-east-1.amazonaws.com\n  port: 587\n  user: AKIAI1TIS4FF6UGJT3CQ\n  password: ArPxO8gf56y02G8cKM80IpvMQve8Pss+L4+inJZ3UG3t\n# Here you can specify the Telegram transport details, if\n# some of your letters are going to be delivered via Telegram.\ntelegram:\n  chat_id: 7389473289\n```\n\n### Campaign\n\n```yaml\n# The title of the campaign\ntitle: Monthly\n# Stop the campaign at this date (it will be deactivated automatically)\nuntil: 03-09-2018\n# Maximum amount of emails to be sent per day\nspeed: 100\nnotify:\n  # Notify in Telegram chat. You can get this number\n  # just by starting a chat with https://t.me/mailanes_bot\n  telegram: 136544085\n# Send fake emails to this address, in order to\n# lower the bounce-back stats of the SMTP providers (recommended)\ndecoy:\n  # How many fake emails per each real email\n  amount: 0.1\n  # Destination address ('*' will be replaced by a random 0-9 number)\n  address: my-fake***@example.com\n```\n\n### Letter\n\n```yaml\n# The title of the letter\ntitle: Aug 2018\n# The subject of all emails to be sent\nsubject: There are some great news, guys!\n# The FROM field of all emails to be sent\nfrom: Yegor Bugayenko \u003cyegor256@gmail.com\u003e\n# The CC of the email to be sent\ncc:\n  - Yegor Bugayenko \u003cyegor256@gmail.com\u003e\n# The BCC of the email to be sent\nbcc:\n  - Yegor Bugayenko \u003cyegor256@gmail.com\u003e\n# The TO field of all emails to be sent, which\n# you don't need to specify usually, since this\n# address is taken from the recipient details, but sometimes\n# you may need this.\nto: Yegor Bugayenko \u003cyegor256@gmail.com\u003e\n# When this Letter has to be deactivated\nuntil: 03-09-2018\n# For how many days/hours/minutes the campaign should\n# not send out any letters after it sends this one. There\n# are three possible formats:\n#  hh:mm:ss    - exactly how much time it should relax\n#  dd-mm-yyyy  - when exactly it should relax\n#  sss         - in how many seconds\nrelax: \"20:0:0\"\n# The ID of the letter to quote while sending this one\nquote: 12\n# This can be either SMTP or Telegram. If it's SMTP, you have\n# to specify the SMTP section in the Lane. If it's Telegram,\n# you have to specify telegram chat ID in the Lane.\ntransport: SMTP\n# Maximum amount of emails to be sent per day\nspeed: 100\n# Turn OFF email opening tracking feature (ON by default)\ntracking: off\n```\n\nHere is how your Liquid template may look like:\n\n```liquid\n{% if first %}\n{{first}},\n{% else %}\nHi,\n{% endif %}\n\nHow are you? Thanks for joining my list. Please\n[click here]({{confirm}}) to confirm that you are serious\nand want to stay.\n\n—\u003cbr/\u003e\nYegor Bugayenko\u003cbr/\u003e\nTo remove your email ({{email}}) from the list, [click here]({{unsubscribe}}).\n```\n\n### Recipient\n\nNot implemented yet...\n\n## API\n\nYou can retrieve the data from the system via the API. First, you have\nto get the authorization code from the [API page](https://www.mailaines.com/api).\nThen, add it to each HTTP request you make, as `auth` URI parameter. For example,\nto see the total count of all active subscribers of your list:\n\n`/api/lists/123/active_count.json?auth=74fa8672...`\n\nAll URIs:\n\n  * `/api/lists/:id/active_count.json`: total active subscibers in the list\n  * `/api/lists/:id/per_day.json`: new subscribers per day (last 10 days stat, change with `days`)\n  * `/api/campaigns/:id/deliveries_count.json`: deliveries per day (last day, change with `days`)\n  * more coming...\n\n## How to contribute\n\nRead [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).\nMake sure your build is green before you contribute\nyour pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+,\nJava 8+, Maven 3.2+, PostgreSQL 10+, and\n[Bundler](https://bundler.io/) installed. Then:\n\n```bash\n$ bundle update\n$ bundle exec rake\n```\n\nIf it's clean and you don't see any error messages, submit your pull request.\n\nTo run a single unit test you should first do this:\n\n```bash\n$ bundle exec rake pgsql liquibase run\n```\n\nAnd then, in another terminal (for example):\n\n```bash\n$ bundle exec ruby test/test_campaign.rb -n test_iterates_lists\n```\n\nShould work.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyegor256%2Fmailanes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyegor256%2Fmailanes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyegor256%2Fmailanes/lists"}