]>
Commit | Line | Data |
---|---|---|
93f5feff DM |
1 | [[chapter_pmgsh]] |
2 | ifdef::manvolnum[] | |
3 | pmgsh(1) | |
4 | ======== | |
5 | :pmg-toplevel: | |
6 | ||
7 | NAME | |
8 | ---- | |
9 | ||
10 | pmgsh - Proxmox Mail Gateway API Shell | |
11 | ||
12 | ||
13 | SYNOPSIS | |
14 | -------- | |
15 | ||
16 | include::pmgsh.1-synopsis.adoc[] | |
17 | ||
18 | ||
19 | DESCRIPTION | |
20 | ----------- | |
21 | endif::manvolnum[] | |
22 | ifndef::manvolnum[] | |
23 | API Shell | |
24 | ========= | |
25 | :pmg-toplevel: | |
26 | endif::manvolnum[] | |
27 | ||
28 | Toolkit to access the Proxmox Mail Gateway API via the command line. | |
29 | ||
30 | Examples | |
31 | -------- | |
32 | ||
33 | List entries: | |
34 | ||
35 | ---- | |
36 | # pmgsh ls / | |
37 | ---- | |
38 | ||
39 | Call method 'GET' on an specific API path: | |
40 | ||
41 | ---- | |
42 | # pmgsh get /version | |
43 | ---- | |
44 | ||
45 | View current mail configuration: | |
46 | ||
47 | ---- | |
48 | # pmgsh get /config/mail | |
49 | ---- | |
50 | ||
51 | Get help for a specific path: | |
52 | ||
53 | ---- | |
54 | # pmgsh help /config/mail -v | |
55 | ---- | |
56 | ||
57 | Disable option 'spf' in '/config/mail' | |
58 | ||
59 | ---- | |
60 | # pmgsh set /config/mail -spf 0 | |
61 | ---- | |
62 | ||
e051eef8 | 63 | Delete 'spf' setting from '/config/mail' |
93f5feff DM |
64 | |
65 | ---- | |
66 | # pmgsh set /config/mail -delete spf | |
67 | ---- | |
68 | ||
69 | ||
70 | ifdef::manvolnum[] | |
71 | include::pmg-copyright.adoc[] | |
72 | endif::manvolnum[] | |
73 |