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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: myl-0.8.13.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.13.tar.gz
Algorithm Hash digest
SHA256 2ad74c4c6f073a3839464e11e9e2ea6734729a8b9130200f90432e4d7c95dbde
MD5 3b7722aea7bfab95f28db60e2922a07f
BLAKE2b-256 3ec0e4586253fc62a176841c7ac3e0ee80b02b0a23946eb17355359a66472346

See more details on using hashes here.

Provenance

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

Publisher: pypi.yaml on pschmitt/myl

Attestations:

File details

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

File metadata

  • Download URL: myl-0.8.13-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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 87f531c0fa5f0c46c2b8528c8c0130da5b33335ceb43722020fbb3a7edf54c94
MD5 9ea04c4ae3e61bcf17018c39df7edf2d
BLAKE2b-256 34f6e0e63656b710d677a30e64f27e7345d0a979d479af0b6c2b4f54a5333b50

See more details on using hashes here.

Provenance

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