POST Exchange Email Alias - Revision history

Mike.robski: 1 revision: Release 103

2015-02-06T17:24:36Z

1 revision: Release 103

Velimira.metodieva: /* Examples */

2014-07-15T14:28:38Z

Examples

Mike.robski: 1 revision: Release 95

2014-07-02T05:59:32Z

1 revision: Release 95

Mike.robski at 13:41, 20 May 2013

2013-05-20T13:41:44Z

New page

Create an Email Alias

'''POST''' <code>''{server_name}''/accounts/''{account_number}''/exchange/''{domain_name}''/emailAliases</code>

== Parameters ==
; account_number - ''string''
: The account-number that the Exchange resource belongs to

; domain_name - ''string''
: The domain-name that is associated with the Exchange resource

== Request Body ==
<nowiki>{
"emailalias" : {
"username": "john",
"emailForward": "johnjello@domainname.com"
}
}
</nowiki>

; username - ''''
: - Username of email address. Allowed are only letters, numbers, underscores, dashes and nonconsecutive dots. Dots cannot be at the beginning or the end of the value. From 1 to 52 characters long.

; emailForward - ''string''
: - Target email address. Must be a valid email address. The domain-name of the address must be the same as the domain-name associated with the Exchange resource.

=== Expected Response Codes ===
;201
: Created

;400
: External forward; Email forwarding to the same address; Validation error

;405
: Unsupported method

;409
: Username already exists

;502
: Internal server error

== Examples ==
'''POST {server_name}/accounts/account300021/exchange/ng-test-hwus-120120b.com/emailAliases'''

''- Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''- Request Body:''
<nowiki>{
"emailalias" : {
"username": "john",
"emailForward": "johnjello@ng-test-hwus-120120b.com"
}
}
</nowiki>

''- Response:''
''Created (201)'':
Server : nginx/0.6.32
Date : Fri, 01 Jun 2012 23:51:29 GMT
Connection : keep-alive
Location : http://coreapi01.ote.chicago.hostway:8098/accounts/popescu300021/exchange/ng-test-hwus-petre-120120b.com/emailAliases /john/
Content-Length : 0

*There will be a Location in the response header pointing to the newly created resource.

----

''- Request Body with Invalid data:''
<nowiki>{
"emailalias": {
"username": "new_alias",
"emailForward": "new_alias@ng-test-hwus-petre-120120b.com"
}
}
</nowiki>

''- Response:''
''BadRequest (400)'':
<nowiki>{
"computeFault": {
"message": "Email forwarding to the same address is not allowed",
"code": 400, "details": ""
}
}
</nowiki>

[[Category:Hostway API]]
[[Category:Exchange API]]

@@ Line 20: / Line 20: @@
-; username - ''''
+; username - ''string''
 : - Username of email address. Allowed are only letters, numbers, underscores, dashes and nonconsecutive dots.  Dots cannot be at the beginning or the end of the value. From 1 to 52 characters long.
@@ Line 64: / Line 64: @@
   Date : Fri, 01 Jun 2012 23:51:29 GMT
   Connection : keep-alive
-  Location : http://coreapi01.ote.chicago.hostway:8098/accounts/popescu300021/exchange/ng-test-hwus-petre-120120b.com/emailAliases /john/
+  Location : http://coreapi01.ote.chicago.hostway:8098/accounts/popescu300021/exchange/ng-test-hwus-petre-120120b.com/emailAliases/john/
   Content-Length : 0