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.12.tar.gz (43.4 kB view details)

Uploaded Source

Built Distribution

myl-0.8.12-py3-none-any.whl (29.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: myl-0.8.12.tar.gz
  • Upload date:
  • Size: 43.4 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.12.tar.gz
Algorithm Hash digest
SHA256 609508dcc49288dbe557594a794dfe0caefb904b9dc16e65f57d42569f14a723
MD5 8236ffb0f6ce240216337505be905bf2
BLAKE2b-256 1a6cf4f9b965104a7f3b11caab6750bafef858c4864a082cfe2b5755145bc3f4

See more details on using hashes here.

Provenance

The following attestation bundles were made for myl-0.8.12.tar.gz:

Publisher: pypi.yaml on pschmitt/myl

Attestations:

File details

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

File metadata

  • Download URL: myl-0.8.12-py3-none-any.whl
  • Upload date:
  • Size: 29.9 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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 ae617776dcacb502d51b338fab41bc6ba30d412f1091591465199ebe7bc99d7b
MD5 9cab0206efc785da6cbb3cd9936d378d
BLAKE2b-256 adfcc44a6ef4eb97a9cdf026deb9a21ad0db50fe6edb49daaf7950e8d0a48e0e

See more details on using hashes here.

Provenance

The following attestation bundles were made for myl-0.8.12-py3-none-any.whl:

Publisher: pypi.yaml on pschmitt/myl

Attestations:

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