]> git.proxmox.com Git - pmg-docs.git/commitdiff
add fetchmail.conf.5-opts.adoc
authorDietmar Maurer <dietmar@proxmox.com>
Tue, 9 Jan 2018 11:25:57 +0000 (12:25 +0100)
committerDietmar Maurer <dietmar@proxmox.com>
Tue, 9 Jan 2018 11:25:57 +0000 (12:25 +0100)
fetchmail.conf.5-opts.adoc [new file with mode: 0644]
gen-fetchmail.conf.5-opts.pl [new file with mode: 0755]
pmgconfig.adoc

diff --git a/fetchmail.conf.5-opts.adoc b/fetchmail.conf.5-opts.adoc
new file mode 100644 (file)
index 0000000..eecb9fd
--- /dev/null
@@ -0,0 +1,40 @@
+`enable`: `<boolean>` ('default =' `0`)::
+
+Flag to enable or disable polling.
+
+`interval`: `<integer> (1 - 2016)` ::
+
+Only check this site every <interval> poll cycles. A poll cycle is 5 minutes.
+
+`keep`: `<boolean>` ('default =' `0`)::
+
+Keep retrieved messages on the remote mailserver.
+
+`pass`: `<string>` ::
+
+The password used tfor server login.
+
+`port`: `<integer> (1 - 65535)` ::
+
+Port number.
+
+`protocol`: `<imap | pop3>` ::
+
+Specify  the  protocol to use when communicating with the remote mailserver
+
+`server`: `<string>` ::
+
+Server address (IP or DNS name).
+
+`ssl`: `<boolean>` ('default =' `0`)::
+
+Use SSL.
+
+`target`: `(?:|[^\s\/\@]+\@[^\s\/\@]+)` ::
+
+The target email address (where to deliver fetched mails).
+
+`user`: `<string>` ::
+
+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 (executable)
index 0000000..0d77419
--- /dev/null
@@ -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);
index 79ca27dab1a107866ad8bf45f69faab27d3135e3..eb15e02fd6407def75b73a631696648c8068b750 100644 (file)
@@ -452,6 +452,12 @@ User Management
 TODO
 
 
+Fetchmail
+---------
+
+include::fetchmail.conf.5-opts.adoc[]
+
+
 ifdef::manvolnum[]
 include::pmg-copyright.adoc[]
 endif::manvolnum[]