Skip to content

fnando/email-provider-info

Repository files navigation

email-provider-info

Find email provider service based on the email address.

Ruby:

Ruby Tests Gem Gem MIT License

JavaScript:

JavaScript Tests NPM NPM MIT License

Supported services:

  • AOL
  • Apple iCloud
  • BOL
  • Fastmail
  • Gmail
  • GMX
  • Hey
  • Mail.ru
  • Outlook
  • ProtonMail
  • Tutanota
  • UOL
  • Yahoo!
  • Yandex
  • Zoho

Installation

This package is available as a NPM and Rubygems package. To install it, use the following command:

JavaScript

npm install @fnando/email-provider-info --save

If you're using Yarn (and you should):

yarn add @fnando/email-provider-info

Ruby

gem install email_provider_info

Or add the following line to your project's Gemfile:

gem "email-provider-info"

Usage

JavaScript

import { getEmailProvider } from "@fnando/email-provider-info";

const { name, url } = getEmailProvider("example@gmail.com");

if (url) {
  // Do something
}

Ruby

require "email_provider_info"

provider = EmailProviderInfo.call("email@gmail.com")

if provider
  # Do something
end

Additionally, you can use the sniper link technique for some providers. All you need to do is using search_url(sender: string) instead; providers that don't have a search link, will default to usual inbox url.

require "email_provider_info"

provider = EmailProviderInfo.call("email@gmail.com")

if provider
  url = provider.search_url(sender: "sender@example.com")
  # Do something
end

Motivation

The idea behind this package is enabling something like this, where users can go to their email service provider with just one click.

Example: Show button that goes straight to Gmail

Maintainer

Contributors

Contributing

For more details about how to contribute, please read https://github.com/fnando/email-provider-info/blob/main/CONTRIBUTING.md.

License

The gem is available as open source under the terms of the MIT License. A copy of the license can be found at https://github.com/fnando/email-provider-info/blob/main/LICENSE.md.

Code of Conduct

Everyone interacting in the email-provider-info project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.