GET api/AutoResponder?user={user}&address={address}&objectHandle={objectHandle}&serviceHandle={serviceHandle}&domHandle={domHandle}

Returns a list of auto responders for the specified user with optional filters

Request Information

URI Parameters

Name	Description	Type	Additional information
user	User handle	string	None.
address	Email address	string	None.
objectHandle	Mailbox object handle	string	None.
serviceHandle	Service object handle	string	None.
domHandle	Domain object handle	string	None.

Body Parameters

None.

Response Information

Resource Description

A list of autoresponder objects on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error

Collection of AutoResponder

Name	Description	Type	Additional information
ObjectHandle	Object handle of the mail box	string	None.
Active	Is the autoresponder active	boolean	None.
MailAddress	Address of the mail box	string	None.
Forward	Address to forward to when active	string	None.
Message	Auto reply message body	string	None.
Subject	Auto reply subject	string	None.
Start	Start date	date	None.
Finish	End date	date	None.
Errors	List of errors encountered	Collection of Error	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ObjectHandle": "sample string 1",
    "Active": true,
    "MailAddress": "sample string 3",
    "Forward": "sample string 4",
    "Message": "sample string 5",
    "Subject": "sample string 6",
    "Start": "2025-04-05T09:57:34.9854701+02:00",
    "Finish": "2025-04-05T09:57:34.9854701+02:00",
    "Errors": []
  },
  {
    "ObjectHandle": "sample string 1",
    "Active": true,
    "MailAddress": "sample string 3",
    "Forward": "sample string 4",
    "Message": "sample string 5",
    "Subject": "sample string 6",
    "Start": "2025-04-05T09:57:34.9854701+02:00",
    "Finish": "2025-04-05T09:57:34.9854701+02:00",
    "Errors": []
  }
]

application/xml, text/xml

Sample:

<ArrayOfAutoResponder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">
  <AutoResponder>
    <Active>true</Active>
    <Errors />
    <Finish>2025-04-05T09:57:34.9854701+02:00</Finish>
    <Forward>sample string 4</Forward>
    <MailAddress>sample string 3</MailAddress>
    <Message>sample string 5</Message>
    <ObjectHandle>sample string 1</ObjectHandle>
    <Start>2025-04-05T09:57:34.9854701+02:00</Start>
    <Subject>sample string 6</Subject>
  </AutoResponder>
  <AutoResponder>
    <Active>true</Active>
    <Errors />
    <Finish>2025-04-05T09:57:34.9854701+02:00</Finish>
    <Forward>sample string 4</Forward>
    <MailAddress>sample string 3</MailAddress>
    <Message>sample string 5</Message>
    <ObjectHandle>sample string 1</ObjectHandle>
    <Start>2025-04-05T09:57:34.9854701+02:00</Start>
    <Subject>sample string 6</Subject>
  </AutoResponder>
</ArrayOfAutoResponder>