# emailtools
[![PyPI](https://img.shields.io/pypi/v/emailtools?style=for-the-badge&color=ee999f&labelColor=302d41)](https://pypi.org/project/emailtools)
[![GitHub](https://img.shields.io/github/license/armanyazdi/emailtools?style=for-the-badge&color=8cd5ca&labelColor=302d41)](https://pypi.org/project/emailtools)
A Python library for email suggestions and validations.
## Installation
Install from [PyPI](https://pypi.org/project/emailtools) with pip by typing in your favorite terminal:
This will install `persian-names` (for generating random names).
`pip install emailtools`
## Usage
Let's take a look at what an example test case would look like using `emailtools`.
### Generate Random Emails:
Note: You can use the name of email providers or their domains for the first argument.
```python
from emailtools import generate
# generate('EmailProvider', 'FirstName', 'LastName', BirthYear)
generate() # Generates a random email
# Example: Reza.Mahmoudi_2023@yahoo.com
generate('gmail') # Generates a random Gmail
# Example: Jafari_Niloufar@gmail.com
generate('gmail.com', 'Arash', 'Amiri')
# Example: Amiri-Arash1@gmail.com
generate('Outlook', 'Bita', 'Alipour', 1995)
# Example: BitaAlipour.1995@outlook.com
```
### Suggest Email Usernames:
```python
from emailtools import generate
for i in range(10):
print(generate('Gmail', 'Saman', 'Rezaei', 1980))
# SamanRezaei@gmail.com
# Rezaei_Saman_1980@gmail.com
# Rezaei_Saman@gmail.com
# RezaeiSaman_5@gmail.com
# Saman_Rezaei_1980@gmail.com
# Rezaei.Saman@gmail.com
# RezaeiSaman7@gmail.com
# Saman-Rezaei_1@gmail.com
# Rezaei_Saman@gmail.com
# Saman.Rezaei1980@gmail.com
```
### Validate Emails:
```python
from emailtools import validate
validate('Anahita.Faramarzi@gmail.com') # True
validate('Fariborz_Jalali20.gmail.com') # False
validate('Mohammadrezaei-Arash7@gmail') # False
```
Raw data
{
"_id": null,
"home_page": "https://github.com/armanyazdi/emailtools",
"name": "emailtools",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "email generator,email suggester,email validator,email",
"author": "Arman Yazdi",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/68/17/b6aca5dd7ca65be3b3be609a5126532fc63ac2a9225511adf3107d50e7f8/emailtools-0.0.4.tar.gz",
"platform": null,
"description": "# emailtools\n\n[![PyPI](https://img.shields.io/pypi/v/emailtools?style=for-the-badge&color=ee999f&labelColor=302d41)](https://pypi.org/project/emailtools)\n[![GitHub](https://img.shields.io/github/license/armanyazdi/emailtools?style=for-the-badge&color=8cd5ca&labelColor=302d41)](https://pypi.org/project/emailtools)\n\nA Python library for email suggestions and validations.\n\n## Installation\n\nInstall from [PyPI](https://pypi.org/project/emailtools) with pip by typing in your favorite terminal:\n\nThis will install `persian-names` (for generating random names).\n\n`pip install emailtools`\n\n## Usage\n\nLet's take a look at what an example test case would look like using `emailtools`.\n\n### Generate Random Emails:\n\nNote: You can use the name of email providers or their domains for the first argument.\n\n```python\nfrom emailtools import generate\n\n# generate('EmailProvider', 'FirstName', 'LastName', BirthYear)\n\ngenerate() # Generates a random email\n# Example: Reza.Mahmoudi_2023@yahoo.com\n\ngenerate('gmail') # Generates a random Gmail\n# Example: Jafari_Niloufar@gmail.com\n\ngenerate('gmail.com', 'Arash', 'Amiri')\n# Example: Amiri-Arash1@gmail.com\n\ngenerate('Outlook', 'Bita', 'Alipour', 1995)\n# Example: BitaAlipour.1995@outlook.com\n```\n\n### Suggest Email Usernames:\n\n```python\nfrom emailtools import generate\n\nfor i in range(10):\n print(generate('Gmail', 'Saman', 'Rezaei', 1980))\n\n# SamanRezaei@gmail.com\n# Rezaei_Saman_1980@gmail.com\n# Rezaei_Saman@gmail.com\n# RezaeiSaman_5@gmail.com\n# Saman_Rezaei_1980@gmail.com\n# Rezaei.Saman@gmail.com\n# RezaeiSaman7@gmail.com\n# Saman-Rezaei_1@gmail.com\n# Rezaei_Saman@gmail.com\n# Saman.Rezaei1980@gmail.com\n```\n\n### Validate Emails:\n\n```python\nfrom emailtools import validate\n\nvalidate('Anahita.Faramarzi@gmail.com') # True\nvalidate('Fariborz_Jalali20.gmail.com') # False\nvalidate('Mohammadrezaei-Arash7@gmail') # False\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python library for email suggestions and validations.",
"version": "0.0.4",
"split_keywords": [
"email generator",
"email suggester",
"email validator",
"email"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b11d3a78dccbaceb5e54c3e348444207dd5f646e0e1170382078dd19b24114c4",
"md5": "2f6c5445074d346b258a661cf24692ef",
"sha256": "cf1c5076377619f6aa891939170a55899f7089a5767c9365b57e15a1c6960d55"
},
"downloads": -1,
"filename": "emailtools-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f6c5445074d346b258a661cf24692ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4103,
"upload_time": "2023-01-24T09:28:05",
"upload_time_iso_8601": "2023-01-24T09:28:05.329577Z",
"url": "https://files.pythonhosted.org/packages/b1/1d/3a78dccbaceb5e54c3e348444207dd5f646e0e1170382078dd19b24114c4/emailtools-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6817b6aca5dd7ca65be3b3be609a5126532fc63ac2a9225511adf3107d50e7f8",
"md5": "a02a479e0bcf8bcfb582f38fc74eb00b",
"sha256": "5b7c64e5590f40bf5471e49dc4dd75bb246b87843320ebc2a60f34cea14d5225"
},
"downloads": -1,
"filename": "emailtools-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "a02a479e0bcf8bcfb582f38fc74eb00b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3779,
"upload_time": "2023-01-24T09:28:07",
"upload_time_iso_8601": "2023-01-24T09:28:07.179378Z",
"url": "https://files.pythonhosted.org/packages/68/17/b6aca5dd7ca65be3b3be609a5126532fc63ac2a9225511adf3107d50e7f8/emailtools-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-24 09:28:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "armanyazdi",
"github_project": "emailtools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "persian-names",
"specs": []
}
],
"lcname": "emailtools"
}