From 8538d9a2e7d13a2b3b29ce1a42e7224c7ae6e9e1 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Tue, 9 Jan 2018 12:25:57 +0100 Subject: [PATCH] add fetchmail.conf.5-opts.adoc --- fetchmail.conf.5-opts.adoc | 40 ++++++++++++++++++++++++++++++++++++ gen-fetchmail.conf.5-opts.pl | 16 +++++++++++++++ pmgconfig.adoc | 6 ++++++ 3 files changed, 62 insertions(+) create mode 100644 fetchmail.conf.5-opts.adoc create mode 100755 gen-fetchmail.conf.5-opts.pl diff --git a/fetchmail.conf.5-opts.adoc b/fetchmail.conf.5-opts.adoc new file mode 100644 index 0000000..eecb9fd --- /dev/null +++ b/fetchmail.conf.5-opts.adoc @@ -0,0 +1,40 @@ +`enable`: `` ('default =' `0`):: + +Flag to enable or disable polling. + +`interval`: ` (1 - 2016)` :: + +Only check this site every poll cycles. A poll cycle is 5 minutes. + +`keep`: `` ('default =' `0`):: + +Keep retrieved messages on the remote mailserver. + +`pass`: `` :: + +The password used tfor server login. + +`port`: ` (1 - 65535)` :: + +Port number. + +`protocol`: `` :: + +Specify the protocol to use when communicating with the remote mailserver + +`server`: `` :: + +Server address (IP or DNS name). + +`ssl`: `` ('default =' `0`):: + +Use SSL. + +`target`: `(?:|[^\s\/\@]+\@[^\s\/\@]+)` :: + +The target email address (where to deliver fetched mails). + +`user`: `` :: + +The user identification to be used when logging in to the server + diff --git a/gen-fetchmail.conf.5-opts.pl b/gen-fetchmail.conf.5-opts.pl new file mode 100755 index 0000000..0d77419 --- /dev/null +++ b/gen-fetchmail.conf.5-opts.pl @@ -0,0 +1,16 @@ +#!/usr/bin/perl + +use lib '.'; +use strict; +use warnings; +use PVE::RESTHandler; + +use Data::Dumper; + +use PMG::API2::Fetchmail; + +my $properties = $PMG::API2::Fetchmail::fetchmail_create_properties; + +print PVE::RESTHandler::dump_properties($properties); + +exit(0); diff --git a/pmgconfig.adoc b/pmgconfig.adoc index 79ca27d..eb15e02 100644 --- a/pmgconfig.adoc +++ b/pmgconfig.adoc @@ -452,6 +452,12 @@ User Management TODO +Fetchmail +--------- + +include::fetchmail.conf.5-opts.adoc[] + + ifdef::manvolnum[] include::pmg-copyright.adoc[] endif::manvolnum[] -- 2.39.2