NAME

pmgsh - Proxmox Mail Gateway API Shell

SYNOPSIS

Interactive session:

pmgsh

Directly call API functions:

pmgsh (get|set|create|help) <path> [OPTIONS]

DESCRIPTION

The pmgsh tool can be used to access the Proxmox Mail Gateway API via the command line.

Examples

List entries:

# pmgsh ls /

Call the GET method on a specific API path:

# pmgsh get /version

View current mail configuration:

# pmgsh get /config/mail

Get help for a specific path:

# pmgsh help /config/mail  -v

Disable option spf in /config/mail

# pmgsh set /config/mail  -spf 0

Delete spf setting from /config/mail

# pmgsh set /config/mail  -delete spf

Copyright and Disclaimer

Copyright © 2007-2024 Proxmox Server Solutions GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/