{"id":15487857,"url":"https://github.com/dblock/canonical-emails","last_synced_at":"2025-09-20T04:32:11.226Z","repository":{"id":62554923,"uuid":"10874219","full_name":"dblock/canonical-emails","owner":"dblock","description":"Combine email validation and transformations to produce canonical email addresses.","archived":false,"fork":false,"pushed_at":"2014-12-30T22:25:37.000Z","size":176,"stargazers_count":23,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-25T15:20:31.989Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dblock.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-06-22T23:05:16.000Z","updated_at":"2022-09-21T08:21:34.000Z","dependencies_parsed_at":"2022-11-03T05:15:40.547Z","dependency_job_id":null,"html_url":"https://github.com/dblock/canonical-emails","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/dblock/canonical-emails","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dblock%2Fcanonical-emails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dblock%2Fcanonical-emails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dblock%2Fcanonical-emails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dblock%2Fcanonical-emails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dblock","download_url":"https://codeload.github.com/dblock/canonical-emails/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dblock%2Fcanonical-emails/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276046889,"owners_count":25575876,"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","status":"online","status_checked_at":"2025-09-20T02:00:10.207Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-10-02T06:42:26.743Z","updated_at":"2025-09-20T04:32:10.929Z","avatar_url":"https://github.com/dblock.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"CanonicalEmails\n==============\n\n[![Gem Version](http://img.shields.io/gem/v/canonical-emails.svg)](http://badge.fury.io/rb/canonical-emails)\n[![Build Status](http://img.shields.io/travis/dblock/canonical-emails.svg)](https://travis-ci.org/dblock/canonical-emails)\n[![Dependency Status](https://gemnasium.com/dblock/canonical-emails.svg)](https://gemnasium.com/dblock/canonical-emails)\n[![Code Climate](https://codeclimate.com/github/dblock/canonical-emails.svg)](https://codeclimate.com/github/dblock/canonical-emails)\n\nCombine email validation and transformations to produce canonical email addresses. For example, parse and transform `Donald Duck \u003cdonald.duck@gmail.com\u003e` into `donaldduck@gmail.com`, for `@gmail.com` addresses only. Patches instances of `Mail::Address`.\n\n### Install\n\nAdd `canonical-emails` to your Gemfile.\n\n```\ngem 'canonical-emails'\n```\n\n### Use\n\n``` ruby\nclass User\n  include CanonicalEmails::Extensions\n\n  attr_accessor :email\n  canonical_email :email, CanonicalEmails::GMail\nend\n\nuser = User.new\nuser.email = \"Donald Duck \u003cDonald.Duck@gmail.com\u003e\"\nuser.canonical_email.class # Mail::Address\nuser.canonical_email.to_s # \"Donald Duck \u003cdonaldduck@gmail.com\u003e\"\nuser.canonical_email.address # \"donaldduck@gmail.com\"\n```\n\n### Transform\n\n#### CanonicalEmails::Downcase\n\nReplaces the address and domain portion of the email by its lowercase equivalent.\n\n``` ruby\nemail = CanonicalEmails::Downcase.transform(\"Donald Duck \u003cDoNaLD.DuCK@eXaMPLe.CoM\u003e\")\nemail.to_s # \"Donald Duck \u003cdonald.duck@example.com\u003e\"\nemail.address # \"donald.duck@example.com\"\n```\n\n#### CanonicalEmails::GMail\n\nGmail.com e-mail addresses ignore periods and aren't case-sensitive. The canonical version removes them and changes the address portion to lowercase.\n\n``` ruby\nemail = CanonicalEmails::GMail.transform(\"Donald Duck \u003cdonald.duck@gmail.com\u003e\")\nemail.to_s # \"Donald Duck \u003cdonaldduck@gmail.com\u003e\"\nemail.local # \"donaldduck\"\nemail.address # \"donaldduck@gmail.com\"\n```\n\n### Multiple Transformations\n\nCombine multiple transformations, executed from left to right.\n\n```\ncanonical_email :email, CanonicalEmails::GMail, CanonicalEmails::...\n```\n\n### Custom Transformations\n\nA transformation is a module that has a single `transform` method that returns a `Mail::Address` instance. This library patches internal methods of the `Mail::Address` class.\n\n``` ruby\nmodule CanonicalEmails\n  module ReverseName\n    def self.transform(value)\n      Mail::Address.new(value).tap do |email|\n        email.instance_eval do\n          def name\n            super.reverse\n          end\n        end\n      end\n    end\n  end\nend\n\nemail = CanonicalEmails::ReverseName.transform(\"Donald Duck \u003cdonald@example.org\u003e\")\nemail.name # \"kcuD dlanoD\"\n```\n\n### Contribute\n\nSee [CONTRIBUTING](CONTRIBUTING.md).\n\n### Copyright and License\n\nCopyright Daniel Doubrovkine and Contributors, [Artsy](https://artsy.net), 2013-2014\n\n[MIT License](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdblock%2Fcanonical-emails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdblock%2Fcanonical-emails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdblock%2Fcanonical-emails/lists"}