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.7.tar.gz (42.4 kB view hashes)

Uploaded Source

Built Distribution

myl-0.8.7-py3-none-any.whl (29.1 kB view hashes)

Uploaded Python 3

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