Blacklist

List blacklist reasons

This method allows you to get list of blacklist reasons. At this moment we have provided 4 reasons which are hardbounce, unsubscribe, spam_complaint and other. Run this method once in a while to check if there are new reasons added.

OPTIONShttps://api.messageflow.com/v2.1/email/blacklist/reason

Response

200401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of string

Request

var client = new RestClient("https://api.messageflow.com/v2.1/email/blacklist/reason");
var request = new RestRequest(Method.OPTIONS);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Response

{
  "meta": {
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    "text"
  ]
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Go

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.get("https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D")
  .header("authorization", "REPLACE_KEY_VALUE")
  .asString();

Node

var request = require("request");

var options = {
  method: 'GET',
  url: 'https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D',
  headers: {authorization: 'REPLACE_KEY_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D"

headers = {'authorization': 'REPLACE_KEY_VALUE'}

response = requests.request("GET", url, headers=headers)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'REPLACE_KEY_VALUE'

response = http.request(request)
puts response.read_body

Shell

http GET https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D \
  authorization:REPLACE_KEY_VALUEuthorization: REPLACE_KEY_VALUE'

Add domains to blacklist

Use this method to add domains to the blacklist. Each email address with blacklisted domain will be omitted in future transactional email sending.

POSThttps://api.messageflow.com/v2.1/email/domain/blacklist/{smtp}

Path parameters

smtp*string

The name of your smtp account

Body

application/json

domainany

string Domain

Response

200207401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

Request

var client = new RestClient("https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"domain\":null}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

{
  "meta": {
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  }
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"domain\":null}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Go

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D"

	payload := strings.NewReader("{\"domain\":null}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.post("https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D")
  .header("content-type", "application/json")
  .header("authorization", "REPLACE_KEY_VALUE")
  .body("{\"domain\":null}")
  .asString();

Node

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D',
  headers: {'content-type': 'application/json', authorization: 'REPLACE_KEY_VALUE'},
  body: {domain: null},
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"domain\":null}",
  CURLOPT_HTTPHEADER => array(
    "authorization: REPLACE_KEY_VALUE",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D"

payload = "{\"domain\":null}"
headers = {
    'content-type': "application/json",
    'authorization': "REPLACE_KEY_VALUE"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'REPLACE_KEY_VALUE'
request.body = "{\"domain\":null}"

response = http.request(request)
puts response.read_body

Shell

echo '{"domain":null}' |  \
  http POST https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D \
  authorization:REPLACE_KEY_VALUE \
  content-type:application/jsonlication/json' \
  --data '{"domain":null}'

Delete domains from blacklist

Use this method to delete domains from the blacklist so addresses email with such domain won’t be omitted in the future transactional email sending.

DELETEhttps://api.messageflow.com/v2.1/email/domain/blacklist/{smtp}

Path parameters

smtp*string

SMTP account

Body

application/json

idarray of string

List of domains that should be deleted from blacklist

Response

200207401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

Request

var client = new RestClient("https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D");
var request = new RestRequest(Method.DELETE);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"id\":[\"domain.com\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Response

{
  "meta": {
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  }
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D");
var request = new RestRequest(Method.DELETE);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddHeader("application-key", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"id\":[\"domain.com\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Go

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D"

	payload := strings.NewReader("{\"id\":[\"domain.com\"]}")

	req, _ := http.NewRequest("DELETE", url, payload)

	req.Header.Add("content-type", "application/json")
	req.Header.Add("authorization", "REPLACE_KEY_VALUE")
	req.Header.Add("application-key", "REPLACE_KEY_VALUE")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.delete("https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D")
  .header("content-type", "application/json")
  .header("authorization", "REPLACE_KEY_VALUE")
  .header("application-key", "REPLACE_KEY_VALUE")
  .body("{\"id\":[\"domain.com\"]}")
  .asString();

Node

var request = require("request");

var options = {
  method: 'DELETE',
  url: 'https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D',
  headers: {
    'content-type': 'application/json',
    authorization: 'REPLACE_KEY_VALUE',
    'application-key': 'REPLACE_KEY_VALUE'
  },
  body: {id: ['domain.com']},
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => "{\"id\":[\"domain.com\"]}",
  CURLOPT_HTTPHEADER => array(
    "application-key: REPLACE_KEY_VALUE",
    "authorization: REPLACE_KEY_VALUE",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D"

payload = "{\"id\":[\"domain.com\"]}"
headers = {
    'content-type': "application/json",
    'authorization': "REPLACE_KEY_VALUE",
    'application-key': "REPLACE_KEY_VALUE"
    }

response = requests.request("DELETE", url, data=payload, headers=headers)

print(response.text)

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Delete.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'REPLACE_KEY_VALUE'
request["application-key"] = 'REPLACE_KEY_VALUE'
request.body = "{\"id\":[\"domain.com\"]}"

response = http.request(request)
puts response.read_body

Shell

echo '{"id":["domain.com"]}' |  \
  http DELETE https://api.messageflow.com/v2.1/email/domain/blacklist/%7Bsmtp%7D \
  application-key:REPLACE_KEY_VALUE \
  authorization:REPLACE_KEY_VALUE \
  content-type:application/jsone: application/json' \
  --data '{"id":["domain.com"]}'