Accounts-account-email-domain-usernames-mailboxName-forwards:POST - Revision history

Mike.robski: 1 revision: Release 98

2014-09-15T13:53:38Z

1 revision: Release 98

Mike.robski: 1 revision: Release 97

2014-08-20T17:50:38Z

1 revision: Release 97

Jerry.dimitrov: /* Status Code */

2014-08-20T17:08:32Z

Status Code

Dinh.anh: /* Failure when creating forwarding to the same mailbox (avoids forwarding loops) */

2014-08-14T16:20:28Z

Failure when creating forwarding to the same mailbox (avoids forwarding loops)

Mike.robski: 1 revision: Release 96

2014-07-31T14:44:55Z

1 revision: Release 96

Mike.robski: 1 revision: Release 95

2014-07-02T05:58:44Z

1 revision: Release 95

Stanimir.dimitrov: /* Creating local forwarding or distribution list that contains mailboxes in the source domain */

2014-06-27T09:27:45Z

Creating local forwarding or distribution list that contains mailboxes in the source domain

Bozhidar.mihaylov at 15:30, 24 June 2014

2014-06-24T15:30:53Z

Mike.robski: 1 revision: Release 87

2013-11-15T21:24:11Z

1 revision: Release 87

Ivailo.shankov at 13:50, 6 November 2013

2013-11-06T13:50:40Z

New page

= POST accounts/{account}/email/{domain}/usernames/{mailbox}/forwards =
Sets forwarding for specified mailbox,domain and account.

__TOC__

== Request ==
<code>POST accounts/{account}/email/{domain}/usernames/{mailbox}/forwards</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>
{
"targets": [
{"target": "{target-email}"},
{"target": "{target-email1}"},
]
}
</nowiki>

==== Parameters ====
; targets - ''list''
: List of target objects.

; target - ''string''
: The target mailbox to forward to.

== 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 forwarding with missing required parameter ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{empty request body}
</nowiki>

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

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

=== Failure setting forwarding by not providing target ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{"targets":[]}
</nowiki>

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

{"targets": "Shorter than minimum length 1"}
</nowiki>

=== Success setting forwarding ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{
"targets": [
{"target": "test-fwd@test.com"}
]
}
</nowiki>

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

=== Success setting forwards ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/usernames/test/forwards

{
"targets": [
{"target": "test-fwd@test.com"},
{"target": "test-fwd1@test.com"}
]
}
</nowiki>

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

== See also ==
* [[Email API|Email API]]

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

@@ Line 56: / Line 56: @@
 ; 409 Conflict
-: The request parameters creates resource conflict.
+: Create of the forwarder would produce an impossible to delivery loops namely:
 == Examples ==

@@ Line 56: / Line 56: @@
 ; 409 Conflict
-: Create of the forwarder would produce an impossible to delivery loops namely:
+: The request parameters creates resource conflict.
-:# the usernames on the forward source and target are the same, '''and''':
-:## the domains on the source is an alias of the target's domain name, '''or'''
-:## the domains on the target is an alias of the source's domain name
 == Examples ==

← Older revision	Revision as of 17:50, 20 August 2014
(One intermediate revision by one user not shown)

@@ Line 54: / Line 54: @@
 ; 404 Not Found
 : The domain name does not exist.
 == Examples ==
-=== Failure setting forwarding with missing required parameter ===
+=== Failure when creating a forwarding with missing required parameter ===
 '''Request'''
   <nowiki>
@@ Line 72: / Line 78: @@
   </nowiki>
+=== Failure when creating a forwarding with an empty list of targets ===
-=== Failure setting forwarding by not providing target ===
 '''Request'''
   <nowiki>
@@ Line 88: / Line 93: @@
   </nowiki>
-=== Success setting forwarding ===
+=== Success when creating a forwarding ===
 '''Request'''
   <nowiki>
@@ Line 95: / Line 100: @@
+{
      "targets": [
-         {"target": "test-fwd@test.com"}
+         {"target": "test-fwd@example.com"}
+     ]
+}
@@ Line 105: / Line 110: @@
 </nowiki>
+=== Success setting multiple forwarding targets (distribution list) ===
-=== Success setting forwards ===
 '''Request'''
   <nowiki>
@@ Line 114: / Line 118: @@
      "targets": [
          {"target": "test-fwd@test.com"},
-         {"target": "test-fwd1@test.com"}
+         {"target": "test-fwd1@example.com"}
+     ]
+}
@@ Line 124: / Line 128: @@
 </nowiki>
-=== Setting forwarding with local storage ===
+=== Creating local forwarding or distribution list that contains mailboxes in the source domain ===
-In order to have local storage for forwarding, target mailboxes have to be in the same local domain as the source mailbox.<br>
+Local forwarding is created when some or all of the target mailboxes are in the same domain as the source mailbox. In case there are such mailboxes certain validation rules are applied that verify the target mailbox existence and that the target mailbox is different than the source.<br/>
-So the previous two examples of successful setup of forwarding are showing how to setup forwarding with local storage for respectively one and multiple target mailboxes.
+It is important to note that '''none''' of the targets will be created if the validation fails for '''any''' of the mailboxes in the list.<br/>
-=== Failure setting forwarding to a single mailbox with local storage by setting the source address as the target address ===
+That is: a single non-existent local target mailbox in the list will prevent all of the targets from being added regardless of the invalid target position in the list.
 '''Request'''
   <nowiki>
@@ Line 134: / Line 140: @@
+{
      "targets": [
-         {"target": "source-account@test.com"}
+         {"target": "test@test.com"}
+     ]
+}
@@ Line 143: / Line 149: @@
 Bad Request
-{"source-account@test.com": "Is the same as current mailbox"}
+{"test@test.com": "Is the same as current mailbox"}
 </nowiki>
-=== Failure setting forwarding to a single mailbox with local storage by providing a non-existing target ===
+=== Failure when creating local forwarding to non-existing mailbox ===
 '''Request'''
   <nowiki>
@@ Line 165: / Line 196: @@
 </nowiki>
-=== Failure setting forwarding to multiple mailboxes with local storage by providing a non-existing target ===
+=== Failure when creating a distribution list with a missing local target mailbox ===
-It is important to know that either '''all or none''' of the targets will be set-up for forwarding.<br>
-That is: a single non-existant mailbox in the targets list will prevent all of the targets from being added irrespective of it's position in the targets list.
   <nowiki>
 POST accounts/{account}/email/test.com/usernames/test/forwards
@@ Line 186: / Line 215: @@
 </nowiki>
-=== Success setting forwarding to a single mailbox without local storage ===
+=== Success creating forwarding to an external mailbox ===
-Notice the '''different_domain''' in the request.<br>
+Notice the '''different_domain.com''' in the request is external (different than '''test.com''').<br>
 '''Request'''
   <nowiki>
@@ Line 194: / Line 223: @@
+{
      "targets": [
-         {"target": "test-fwd@different_domain.com"}
+         {"target": "test-fwd@different-domain.com"}
+     ]
+}
@@ Line 204: / Line 233: @@
 </nowiki>
-=== Success setting forwarding to multiple mailboxes without local storage ===
+=== Success creating forwarding to multiple external mailboxes (distribution list) ===
 '''Request'''<br>
-Notice that '''different_domain_1.com''' and '''different_domain_2.com''' are both not test.com.
+Notice that '''different_domain_1.com''' and '''different_domain_2.com''' are both different than '''test.com'''.
   <nowiki>
 POST accounts/{account}/email/test.com/usernames/test/forwards
@@ Line 212: / Line 241: @@
+{
      "targets": [
-         {"target": "test-fwd@different_domain_1.com"},
+         {"target": "test-fwd@different-domain_1.com"},
-         {"target": "test-fwd1@different_domain_2.com"}
+         {"target": "test-fwd1@different-domain_2.com"}
+     ]
+}

← Older revision	Revision as of 05:58, 2 July 2014
(One intermediate revision by one user not shown)