Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fnando/email-provider-info
Find email provider service based on the email address.
https://github.com/fnando/email-provider-info
Last synced: 27 days ago
JSON representation
Find email provider service based on the email address.
- Host: GitHub
- URL: https://github.com/fnando/email-provider-info
- Owner: fnando
- License: mit
- Created: 2022-01-16T03:00:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-20T16:55:19.000Z (12 months ago)
- Last Synced: 2024-10-06T04:25:17.685Z (about 1 month ago)
- Language: Ruby
- Size: 118 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# email-provider-info
Find email provider service based on the email address.
Ruby:
[](https://github.com/fnando/email-provider-info)
[](https://rubygems.org/gems/email-provider-info)
[](https://rubygems.org/gems/email-provider-info)
[](https://tldrlegal.com/license/mit-license)
JavaScript:
[](https://github.com/fnando/email-provider-info)
[](https://npmjs.org/package/@fnando/email-provider-info)
[](https://npmjs.org/package/@fnando/email-provider-info)
[](https://tldrlegal.com/license/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
```bash
npm install @fnando/email-provider-info --save
```
If you're using Yarn (and you should):
```bash
yarn add @fnando/email-provider-info
```
### Ruby
```bash
gem install email_provider_info
```
Or add the following line to your project's Gemfile:
```ruby
gem "email-provider-info"
```
## Usage
### JavaScript
```js
import { getEmailProvider } from "@fnando/email-provider-info";
const { name, url } = getEmailProvider("[email protected]");
if (url) {
// Do something
}
```
### Ruby
```ruby
require "email_provider_info"
provider = EmailProviderInfo.call("[email protected]")
if provider
# Do something
end
```
Additionally, you can use the
[sniper link technique](https://growth.design/sniper-link) 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.
```ruby
require "email_provider_info"
provider = EmailProviderInfo.call("[email protected]")
if provider
url = provider.search_url(sender: "[email protected]")
# 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.
## Maintainer
- [Nando Vieira](https://github.com/fnando)
## Contributors
- https://github.com/fnando/email-provider-info/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](https://opensource.org/licenses/MIT). 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](https://github.com/fnando/email-provider-info/blob/main/CODE_OF_CONDUCT.md).