Skip to main content

Dead simple IMAP CLI client

Project description

📧 myl

myl is a dead simple IMAP CLI client hosted on GitHub at https://github.com/pschmitt/myl

📝 Description

myl is a command-line interface client for IMAP, designed to provide a straightforward way to interact with IMAP servers.

⭐ Features

  • Simple command-line interface
  • Support for various IMAP operations
  • Autodiscovery of the required server and port
  • Support for Google IMAP settings
  • Fetch a specific number of messages
  • Mark messages as seen
  • Fetch messages from a specific folder
  • Search for specific strings in messages
  • Output HTML email
  • Output raw email
  • Fetch a specific mail by ID
  • Fetch a specific attachment

🚀 Installation

To install myl, follow these steps:

pipx install myl

🛠️ Usage

Here's how you can use myl:

myl --help

This command will display the help information for the myl command.

Here are some examples of using flags with the myl command:

# Connect to an IMAP server
myl --server imap.example.com --port 143 --starttls --username "$username" --password "$password"

# Use Google IMAP settings
myl --google --username "$username" --password "$password"

# Autodiscovery of the required server and port
myl --auto --username "$username" --password "$password"

# We won't repeat the server connection flags from here
alias myl="command myl --auto --username \"$username\" --password \"$password\""

# Fetch a specific number of messages
myl --count 5

# Mark messages as seen
myl --mark-seen

# Fetch messages from a specific folder
myl --folder "INBOX"

# Search for specific strings in messages
myl --search "important"

# Fetch a specific mail ID
myl "$MAILID"

# Show HTML
myl --html "$MAILID"

# raw email
myl --raw "$MAILID" > email.eml

# Fetch a specific attachment (outputs to stdout)
myl "$MAILID" "$ATT" > att.txt

Please replace imap.example.com, $username, $password, $MAILID, and $ATT with your actual IMAP server details, username, password, mail ID, and attachment name.

📜 License

This project is licensed under the GPL-3.0 license.

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

myl-0.8.10.tar.gz (43.1 kB view details)

Uploaded Source

Built Distribution

myl-0.8.10-py3-none-any.whl (29.7 kB view details)

Uploaded Python 3

File details

Details for the file myl-0.8.10.tar.gz.

File metadata

  • Download URL: myl-0.8.10.tar.gz
  • Upload date:
  • Size: 43.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for myl-0.8.10.tar.gz
Algorithm Hash digest
SHA256 473271d54be203e18e0b39925418dd8b97f62e045ffa3ad019419adab1b24275
MD5 eb990afc294805c54b8c844cc88207db
BLAKE2b-256 ae4f76e428a3ddb31ce5fe3790708fb2a8efcf2842d67bcfa068206970a7a2c4

See more details on using hashes here.

File details

Details for the file myl-0.8.10-py3-none-any.whl.

File metadata

  • Download URL: myl-0.8.10-py3-none-any.whl
  • Upload date:
  • Size: 29.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for myl-0.8.10-py3-none-any.whl
Algorithm Hash digest
SHA256 1d12c2a8a9cd92ba08805ecee8a4b2bf9553cb4c7fda08740c5eda186c945c98
MD5 9e682009e8885360c27950a7e1b57f7d
BLAKE2b-256 9fd26302e5b8666d27839f85d0e660f3c4e13803b9becf254ba7ed67a1e5c762

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