Table of Contents

Function

The MailproxyList task displays the MailProxy data of several domains.

You can find further information about list queries here.

Description

Route: POST /mailProxy/_search

There is no need to send a body.

Query parameters

The data of the following keywords can be queried with the query parameter ?keys[]=:

  • admin
  • created
  • domain
  • greylisting
  • owner
  • protection
  • target
  • updated
  • updater
Request 
{
}
Response 
{
   "stid": "20190919-app3-dev-8043",
   "status": {
      "code": "S0514",
      "text": "MailProxy data has been inquired successfully.",
      "type": "SUCCESS"
   },
   "object": {
      "type": "MailProxy",
      "summary": 1
   },
   "data": [
      {
         "domain": "example.com",
         "created": "2019-09-19T12:40:02.000+0200",
         "target": "example1.com",
         "admin": "customer@example.com",
         "protection": "CUSTOM"
      }
   ]
}

Task code: 0514
Uses MailProxy object

The following keywords are returned by default:

  • admin
  • created
  • domain
  • protection
  • target


The data of the following keywords can be queried with the <key> keyword:

  • greylisting
  • owner
  • updater
  • updated


Request 
<request>
	<auth>
		<user>customer</user>
		<password>password</password>
		<context>104</context>
	</auth>
	<!--
	<owner>
		<user>subuser</user>
		<context>104</context>
	</owner>
	-->
	<task>
		<code>0514</code>
		<view>
			<limit>2</limit>
			<children>1</children>
		</view>
		<where>
			<key>domain</key>
			<operator>like</operator>
			<value>ex*</value>
		</where>
		<reply_to>customer@example.com</reply_to>
		<ctid>customer-transaction-id</ctid>
	</task>
</request>
Response 
<response>
	<result>
		<data>
			<summary>3</summary>
			<mail_proxy>
				<admin>customer@example123.de</admin>
				<protection>CUSTOM</protection>
				<domain>example123.de</domain>
				<created>2011-12-01 11:17:09</created>
			</mail_proxy>
			<mail_proxy>
				<admin>customer@example456.de</admin>
				<protection>MEDIUM</protection>
				<domain>example456.de</domain>
				<created>2015-11-04 11:27:55</created>
			</mail_proxy>
			<mail_proxy>
				<admin>customer@example789.de</admin>
				<protection>CUSTOM</protection>
				<domain>example789.de</domain>
				<created>2015-12-03 14:53:55</created>
			</mail_proxy>
		</data>
		<status>
			<code>S0514</code>
			<text>MailProxy data has been inquired successfully.</text>
			<type>success</type>
		</status>
	</result>
	<ctid>1S2W3F</ctid>
	<stid>20160412-app2-359428</stid>
</response>