PUT api/Mail/{handle}/AutoResponder?user={user}

Insert or update the auto responder for a mail box

Request Information

URI Parameters

Name	Description	Type	Additional information
handle	Mailbox object handle	string	Required
user	User handle	string	None.

Body Parameters

Auto responder details to be updated/inserted. Start and finish dates can be nullified or set to 0.

Dictionary of string [key] and Object [value]

Request 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-12-12T19:15:09.809643+01:00",
  "Finish": "2025-12-12T19:15:09.809643+01:00",
  "Errors": []
}

application/xml, text/xml

Sample:

<AutoResponder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">
  <Active>true</Active>
  <Errors />
  <Finish>2025-12-12T19:15:09.809643+01:00</Finish>
  <Forward>sample string 4</Forward>
  <MailAddress>sample string 3</MailAddress>
  <Message>sample string 5</Message>
  <ObjectHandle>sample string 1</ObjectHandle>
  <Start>2025-12-12T19:15:09.809643+01:00</Start>
  <Subject>sample string 6</Subject>
</AutoResponder>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AutoResponder'.

Response Information

Resource Description

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

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-12-12T19:15:09.8255052+01:00",
  "Finish": "2025-12-12T19:15:09.8255052+01:00",
  "Errors": []
}

application/xml, text/xml

Sample:

<AutoResponder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">
  <Active>true</Active>
  <Errors />
  <Finish>2025-12-12T19:15:09.8255052+01:00</Finish>
  <Forward>sample string 4</Forward>
  <MailAddress>sample string 3</MailAddress>
  <Message>sample string 5</Message>
  <ObjectHandle>sample string 1</ObjectHandle>
  <Start>2025-12-12T19:15:09.8255052+01:00</Start>
  <Subject>sample string 6</Subject>
</AutoResponder>