Skip to main content

Mailfox is a simple and fast ai powered email toolkit to enhance you email workflow

Project description


GitHub Release GitHub License

Mailfox is a simple and fast ai powered email toolkit to enhance you email workflow.

Getting Started

Installation

Run pip install mailfox to get started!

Set Up

To setup mailfox you can simply run the mailfox init command which will launch you into a guided setup wizard:

The wizard will guiide you through the following steps:

  • Setting Credentials: You'll be prompted to enter your email address and password. Optionally, you can enter an API key if you plan to use the LLM classifier.

  • Configuring Paths: You'll be prompted to set paths for the email database and clustering data. You can also specify any flagged folders and set the default classifier (either "clustering" or "llm").

  • Downloading Emails: You'll be asked if you'd like to download your emails to the VectorDB immediately.

Features

Classification

Classify emails into categories such as Social, Promotions, Updates, Forums, Purchases, Spam and Others.

When the mailfox run command is executed, it will classify all unread emails in your inbox and move them to the corresponding folder. It will then sleep for 5 minutes and repeat the process.

Search

Coming Soon...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mailfox-0.1.5.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

mailfox-0.1.5-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file mailfox-0.1.5.tar.gz.

File metadata

  • Download URL: mailfox-0.1.5.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.13 Darwin/23.5.0

File hashes

Hashes for mailfox-0.1.5.tar.gz
Algorithm Hash digest
SHA256 42cc97c4971d8194707b94be785bcb831208e976792fc736ad12163bc5cef1a0
MD5 552f317b65b9cad9699bb862c42b2b8f
BLAKE2b-256 a6099afda5ceac7d9b79d3f47f7dbfee16e15f076af4aa0fca59ac4d30c23f72

See more details on using hashes here.

File details

Details for the file mailfox-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: mailfox-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 23.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.13 Darwin/23.5.0

File hashes

Hashes for mailfox-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 88f8f9ebf429a892704070195b977e742e1422ffa660c90188b1d199699ccda1
MD5 c56b195b324cb74e4fdf40251d77d1b6
BLAKE2b-256 c2da5cf3e395921c509090530ba7633a3e74e8b9023dc9bbcbf7244d8a54d66e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page