# temp-gmail-api
## Features
- **Create Temporary Emails:** Generate disposable emails quickly.
- **Fetch Messages:** Retrieve emails for the created email account.
- **Search by Keyword:** Efficiently search through the inbox to find relevant messages.
- **Session Management:** Handles browser-like sessions and cookies automatically.
## Installation
To use this module, ensure you have Python installed on your machine along with the `curl_cffi` package. You can install the required package using pip:
```bash
pip install curl-cffi temp-gmail
```
## Usage
Here's a basic example of how to use the GMail class from the module:
```py
from temp_gmail import GMail
# Creating an instance of the GMail class
gmail_instance = GMail()
# Creating a temporary email
email_address = gmail_instance.create_email()
print("Generated Email:", email_address)
# Loading the email list for the new email
emails = gmail_instance.load_list()
print("Emails:", emails)
# Example: Check for new items with a specific keyword
message_info = gmail_instance.check_new_item("welcome")
print("Message Details:", message_info)
```
## Methods
Here is a brief overview of some of the methods included in the GMail class:
```diff
- create_email()
> No parameters required.
> Returns the generated email address.
- load_list()
> No parameters required.
> Fetches all messages for the current email account.
- load_item(message_id)
> message_id: ID of the message to retrieve.
> Returns the contents of the specified message.
- check_new_item(keyword)
> keyword: The keyword to search for in messages.
> Searches all messages for the keyword and returns the first message ID with a match.
```
## Dependencies
curl_cffi: A Python package that provides a way to interact with curl via CFFI.
Raw data
{
"_id": null,
"home_page": "https://github.com/zukixa/temp-gmail",
"name": "temp-gmail",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "zukixa",
"author_email": "56563509+zukixa@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/14/41/8f1afc1c4faa1e8982cc03a99c9e24ba46c298d1f7177e016682f9bb6bea/temp-gmail-1.0.1.tar.gz",
"platform": null,
"description": "# temp-gmail-api\n\n## Features\n\n- **Create Temporary Emails:** Generate disposable emails quickly.\n- **Fetch Messages:** Retrieve emails for the created email account.\n- **Search by Keyword:** Efficiently search through the inbox to find relevant messages.\n- **Session Management:** Handles browser-like sessions and cookies automatically.\n\n## Installation\n\nTo use this module, ensure you have Python installed on your machine along with the `curl_cffi` package. You can install the required package using pip:\n\n```bash\npip install curl-cffi temp-gmail\n```\n\n## Usage\n\nHere's a basic example of how to use the GMail class from the module:\n\n```py\nfrom temp_gmail import GMail\n# Creating an instance of the GMail class\n\ngmail_instance = GMail()\n\n# Creating a temporary email\n\nemail_address = gmail_instance.create_email()\nprint(\"Generated Email:\", email_address)\n\n# Loading the email list for the new email\n\nemails = gmail_instance.load_list()\nprint(\"Emails:\", emails)\n\n# Example: Check for new items with a specific keyword\n\nmessage_info = gmail_instance.check_new_item(\"welcome\")\nprint(\"Message Details:\", message_info)\n```\n\n## Methods\n\nHere is a brief overview of some of the methods included in the GMail class:\n\n```diff\n- create_email()\n> No parameters required.\n> Returns the generated email address.\n- load_list()\n> No parameters required.\n> Fetches all messages for the current email account.\n- load_item(message_id)\n> message_id: ID of the message to retrieve.\n> Returns the contents of the specified message.\n- check_new_item(keyword)\n> keyword: The keyword to search for in messages.\n> Searches all messages for the keyword and returns the first message ID with a match.\n```\n\n## Dependencies\n\ncurl_cffi: A Python package that provides a way to interact with curl via CFFI.\n",
"bugtrack_url": null,
"license": null,
"summary": "temp gmail api.",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/zukixa/temp-gmail"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14418f1afc1c4faa1e8982cc03a99c9e24ba46c298d1f7177e016682f9bb6bea",
"md5": "0f5734a17f21a23ea56dab639969adf9",
"sha256": "6b8357753290d2bd419eeb1ae3c50c03b1fa159fcecfa2a4c379701a07d5deb8"
},
"downloads": -1,
"filename": "temp-gmail-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "0f5734a17f21a23ea56dab639969adf9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3029,
"upload_time": "2024-08-20T17:42:50",
"upload_time_iso_8601": "2024-08-20T17:42:50.845895Z",
"url": "https://files.pythonhosted.org/packages/14/41/8f1afc1c4faa1e8982cc03a99c9e24ba46c298d1f7177e016682f9bb6bea/temp-gmail-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-20 17:42:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zukixa",
"github_project": "temp-gmail",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "temp-gmail"
}
JSON
