Create domain mail forward

Description

POST https://api.netim.com/rest/1.0/domain/{mailbox}/mail-forwarding/

Create an email forward.

• 
  Parameters
• 
  Responses

URL Parameters

• {mailbox}
  Email address (* for catch-all).

Headers

• Authorization
  string

  The Autorization header must start with « Bearer  » followed by the session ID.
  Example: »Autorization: Bearer b0f13a3c01d9cce2a9a44cd729f81c26″

• Content-type
  string

  Content type of the request

  Only « application/json » is accepted

Body

REQUIRED

• recipients
  string
  (500)

  List of email addresses (separated by commas).

  Only one email address is accepted when using catchall.

JSON example

{
    "recipients":"contact@netim.fr,example@gmail.com",
}

• 200OK
  The request is processed and the result is returned in the body.

  Body

  Objectapplication/json

  An object of type StructOperationResponse

• 4XX

  Learn more about the possible error codes

Common language examples

• 
  PHP
• 
  JAVA
• 
  PYTHON
• 
  SHELL / CURL

<?php
 
	$ch = curl_init();
 
	$body = array(
		"recipients" => "contact@netim.fr,example@gmail.com",
	);
 
	curl_setopt($ch, CURLOPT_URL,"https://api.netim.com/rest/1.0/domain/$mailbox/mail-forwarding/");
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
	curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer $sessionID", "Content-type: application/json"]);
	curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
	curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
 
	$result = json_decode(curl_exec ($ch), true);
	$status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
	curl_close ($ch);
 

import java.util.Base64;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
public class Example {
 
	public static void main(String args[]) throws Exception {
		String sessionID = "12345678";
		String mailbox = "admin@example.com";
 
		String body = "{"recipients":"contact@netim.fr,example@gmail.com",}";
 
		HttpClient client = HttpClient.newHttpClient();
		HttpRequest request = HttpRequest.newBuilder()
			.uri(URI.create("https://api.netim.com/rest/1.0/domain/" + mailbox + "/mail-forwarding/"))
			.method("POST", HttpRequest.BodyPublishers.ofString(body))
			.header("Content-Type", "application/json")
			.header("Accept-Language", "EN")
			.header("Authorization", "Bearer " + sessionID)
			.build();
		HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
 
		String result = response.body().toString();
	}
}

#!/usr/bin/python3
 
import json
import requests
 
mailbox = 'admin@example.com'
 
url = 'https://api.netim.com/rest/1.0/domain/' + mailbox + '/mail-forwarding/'
 
sessionId = "1234567"
 
data = {
	"recipients":"contact@netim.fr,example@gmail.com",
}
 
headers = {"Authorization": "Bearer " + sessionId, "Content-Type": "application/json"}
 
 
response = requests.post(url, headers=headers, data=json.dumps(data))

curl -X POST https://api.netim.com/rest/1.0/domain/admin@example.com/mail-forwarding/ 
-H 'Authorization: Bearer b0f13a3c01d9cce2a9a44cd729f81c26=' 
-H 'Content-type: application/json' 
-d '{"recipients":"contact@netim.fr,example@gmail.com",}'

Need an API Client?
Speed up your integration by using our API client for SOAP