QueryMailFwdList

Query list of mail forwards

Possible Gateways

The command QueryMailFwdList is available via the following gateways:

Required Parameters

The following parameters are standard parameters for this command.

Command

COMMAND = QueryMailFwdList
DNSZONE = [TEXT]
FROM    = [TEXT]
SOURCE  = [TEXT]
TARGET  = [TEXT]
TO      = [TEXT]
FIRST   = [TEXT]
LIMIT   = [TEXT]
ORDER   = ASC | DESC
ORDERBY = dnszone
CLTRID  = [TEXT]
WIDE    = [TEXT]

Response

code                 = [INT]
description          = [TEXT]
property[DNSZONE][0] = [TEXT]
property[FROM][0]    = [TEXT]
property[TO][0]      = [TEXT]
property[TO#][0]     = [TEXT]
property[COUNT][0]   = [INT]
property[FIRST][0]   = [INT]
property[LAST][0]    = [INT]
property[LIMIT][0]   = [INT]
property[TOTAL][0]   = [INT]
property[CLTRID][0]  = [TEXT]
property[SVTRID][0]  = [TEXT]

Attributes

WIDE	Optional
DNSZONE	Filter by DNSZONE (optional)
FROM	Filter by FROM (optional)
SOURCE	Filter by SOURCE (optional)
TARGET	Filter by TARGET (optional)
TO	Filter by TO (optional)
FIRST	Optional
LIMIT	Optional
ORDER	ASC \| DESC (optional)
ORDERBY	Order resulting list by this column (optional)
CLTRID	Unique identifier for this request, must be changed with every request, the default is auto-generated (optional)
DNSZONE	Associated zone; Will only be returned if WIDE
FROM	Forwarding from; Will only be returned if WIDE
TO	Comma separated list of recipients; Will only be returned if WIDE
TO#	Recipient; Will only be returned if WIDE
COUNT	Total number of forwardings shown
FIRST	Pointer to the first shown ID
LAST	Pointer to the last shown ID
LIMIT	The limit given in the command
TOTAL	Total number of existing forwardings
CLTRID	The transaction - ID given in the request where this response is the answer for; Will only be returned if a CLTRID was given in the request
SVTRID	A unique ID for this request generated by the server; Will only be returned if a CLTRID was given in the request