Mike.robski: 1 revision: Release 105

2015-04-03T17:57:09Z

1 revision: Release 105

Viktor.penkov at 14:56, 11 March 2015

2015-03-11T14:56:50Z

Mike.robski: 1 revision: Release 87

2013-11-15T21:24:07Z

1 revision: Release 87

Stanimir.dimitrov: moved Accounts-account-email-domain-usernames-mailbox-autoresponder:PUT to Accounts-account-email-domain-usernames-mailboxName-autoresponder:PUT

2013-09-27T12:01:00Z

moved Accounts-account-email-domain-usernames-mailbox-autoresponder:PUT to Accounts-account-email-domain-usernames-mailboxName-autoresponder:PUT

New page

= PUT accounts/{account}/email/{domain}/usernames/{mailbox}/autoresponder =
Activates/deactivates the autoresponder for specified mailbox,domain and account.

__TOC__

== Request ==
<code>PUT accounts/{account}/email/{domain}/usernames/{mailbox}/autoresponder</code>

=== URI Parameters ===
; account - ''string''
:
; domain - ''string''
:
; mailbox - ''string''
:

=== Request Headers ===
{{Authorization}}

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

=== Request Body ===
<nowiki>
{
"subject": "{subject}",
"body": "{body}",
"active": {active}
}
</nowiki>

==== Parameters ====
; subject - ''string''
: The subject of auto-responder.

; body - ''string''
: The body of auto-responder. Required.

; active - ''boolean''
: Sets the status of auto-responder. Required.

== Response ==

=== Status Code ===
; 204 No Content
: Success

; 400 Bad Request
: The format of the request body is invalid or the username does not meet the requirements.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 404 Not Found
: The domain name does not exist.

== Examples ==

=== Failure setting the autoresponder with missing required parameter ===
'''Request'''
<nowiki>
PUT accounts/test-account123/email/test.com/usernames/test/autoresponder

{"subject": "Subject", "active": true}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"body":"Required"}
</nowiki>

=== Success setting the auto-responder ===
'''Request'''
<nowiki>
PUT accounts/test-account123/email/test.com/usernames/test/autoresponder

{"subject": "Subject", "body": "AutoRespond", "active": true}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

=== Success deactivating the auto-responder ===
'''Request'''
<nowiki>
PUT accounts/test-account123/email/test.com/usernames/test/autoresponder

{"body": "AutoRespond", "active": false}
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

@@ Line 41: / Line 41: @@
 ; active - ''boolean''
 : Sets the status of auto-responder. Required.
 == Response ==

Accounts-account-email-domain-usernames-mailboxName-autoresponder:PUT - Revision history

Mike.robski: 1 revision: Release 105

Viktor.penkov at 14:56, 11 March 2015

Mike.robski: 1 revision: Release 87

Stanimir.dimitrov: moved Accounts-account-email-domain-usernames-mailbox-autoresponder:PUT to Accounts-account-email-domain-usernames-mailboxName-autoresponder:PUT