Blacklist | Api reference MessageFlow

Api reference MessageFlow

Get blacklisted email addresses

get

Use this method to list all email addresses that are on your blacklist.

Authorizations

Query parameters

offsetintegeroptional

The number of items omitted from the beginning of the list. Default ‘0’.

Default: 0

limitinteger · max: 1000optional

The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.

Default: 100

smtpAccountstringoptional

The smtp account name.

Example: 1.test.smtp

Responses

application/json

objectoptional

application/json

get

using System.Threading.Tasks;

internal class Program
{
    private static void Main(string[] args)
    {
        string requestBody = "";

        try {
            using var client = new HttpClient{};
            using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.messageflow.com/v2.1/email/blacklist?offset=0&limit=100&smtpAccount=1.test.smtp");

            request.Headers.Add("Authorization", "YourAuthorizationKey");
            request.Headers.Add("Application-Key", "YourApplicationKey");
            request.Content = new StringContent(requestBody, null, "application/json");

            var response = await client.SendAsync(request);
            response.EnsureSuccessStatusCode();
            string content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);

        } catch (HttpRequestException e) {
            Console.WriteLine("\n Exception Caught!\n Message :{0} ", e.Message);
        }
    }
}

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "email": "text",
      "smtpAccount": "text",
      "reason": "text",
      "comment": "text",
      "counter": "text",
      "createdAt": 1,
      "updatedAt": 1
    }
  ]
}

Add emails to blacklist

post

Use this method to add email addresses to the blacklist. Each email address in the blacklist will be omitted in future transactional email sending.

Authorizations

Query parameters

emailstringrequired

The email address you want to add to the blacklist.

smtpAccountstringrequired

The name of your smtp account.

reasonstringrequired

The reason for adding the email address to the blacklist. Check all the available reason in List blacklist reasons method.

commentstringoptional

The additional information on the entry.

Responses

application/json

objectoptional

application/json

post

using System.Threading.Tasks;

internal class Program
{
    private static void Main(string[] args)
    {
        string requestBody = "";

        try {
            using var client = new HttpClient{};
            using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.messageflow.com/v2.1/email/blacklist?email=<string>&smtpAccount=<string>&reason=<string>&comment=<string>");

            request.Headers.Add("Authorization", "YourAuthorizationKey");
            request.Headers.Add("Application-Key", "YourApplicationKey");
            request.Content = new StringContent(requestBody, null, "application/json");

            var response = await client.SendAsync(request);
            response.EnsureSuccessStatusCode();
            string content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);

        } catch (HttpRequestException e) {
            Console.WriteLine("\n Exception Caught!\n Message :{0} ", e.Message);
        }
    }
}

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "email": "text",
      "smtpAccount": "text",
      "reason": "text",
      "comment": "text",
      "counter": "text",
      "createdAt": 1,
      "updatedAt": 1
    }
  ]
}

Delete email addresses from blacklist

delete

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

Authorizations

Path parameters

smtpstringrequired

The name of your smtp account.

Example: 1.test.smtp

Body

idstring[]optional

List of emails that should be deleted from blacklist

Example: mail@mail.com

Responses

application/json

objectoptional

application/json

delete

using System.Threading.Tasks;

internal class Program
{
    private static void Main(string[] args)
    {
        string requestBody = "{\"id\":[\"mail@mail.com\"]}";

        try {
            using var client = new HttpClient{};
            using var request = new HttpRequestMessage(HttpMethod.Delete, "https://api.messageflow.com/v2.1/email/blacklist/{smtp}");

            request.Headers.Add("Authorization", "YourAuthorizationKey");
            request.Headers.Add("Application-Key", "YourApplicationKey");
            request.Content = new StringContent(requestBody, null, "application/json");

            var response = await client.SendAsync(request);
            response.EnsureSuccessStatusCode();
            string content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);

        } catch (HttpRequestException e) {
            Console.WriteLine("\n Exception Caught!\n Message :{0} ", e.Message);
        }
    }
}

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