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
# or:
pip install --user myl

on nix you can do this:

nix run github:pschmitt/myl -- --help

🛠️ 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.9.8.tar.gz (46.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

myl-0.9.8-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: myl-0.9.8.tar.gz
  • Upload date:
  • Size: 46.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for myl-0.9.8.tar.gz
Algorithm Hash digest
SHA256 ec81afa6096c02dd230baf2f88f1efcc2a03c1e41ea82401f94e1e4a0483e163
MD5 92451798bf638e591355a9b1847c9a02
BLAKE2b-256 99959461c8e2820c8832fd1afdab628a8dc73862ed59313eb94c9e22cceb8639

See more details on using hashes here.

Provenance

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

Publisher: pypi.yaml on pschmitt/myl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: myl-0.9.8-py3-none-any.whl
  • Upload date:
  • Size: 31.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for myl-0.9.8-py3-none-any.whl
Algorithm Hash digest
SHA256 da0954f0f09b672be18e393dabcc184d57821df46e35b4ac55d5869ea61b97b1
MD5 e160e60fd10ee598fcfa077209d9523c
BLAKE2b-256 54659e73f53e2a51b4005792f6178b6b86383f26a38993eda8846c60ecc731fb

See more details on using hashes here.

Provenance

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

Publisher: pypi.yaml on pschmitt/myl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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