pop/README.md
2023-07-10 17:41:40 -04:00

4.2 KiB
Raw Blame History

Pop


Latest Release Go Docs Build Status

Send emails from your terminal.

pop mail text-based client

Text-based User Interface

Launch the TUI

pop

Command Line Interface

pop < message.md \
    --from "me@example.com" \
    --to "you@example.com" \
    --subject "Hello, world!" \
    --attach invoice.pdf
pop mail command line client
Resend and Charm logos

To use pop, you will need a RESEND_API_KEY.

You can grab one from: https://resend.com/api-keys.

Environment

To avoid typing your From: email address, you can also set the RESEND_FROM environment to pre-fill the field anytime you launch pop.

export RESEND_API_KEY=$(pass RESEND_API_KEY)
export RESEND_FROM=pop@charm.sh

Installation

Use a package manager:

# macOS
brew install pop

# Arch
yay -S pop

# Nix
nix-env -iA nixpkgs.pop

Install with Go:

go install github.com/charmbracelet/pop@latest

Or download a binary from the releases.

Examples

Pop can be combined with other tools to create powerful email pipelines, such as:

Mods

Use mods with pop to write an email body with AI:

Note

: Use the --preview flag to preview the email and make changes before sending.

pop --body '$(mods -f "Write an email about how the command line is the best.")'
    --subject '$(mods "Write a catchy email subject about the command line is the best computing platform.")'
    --preview
Generate email with mods and send email with pop.

Gum

Use gum with pop to choose an email to send to and from:

pop --from $(gum choose "vt52@charm.sh" "vt78@charm.sh" "vt100@charm.sh")
    --to $(gum filter < contacts.txt)
Select contact information with gum and send email with pop.

Invoice

Use invoice with pop to generate and send invoices entirely from the command line.

FILENAME=invoice.pdf
invoice generate --item "Rubber Ducky" --rate 25 --quantity 2 --output $FILENAME
pop --attach $FILENAME --to client@example.com --from rubberducky@quack.com --body "See attached invoice."
Generate invoice with invoice and attach file and send email with pop.

License

MIT

Feedback

Wed love to hear your thoughts on this project. Feel free to drop us a note!

License

MIT


Part of Charm.

The Charm logo

Charm 热爱开源 • Charm loves open source