From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 5FBD36D10F for ; Thu, 12 Aug 2021 17:30:46 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 4AA6F2581A for ; Thu, 12 Aug 2021 17:30:16 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 3542D25803 for ; Thu, 12 Aug 2021 17:30:12 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 01C6A43305 for ; Thu, 12 Aug 2021 17:30:12 +0200 (CEST) From: Aaron Lauterer To: pmg-devel@lists.proxmox.com Date: Thu, 12 Aug 2021 17:30:10 +0200 Message-Id: <20210812153010.2327589-1-a.lauterer@proxmox.com> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.311 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pmg-devel] [PATCH pmg-api] API: Mailtracker: add values to rstatus and dstatus description X-BeenThere: pmg-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Mail Gateway development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 12 Aug 2021 15:30:46 -0000 The possible values were only documented within the source code. Having them as part of the API description will help people wanting to use the tracker API endpoint interpreting the results. Signed-off-by: Aaron Lauterer --- src/PMG/API2/MailTracker.pm | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/src/PMG/API2/MailTracker.pm b/src/PMG/API2/MailTracker.pm index 187decf..952abc8 100644 --- a/src/PMG/API2/MailTracker.pm +++ b/src/PMG/API2/MailTracker.pm @@ -38,6 +38,14 @@ my $statmap = { Q => 'quarantine', }; +my $print_statmap = sub { + my $map = ""; + foreach my $key (sort keys %$statmap) { + $map .= "$key: $statmap->{$key}\n"; + } + return $map; +}; + my $run_pmg_log_tracker = sub { my ($args, $includelog) = @_; @@ -247,13 +255,15 @@ my $email_log_property_desc = { type => 'integer', }, dstatus => { - description => "Delivery status.", + description => "Delivery status. Can be one of the following values:\n" . + $print_statmap->(), type => 'string', minLength => 1, maxLength => 1, }, rstatus => { - description => "Delivery status of relayed mail.", + description => "Delivery status of relayed mail. Can be one of the " . + "following values:\n" . $print_statmap->(), type => 'string', minLength => 1, maxLength => 1, -- 2.30.2