# Generator emails 📧
A Python module for generating unique email addresses with customizable options. Supports both public and anonymous email domains, keyword-based usernames, and history tracking to avoid duplicates.
## Installation
You can install the package via PyPi:
```bash
pip install generator-emails
```
Or clone the repository:
```bash
git clone https://github.com/Triram-2/generator-emails.git
cd generator-emails
pip install -r requirements.txt
```
## Usage
Import the module and create an instance:
```python
from generator_emails import GeneratorEmails
generator = GeneratorEmails()
email = generator.generate_email()
print(email) # Example output: johndoe123@gmail.com
```
## Built-in Domain Databases
generator-emails includes two built-in lists of domains:
- **Public domains** – Popular email providers such as Gmail, Yahoo, Outlook, and Yandex.
- **Anonymous domains** – Temporary and privacy-focused email services like Guerrilla Mail, Mailinator, and 10MinuteMail.
These domains are used when selecting `'random'` (for public) or `'anonim'` (for anonymous) as the domain parameter.
## Parameters
### `GeneratorEmails(save_history=True)`
- `save_history` *(bool)* – Whether to store generated emails to prevent duplicates.
### `generate_email(range_len=(10, 18), domain='gmail.com', keywords=None, format='{username}')`
Generates a unique email address.
#### **Arguments:**
- `range_len` *(tuple, optional)* – Min and max length of the username.
- `domain` *(str or list, optional)* – Email domain. Can be a string, list of domains, `'random'` for a random public domain, or `'anonim'` for an anonymous domain.
- `keywords` *(str or list, optional)* – A keyword or list of keywords to include in the username.
#### **Returns:**
- `str` – A generated unique email address.
## Example Usage
```python
email1 = generator.generate_email()
email2 = generator.generate_email(domain='yahoo.com', keywords='testuser')
email3 = generator.generate_email(range_len=(8, 12), keywords=['test', 'Mirukha'])
print(email1)
print(email2)
print(email3)
```
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://github.com/yourusername/generator-names",
"name": "generator-emails",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Misha",
"author_email": "bobyyy239@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ef/2b/ac0d4905943d773a2294288d4c2a4b5d96ef3127dbfc258d05bb502d1ceb/generator_emails-0.1.0.tar.gz",
"platform": null,
"description": "# Generator emails \ud83d\udce7 \n\nA Python module for generating unique email addresses with customizable options. Supports both public and anonymous email domains, keyword-based usernames, and history tracking to avoid duplicates. \n\n## Installation \nYou can install the package via PyPi: \n```bash\npip install generator-emails\n```\n\nOr clone the repository: \n```bash\ngit clone https://github.com/Triram-2/generator-emails.git\ncd generator-emails\npip install -r requirements.txt\n```\n\n## Usage \nImport the module and create an instance: \n```python\nfrom generator_emails import GeneratorEmails\n\ngenerator = GeneratorEmails()\nemail = generator.generate_email()\nprint(email) # Example output: johndoe123@gmail.com\n```\n\n## Built-in Domain Databases\n\ngenerator-emails includes two built-in lists of domains:\n\n- **Public domains** \u2013 Popular email providers such as Gmail, Yahoo, Outlook, and Yandex.\n- **Anonymous domains** \u2013 Temporary and privacy-focused email services like Guerrilla Mail, Mailinator, and 10MinuteMail.\n\nThese domains are used when selecting `'random'` (for public) or `'anonim'` (for anonymous) as the domain parameter.\n\n## Parameters \n\n### `GeneratorEmails(save_history=True)` \n- `save_history` *(bool)* \u2013 Whether to store generated emails to prevent duplicates. \n\n### `generate_email(range_len=(10, 18), domain='gmail.com', keywords=None, format='{username}')` \nGenerates a unique email address. \n\n#### **Arguments:** \n- `range_len` *(tuple, optional)* \u2013 Min and max length of the username.\n- `domain` *(str or list, optional)* \u2013 Email domain. Can be a string, list of domains, `'random'` for a random public domain, or `'anonim'` for an anonymous domain.\n- `keywords` *(str or list, optional)* \u2013 A keyword or list of keywords to include in the username.\n\n#### **Returns:** \n- `str` \u2013 A generated unique email address.\n\n## Example Usage\n```python\nemail1 = generator.generate_email()\nemail2 = generator.generate_email(domain='yahoo.com', keywords='testuser')\nemail3 = generator.generate_email(range_len=(8, 12), keywords=['test', 'Mirukha'])\n\nprint(email1)\nprint(email2)\nprint(email3)\n```\n\n## License\nThis project is licensed under the MIT License.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generator_emails - Unique Email Address Generator \ud83d\ude80",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/yourusername/generator-names"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f8f47da348c66b3058914aabd42e53933bff25fb1efc9a1b8c5016e798b23c39",
"md5": "2a7b39340a37a70075eafaad93e2d427",
"sha256": "ec7f30c35a763e77b7904b7805ac909261ed8ba0e3a180c1858961a19d4cd7c9"
},
"downloads": -1,
"filename": "generator_emails-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a7b39340a37a70075eafaad93e2d427",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5211,
"upload_time": "2025-02-07T16:52:25",
"upload_time_iso_8601": "2025-02-07T16:52:25.736759Z",
"url": "https://files.pythonhosted.org/packages/f8/f4/7da348c66b3058914aabd42e53933bff25fb1efc9a1b8c5016e798b23c39/generator_emails-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ef2bac0d4905943d773a2294288d4c2a4b5d96ef3127dbfc258d05bb502d1ceb",
"md5": "7d352aa97fd9e070db7890594f3ed94c",
"sha256": "6d1351881eb40d2de457b1e75db0fa28f2118c1c131064600833c0cd75fe671d"
},
"downloads": -1,
"filename": "generator_emails-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7d352aa97fd9e070db7890594f3ed94c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4813,
"upload_time": "2025-02-07T16:52:27",
"upload_time_iso_8601": "2025-02-07T16:52:27.072332Z",
"url": "https://files.pythonhosted.org/packages/ef/2b/ac0d4905943d773a2294288d4c2a4b5d96ef3127dbfc258d05bb502d1ceb/generator_emails-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-07 16:52:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "generator-names",
"github_not_found": true,
"lcname": "generator-emails"
}
JSON
