Admin tool for running pymap instances.
Project description
pymap-admin
The pymap-admin
tool can be used to perform various admin functions against a
running pymap server. This is a separate grpc service using grpclib
listening on a socket.
API Documentation
Connections
By default, the pymap-admin
command will attempt to interact with a pymap
admin server over a UNIX socket, typically in /tmp/pymap/pymap-adin.sock
.
With the --host
or $PYMAP_ADMIN_HOST
options, you can use a TCP connection
(the default grpc port is 50051). However, the pymap admin service must also be
configured to listen on a port, using either of these options:
pymap ... --admin-private 127.0.0.1:50051 ...
pymap ... --admin-public 0.0.0.0:9090 ...
The --admin-private
option will function exactly like the UNIX socket: all
operations will succeed unencrypted and without authentication. As such, a
"private" admin service port should be properly firewalled.
The --admin-public
option is safe to expose publicly. It is SSL/TLS encrypted
using the same certificate as your IMAP sockets, and commands are authenticated
on a per-user basis. For example, to append a message to a user's INBOX, that
user must authenticate:
pymap-admin --password=... append user@example.com
# or $PYMAP_ADMIN_PASSWORD
# or --ask-password
Commands
API Documentation
ping
Command
Pings the running server and reports its version string.
$ pymap-admin ping
server_version: "0.14.1"
append
Command
To append a message directly to a mailbox, without using IMAP, use the
append
admin command. First, check out the help:
$ pymap-admin append --help
As a basic example, you can append a message to a like this:
$ cat <<EOF | pymap-admin append demouser
> From: user@example.com
>
> test message!
> EOF
mailbox: "INBOX"
validity: 1784302999
uid: 101
2.0.0 Message delivered
User Commands
These commands access and manipulate the users on the system:
$ pymap-admin list-users --help
$ pymap-admin set-user --help
$ pymap-admin get-user --help
$ pymap-admin delete-user --help
The list-users
command lists all usernames on the system, one per line.
Passing a username to get-user
will display that user's metadata, including
the (securely hashed) password string. A username can be deleted with
delete-user
. The set-user
command will create and update a username and its
password.
If using pymap as part of the slimta-docker configuration, see its Address Management documentation for additional options.
The MIT License (MIT)
Copyright (c) 2019 Ian Good
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pymap_admin-0.4.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe74ff87c3b59076800d3ddd886fc88aee20f3c547e46b0033384d6ad2d75da9 |
|
MD5 | fc561f4ee6f1da0158839d5b512be77f |
|
BLAKE2b-256 | 60b65dd8329f85d979fa5f5fb4ab905d98e08a62e7613b49d80ea56f732f582e |