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

Uploaded Source

Built Distribution

myl-0.9.0-py3-none-any.whl (30.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: myl-0.9.0.tar.gz
  • Upload date:
  • Size: 44.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.9.0.tar.gz
Algorithm Hash digest
SHA256 a13ad18396fb393006dbfe5bb201441c279234302b4c41eece6ee172b20d560f
MD5 989c9c3cff30575c4bca4a81eed3b2c8
BLAKE2b-256 fd9c7e746428122da6bd64a3c22a63daa776b3cf74c8d4e3879eb707e6b2aa39

See more details on using hashes here.

Provenance

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

Publisher: pypi.yaml on pschmitt/myl

Attestations:

File details

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

File metadata

  • Download URL: myl-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 30.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.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b0ea1c1af4e376d8485a73962c1ee58c2ddd91ebb0cefe177857ebe53aa066e
MD5 f0f7cc08747560c06cd99789b9ad0776
BLAKE2b-256 370e8f2f60152a0df15b52b7ed6c9ec787c3230b9720f9a6138e1ddc4fac0111

See more details on using hashes here.

Provenance

The following attestation bundles were made for myl-0.9.0-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