82 lines
157 KiB
Markdown
82 lines
157 KiB
Markdown
|
---
|
|||
|
|
obj: application
|
|||
|
|
repo: https://github.com/charmbracelet/pop
|
|||
|
|
rev: 2024-04-01
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# pop
|
|||
|
|
Pop is a tool for sending [emails](../../internet/eMail.md) from your terminal.
|
|||
|
|
|
|||
|
|
![Pop][Pop]
|
|||
|
|
|
|||
|
|
## Usage
|
|||
|
|
Usage: `pop [options]`
|
|||
|
|
|
|||
|
|
| Option | Environment Variable | Description |
|
|||
|
|
| ------------------------------ | -------------------------------- | ----------------------- |
|
|||
|
|
| `-a, --attach strings` | - | [Email](../../internet/eMail.md)'s attachments |
|
|||
|
|
| `--bcc strings` | - | BCC recipients |
|
|||
|
|
| `-b, --body string` | - | [Email](../../internet/eMail.md)'s contents |
|
|||
|
|
| `--cc strings` | - | CC recipients |
|
|||
|
|
| `-f, --from string` | `$POP_FROM` | [Email](../../internet/eMail.md)'s sender |
|
|||
|
|
| `--preview` | - | Preview the [email](../../internet/eMail.md) |
|
|||
|
|
| `-r, --resend.key string` | `$RESEND_API_KEY` | API key for Resend.com |
|
|||
|
|
| `-x, --signature string` | `$POP_SIGNATURE` | Signature |
|
|||
|
|
| `-e, --smtp.encryption string` | `$POP_SMTP_ENCRYPTION` | Encryption type |
|
|||
|
|
| `-H, --smtp.host string` | `$POP_SMTP_HOST` | Host of [SMTP](../../internet/SMTP.md) server |
|
|||
|
|
| `-i, --smtp.insecure` | `$POP_SMTP_INSECURE_SKIP_VERIFY` | Skip TLS verification |
|
|||
|
|
| `-p, --smtp.password string` | `$POP_SMTP_PASSWORD` | Password of [SMTP](../../internet/SMTP.md) server |
|
|||
|
|
| `-P, --smtp.port int` | `$POP_SMTP_PORT` | Port of [SMTP](../../internet/SMTP.md) server |
|
|||
|
|
| `-U, --smtp.username string` | `$POP_SMTP_USERNAME` | Username of [SMTP](../../internet/SMTP.md) server |
|
|||
|
|
| `-s, --subject string` | - | [Email](../../internet/eMail.md)'s subject |
|
|||
|
|
| `-t, --to strings` | - | Recipients |
|
|||
|
|
| `-u, --unsafe` | - | Allow unsafe [HTML](../../internet/HTML.md) |
|
|||
|
|
|
|||
|
|
## Text-based User Interface
|
|||
|
|
Launch the TUI
|
|||
|
|
```shell
|
|||
|
|
pop
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Command Line Interface
|
|||
|
|
```shell
|
|||
|
|
pop < message.md \
|
|||
|
|
--from "me@example.com" \
|
|||
|
|
--to "you@example.com" \
|
|||
|
|
--subject "Hello, world!" \
|
|||
|
|
--attach invoice.pdf
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
To use `pop`, you will need a `RESEND_API_KEY` or configure an [`SMTP`](../../internet/SMTP.md) host.
|
|||
|
|
|
|||
|
|
You can grab one from: [https://resend.com/api-keys](https://resend.com/api-keys).
|
|||
|
|
|
|||
|
|
### Resend Configuration
|
|||
|
|
To use the resend delivery method, set the `RESEND_API_KEY` environment variable.
|
|||
|
|
|
|||
|
|
```shell
|
|||
|
|
export RESEND_API_KEY=$(pass RESEND_API_KEY)
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### [SMTP](../../internet/SMTP.md) Configuration
|
|||
|
|
To configure `pop` to use [`SMTP`](../../internet/SMTP.md), you can set the following [environment variables](../../linux/Environment%20Variables.md).
|
|||
|
|
|
|||
|
|
```shell
|
|||
|
|
export POP_SMTP_HOST=smtp.gmail.com
|
|||
|
|
export POP_SMTP_PORT=587
|
|||
|
|
export POP_SMTP_USERNAME=pop@charm.sh
|
|||
|
|
export POP_SMTP_PASSWORD=hunter2
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### Environment
|
|||
|
|
To avoid typing your `From:` email address, you can also set the `POP_FROM` environment to pre-fill the field anytime you launch `pop`.
|
|||
|
|
|
|||
|
|
```shell
|
|||
|
|
export POP_FROM=pop@charm.sh
|
|||
|
|
export POP_SIGNATURE="Sent with [Pop](https://github.com/charmbracelet/pop)!"
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
> **Note**: If you wish to use a resend account without a custom domain, you can use `onboarding@resend.dev` to send [emails](../../../../Life/eMails.md).
|
|||
|
|
|
|||
|
|
[Pop]: data:image/avif;base64,AAAAIGZ0eXBhdmlmAAAAAGF2aWZtaWYxbWlhZk1BMUEAAAGNbWV0YQAAAAAAAAAoaGRscgAAAAAAAAAAcGljdAAAAAAAAAAAAAAAAGxpYmF2aWYAAAAADnBpdG0AAAAAAAEAAAAsaWxvYwAAAABEAAACAAEAAAABAAD7hgAA0dkAAgAAAAEAAAG1AAD50QAAAEJpaW5mAAAAAAACAAAAGmluZmUCAAAAAAEAAGF2MDFDb2xvcgAAAAAaaW5mZQIAAAAAAgAAYXYwMUFscGhhAAAAABppcmVmAAAAAAAAAA5hdXhsAAIAAQABAAAAw2lwcnAAAACdaXBjbwAAABRpc3BlAAAAAAAACjMAAAf6AAAAEHBpeGkAAAAAAwgICAAAAAxhdjFDgSwAAAAAABNjb2xybmNseAABAA0ABoAAAAAOcGl4aQAAAAABCAAAAAxhdjFDgQwcAAAAADhhdXhDAAAAAHVybjptcGVnOm1wZWdCOmNpY3A6c3lzdGVtczphdXhpbGlhcnk6YWxwaGEAAAAAHmlwbWEAAAAAAAAAAgABBAECgwQAAgQBBYYHAAHLsm1kYXQSAAoHGy6oy/zwqDLC8wMQAAD0uZLT5l1vvHU6ea1PL3CtW+K+2G6o4G5VLL4N6M62tNqob94piUsZMjHcm5TH3hCw2sMdVkot2p43GKmO5I63+YBmYhaNtpjaMp6z3QNHgN9+b/jul8BM+8fK8TQQAUkOOZjqer1wwUGwznn52AgO6+7ydSBFBn1OWBUcaBXapsDMqLqbeWvTHQKG3w7B5SdjCvfAgc6Nvx0A41PL8LuVyAOso1jtqNuaXMxc+VAEy51pgKxL+4jrgSkNX/5FNa2UmYSBMYfsQ3OCwo3TEDcsqQjq7ohPMRBAxzGvvFns3eCcuyYJWHeg006PC5fkK5MMpro4Uvf1m//+AiMsZOgO/c4sTBVFstaQtP+jyJ/Ftjox6XsxLWt4n/5cBm8AN2s7FCYO+o/ZBtFSmQHtNz4a12Gr0KUWl3w48eV1pPBOo0g/9hp+c2zPln2TuvOX8WNN7YhaBhWwR30IvURXPUTd6mv04zyjhyUeQDhGdEKGkRPm2L4AvStKVdJOROEQDz9ceAR73zWXavjdjiaLJvTXVGQ2kkDsmv9uq3dby0h2SD6EOPdb15FQlbPJn6ebQbPmBvGhcCtT4r/d2iCQy6m2rIVnZq8EliqV5MGzpPDG+J7/PjNoXoJVcAzsBR4TvlpvN+ukp4ZV1SG3zSmgOYfmC5CYqPqOfkfMp3rTxyDVsHMga+uJKdwDoKZdY0aJExD7ogmf4FA8mrcViLWPeuSv4b0vl68wwJ4IHRM5UcFlQ1Y13OixQniRJsTQSUGcCEzCzA3XNgk9OzWL8V+UvOKRyZbwg2IPRzZl2Q4uZ3HiCwwkjNEkpjNyjXFy17ms6I2TJlsgo1OSdp2NWSM7wN+E6qmCt++nKbG0RXeUBelNY2KgCnRXBi77Ha905QMqOb88KVb/JmQAWa5hjLMpFjgcOHfxyh1jXo8Mk29bzL6uzg4ZgqasVAkamLoYDLlPrhH9AZzxFLqzx0y6b1uQC+UCISOvVjlM7PQeIMczqXmUXLdEDT7JnUZFE7jwMVoMBO4mdP3w5f9EHiUyf27U5eLowRNDyw+FGxL08o/suAXeeS2U+kumXzIna+RPBhmD97A5zMu1bkLNpNaiNTICJh9G0FzOvQ0RR80q1W+0B75oKph946XwAf7p8yg7qDL7bp+5eyvTgVCslwp8sCiTn+RlqUgBTtT8yoSqxQNiEbp2yOB7BWR7vO04mpcdFZx0eLbiCdIVccn8RBAE1HZQe5OtA5qprzFzgwL4f+UeILdxP8mAXxz11tO7pQbjj00uES1IobcvZ6Y6DiQxhusSdizxGHGDPEU87Dm7NawqH6dtKaSRnsIiggRrtM5huJLK9d2M0gZBMjj8kmRDQtMYmIP24vlBQxTmxiCV9Wd8ANubORzx7azI/AnIhnJwBuKcelMrTFelEU2zLNvIOqqyraJQ0iROvkHgjVTmdq1oi68z0sxBoll1ns7jcfc/F70N5/f0K+Wf8mIbkPfsespywiMIo5ZrMDJ8ZHhYjElC2rFGub3gwS6uSImzl7ZTmphnpK4mmXRR7C+rRjvBADR2JU5LxT7PI2en7roQodxMK9ZYLVCTOgpAm/CaW+glVJAM4rCwiPdeA7QcFiMzf4bm8yXVgHZXPJwuWhNQKsyBTRgb8BnADZ5Vxee56i5E25BWiYCME+G03DgPK957m8g+Hi/utxGGmhw4dVVXZVb6NEtoFFm2SfXBopyrw9HegSmeVhyotdj/BGlxHlcwdc6Aki+B04NQS2S9Kafuo6Av2APqCGR++xso5m8mmgdjkePcN6e1k+qVu3Ffr2d5DUQ2bqJOjkg11n4NyLbipY9Qo/Sk8AYfhOSJmFOFE9mdKTNyVInDTmi51skaYJ0Y5lpT4Lqu0OMO7PglG5maECLyn12sw1Yn4psAtzfNjefIgazY9jJhd5QEQRR18k+hit5I38q0MGIEy2po6xRalk9xWcACPQTnK2/Cm9SaKcZnZx92zHlN+orJdX1bM3wmRfhP/V1fNq/1bhj5QJ9fsFQcQdGotLCMMUQL7Ly8u3SA04Bk3T5rFnmoookAH27wal63Sj9bD4rDTfqvpSoNyWo54r6W+o395nvpeIbWitccHdHmwsY7z5YSuKsfUsv7kZLesWiXEVQQ1J4yrdrQiiTSL9RkftvfQZRFZ507n1K3L5u1iZRCSja0rKecqZZAi9YSFiHfs1pO+AA9p3J2nCumWso1cHRQqtaWQb8zYviGtVFgkugTUInilQzL2DVcwSlA6mz2wdb8gsgZ2mkKe0nHufFr5lh3u0d+d4bPn788JnhVBg4YuzUJaBVhc0oZnoXO09W+5+ZbqC/D6WGNu48k/OSikOVz7jMWLuYKNQ5m2BAbgLy/S15G+azSvFuZVmoAlEChpN4XCQcK++w5zpbCpeRoOHPmsQhLUNplA/Yk8gBqRPda0l+xAwuQePJ4tl4g/emDlUN1glb9OLlwnMqosci7OU8MwnOro+wKAFSlgVXKUyGrsFlnxM9gMBXNaekbYGVN96xUu8DfJWONo4ERW5N31G06p7r1OQW4RHiEKeo7R9xzeiYQuHbnPbALBkhOEySLgrRHi7hSrFvpiY5PmfUUcNoui9pWKZz36HoMaMpunoxW6d5kYDATdPpDOndJ8gDRlrNIoJKh8tehJvONdNOizgmHf2FjoL9dNnWsscs0DzsY6D83rqml/8y55Hul+vvYY/p+jwAJIv2h7UGyb84lUyEox19BnaieIFvNf6UUmaVo0S1ajI5RsANV5lO1cjC4giBAsNnmPLu5krfnibiRno1rTukTH0uuxy8+LQ1WXhXs5DEEGqORBwtdX4k92Xc55YoM+pKFP+wNL8Pk/oJKFaXbWpMarmkPPnWiq1dBAa6hVcUnDi37s+kGGob1wcqGh5YxJrhCyOW/Eu4WUzKKDDriFctu+tpx+b7p6SeQ3WUJxg2yFeaoMIa28JZltCdfmBqx7Yy/IXsiu7SSnCL0H4A9jcIaM4WKtjnvhnlofKQm7NHZpDq6JZh0x9I/pYPXKFNyIPmYV3eZFB08484u/igYea4T6HFonRd7mU809byCGI6S3qYVd/L9KuKNt5SCxF7Oman2d0d95nhbnsjjSsSFRDlI8QU/G/NWC2xwEQJIVtP5wk4lrpwygRvYzouUoUxjN+UzRwJVojj+cnIgGZYalDA/KqPMtlmTOncr8PVHe9llhKXS9KVLzRWI+i98R+p17qVriL4YvFfMh2+n+NxyoCHTN1B+FiEPsMkr/xgx+bsXauP8ABD8Gj1tyPAGXkiyqXPOsLmSMP6xao3g27KzqNfdFtvLbuQpPlBgzaZCiuXsD8Cgvpxt89I/BV23Lwn7Y1RGYcSeN6PWOyHhf+5X6qLnXuctj1vM+bg5X5c3ZiC+3VXCJBjCe3XoxlGw0Zk1zrZrXWC+Nu/858Gk1fIGgT3UbtpelYMgyXqnAucca
|