imapctl 0.1.0

Scriptable IMAP client for the shell
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

# imapctl

Scriptable IMAP client for the shell.

Where it makes sense, commands read their input from `stdin` making it possible
to compose commands with pipes.


## Installation


### Nix flakes

Nix can take care of the toolchains for you ;)

```sh
nix run git+https://seed.radicle.garden/zjy7BiSYaEFtM9ohHwSfJGbyPQKp.git
# and building ofc
nix build git+https://seed.radicle.garden/zjy7BiSYaEFtM9ohHwSfJGbyPQKp.git
```


### Docker

```sh
nix build '#docker'
docker load < result

# To run:
docker run -ti imapctl
```

## Usage

Use `imapctl --help` for more help.


### Examples


#### Authenticate using environmental variables

```sh
export IMAPCTL_HOST=imap.example.com
export IMAPCTL_USERNAME=you@example.com
export IMAPCTL_PASSWD_CMD="pass show hosts/imap.example.com/you@example.com"
```

The other examples will assume these environmental variables to be set.
Alternatively, you can pass the `--host`, `--username` and `--passwd-cmd`
parameters.


#### List ID's for all messages in the *INBOX* mailbox

```sh
imapctl search all
```


#### List ID's for all messages in the *bla* mailbox

```sh
imapctl search --mailbox bla all
```


#### List *From* and *Subject* for all message in the *bla* mailbox

```sh
imapctl search --mailbox bla all |imapctl fetch
```


#### List *Date*, *From* and *Subject* for the *INBOX*

```sh
imapctl search all |imapctl fetch --format '{{date}} - {{from}} {{ subject }}'
```


#### Copy/Sync messages from one mailbox (*INBOX*) to another (*bla*)

```sh
for msg in $(imapctl search all); do
    (imapctl fetch $msg --format '{{body}}' |imapctl append --mailbox bla)
done
```