Email

Get email statuses

Use this method to get details of the email with statuses such as injected, ok, softbounce, hardbounce, spambounce, deffered and dropped.

GEThttps://api.messageflow.com/v2.1/email

Query parameters

Response

200401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of EmailStatusObject (object)

Response

200401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "subject": "text",
      "smtpAccount": "1.test.smtp",
      "tags": [
        "text"
      ],
      "to": [
        {
          "email": "[e-mail]",
          "name": "Test sender",
          "messageId": "[e-mail]"
        }
      ],
      "from": {
        "email": "text",
        "name": "text"
      },
      "status": "text",
      "statusTime": 0,
      "statusDesc": "text",
      "allStatuses": [
        {
          "status": "text",
          "statusTime": 0,
          "statusDesc": "text"
        }
      ]
    }
  ]
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/email?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&messageId=SOME_STRING_VALUE&to=SOME_STRING_VALUE");
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?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&messageId=SOME_STRING_VALUE&to=SOME_STRING_VALUE"

	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?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&messageId=SOME_STRING_VALUE&to=SOME_STRING_VALUE")
  .header("authorization", "REPLACE_KEY_VALUE")
  .asString();

Node

var request = require("request");

var options = {
  method: 'GET',
  url: 'https://api.messageflow.com/v2.1/email',
  qs: {
    offset: 'SOME_INTEGER_VALUE',
    limit: 'SOME_INTEGER_VALUE',
    smtpAccount: 'SOME_STRING_VALUE',
    messageId: 'SOME_STRING_VALUE',
    to: 'SOME_STRING_VALUE'
  },
  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?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&messageId=SOME_STRING_VALUE&to=SOME_STRING_VALUE",
  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"

querystring = {"offset":"SOME_INTEGER_VALUE","limit":"SOME_INTEGER_VALUE","smtpAccount":"SOME_STRING_VALUE","messageId":"SOME_STRING_VALUE","to":"SOME_STRING_VALUE"}

headers = {'authorization': 'REPLACE_KEY_VALUE'}

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

print(response.text)

Ruby

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

url = URI("https://api.messageflow.com/v2.1/email?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&messageId=SOME_STRING_VALUE&to=SOME_STRING_VALUE")

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?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&smtpAccount=SOME_STRING_VALUE&messageId=SOME_STRING_VALUE&to=SOME_STRING_VALUE' \
  authorization:REPLACE_KEY_VALUEuthorization: REPLACE_KEY_VALUE'

Send emails

Send new email through transactional API which means that you can send email to a single email address or an array of email addresses. You can send the message to a maximum of 200 recipients. The entire query should not exceed 10 MB, and should not exceed 10 000 elements. If you want to send email to a group created through Create group method please use Send email campaign.

POSThttps://api.messageflow.com/v2.1/email

Body

application/json

subjectstring

The subject of the message.

Example: "Test email subject"

smtpAccountstring

The smtp account name the email will be sent from.

Example: "1.test.smtp"

tagsarray of string

The values to tag the message with. Tags can be non-unique.

contentobject

The body of the message. If you choose templateId html and text can be omitted.

bccarray of object

The array of recipients who will receive a blind carbon copy of your email.

ccarray of object

The array of recipients who will receive a copy of your email.

fromobject

The details of sender.

replyToobject

The details of who the recipient can reply to.

headersobject

The extra key/value pair of the headers you can add to the message. Property name can contain max of 100 signs.

toarray of object

The details of the recipients.

attachmentsarray of object

The details of the attachments. The entire query should not exceed 10 MB.

Response

200207401404500

Request was successfully processed

Body

application/json

metaMetaObject (object)

Additional data

dataarray of EmailStatusObject (object)

Response

200207401404500

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "subject": "text",
      "smtpAccount": "1.test.smtp",
      "tags": [
        "text"
      ],
      "to": [
        {
          "email": "[e-mail]",
          "name": "Test sender",
          "messageId": "[e-mail]"
        }
      ],
      "from": {
        "email": "text",
        "name": "text"
      },
      "status": "text",
      "statusTime": 0,
      "statusDesc": "text",
      "allStatuses": [
        {
          "status": "text",
          "statusTime": 0,
          "statusDesc": "text"
        }
      ]
    }
  ]
}

C#

var client = new RestClient("https://api.messageflow.com/v2.1/email");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"subject\":\"Test email subject\",\"smtpAccount\":\"1.test.smtp\",\"tags\":[\"test-tag\"],\"content\":{\"html\":\"<h1>Hello world</h1>\",\"text\":\"Hello world\",\"templateId\":\"as2sCwq\"},\"bcc\":[{\"email\":\"string\",\"name\":\"string\"}],\"cc\":[{\"email\":\"string\",\"name\":\"string\"}],\"from\":{\"email\":\"string\",\"name\":\"string\"},\"replyTo\":{\"email\":\"string\",\"name\":\"string\"},\"headers\":{\"X-TEST-HEADER\":\"val\"},\"to\":[{\"email\":\"[e-mail]\",\"name\":\"Test sender\",\"messageId\":\"[e-mail]\",\"vars\":{\"test-var\":\"var-value\"}}],\"attachments\":[{\"fileName\":\"report.txt\",\"fileMime\":\"text/plain\",\"fileContent\":\"c29tZSBmaWxlIGNvbnRlbnQ=\"}]}", 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"

	payload := strings.NewReader("{\"subject\":\"Test email subject\",\"smtpAccount\":\"1.test.smtp\",\"tags\":[\"test-tag\"],\"content\":{\"html\":\"<h1>Hello world</h1>\",\"text\":\"Hello world\",\"templateId\":\"as2sCwq\"},\"bcc\":[{\"email\":\"string\",\"name\":\"string\"}],\"cc\":[{\"email\":\"string\",\"name\":\"string\"}],\"from\":{\"email\":\"string\",\"name\":\"string\"},\"replyTo\":{\"email\":\"string\",\"name\":\"string\"},\"headers\":{\"X-TEST-HEADER\":\"val\"},\"to\":[{\"email\":\"[e-mail]\",\"name\":\"Test sender\",\"messageId\":\"[e-mail]\",\"vars\":{\"test-var\":\"var-value\"}}],\"attachments\":[{\"fileName\":\"report.txt\",\"fileMime\":\"text/plain\",\"fileContent\":\"c29tZSBmaWxlIGNvbnRlbnQ=\"}]}")

	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")
  .header("content-type", "application/json")
  .header("authorization", "REPLACE_KEY_VALUE")
  .body("{\"subject\":\"Test email subject\",\"smtpAccount\":\"1.test.smtp\",\"tags\":[\"test-tag\"],\"content\":{\"html\":\"<h1>Hello world</h1>\",\"text\":\"Hello world\",\"templateId\":\"as2sCwq\"},\"bcc\":[{\"email\":\"string\",\"name\":\"string\"}],\"cc\":[{\"email\":\"string\",\"name\":\"string\"}],\"from\":{\"email\":\"string\",\"name\":\"string\"},\"replyTo\":{\"email\":\"string\",\"name\":\"string\"},\"headers\":{\"X-TEST-HEADER\":\"val\"},\"to\":[{\"email\":\"[e-mail]\",\"name\":\"Test sender\",\"messageId\":\"[e-mail]\",\"vars\":{\"test-var\":\"var-value\"}}],\"attachments\":[{\"fileName\":\"report.txt\",\"fileMime\":\"text/plain\",\"fileContent\":\"c29tZSBmaWxlIGNvbnRlbnQ=\"}]}")
  .asString();

Node

var request = require("request");

var options = {
  method: 'POST',
  url: 'https://api.messageflow.com/v2.1/email',
  headers: {'content-type': 'application/json', authorization: 'REPLACE_KEY_VALUE'},
  body: {
    subject: 'Test email subject',
    smtpAccount: '1.test.smtp',
    tags: ['test-tag'],
    content: {html: '<h1>Hello world</h1>', text: 'Hello world', templateId: 'as2sCwq'},
    bcc: [{email: 'string', name: 'string'}],
    cc: [{email: 'string', name: 'string'}],
    from: {email: 'string', name: 'string'},
    replyTo: {email: 'string', name: 'string'},
    headers: {'X-TEST-HEADER': 'val'},
    to: [
      {
        email: '[e-mail]',
        name: 'Test sender',
        messageId: '[e-mail]',
        vars: {'test-var': 'var-value'}
      }
    ],
    attachments: [
      {
        fileName: 'report.txt',
        fileMime: 'text/plain',
        fileContent: 'c29tZSBmaWxlIGNvbnRlbnQ='
      }
    ]
  },
  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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"subject\":\"Test email subject\",\"smtpAccount\":\"1.test.smtp\",\"tags\":[\"test-tag\"],\"content\":{\"html\":\"<h1>Hello world</h1>\",\"text\":\"Hello world\",\"templateId\":\"as2sCwq\"},\"bcc\":[{\"email\":\"string\",\"name\":\"string\"}],\"cc\":[{\"email\":\"string\",\"name\":\"string\"}],\"from\":{\"email\":\"string\",\"name\":\"string\"},\"replyTo\":{\"email\":\"string\",\"name\":\"string\"},\"headers\":{\"X-TEST-HEADER\":\"val\"},\"to\":[{\"email\":\"[e-mail]\",\"name\":\"Test sender\",\"messageId\":\"[e-mail]\",\"vars\":{\"test-var\":\"var-value\"}}],\"attachments\":[{\"fileName\":\"report.txt\",\"fileMime\":\"text/plain\",\"fileContent\":\"c29tZSBmaWxlIGNvbnRlbnQ=\"}]}",
  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"

payload = "{\"subject\":\"Test email subject\",\"smtpAccount\":\"1.test.smtp\",\"tags\":[\"test-tag\"],\"content\":{\"html\":\"<h1>Hello world</h1>\",\"text\":\"Hello world\",\"templateId\":\"as2sCwq\"},\"bcc\":[{\"email\":\"string\",\"name\":\"string\"}],\"cc\":[{\"email\":\"string\",\"name\":\"string\"}],\"from\":{\"email\":\"string\",\"name\":\"string\"},\"replyTo\":{\"email\":\"string\",\"name\":\"string\"},\"headers\":{\"X-TEST-HEADER\":\"val\"},\"to\":[{\"email\":\"[e-mail]\",\"name\":\"Test sender\",\"messageId\":\"[e-mail]\",\"vars\":{\"test-var\":\"var-value\"}}],\"attachments\":[{\"fileName\":\"report.txt\",\"fileMime\":\"text/plain\",\"fileContent\":\"c29tZSBmaWxlIGNvbnRlbnQ=\"}]}"
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")

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 = "{\"subject\":\"Test email subject\",\"smtpAccount\":\"1.test.smtp\",\"tags\":[\"test-tag\"],\"content\":{\"html\":\"<h1>Hello world</h1>\",\"text\":\"Hello world\",\"templateId\":\"as2sCwq\"},\"bcc\":[{\"email\":\"string\",\"name\":\"string\"}],\"cc\":[{\"email\":\"string\",\"name\":\"string\"}],\"from\":{\"email\":\"string\",\"name\":\"string\"},\"replyTo\":{\"email\":\"string\",\"name\":\"string\"},\"headers\":{\"X-TEST-HEADER\":\"val\"},\"to\":[{\"email\":\"[e-mail]\",\"name\":\"Test sender\",\"messageId\":\"[e-mail]\",\"vars\":{\"test-var\":\"var-value\"}}],\"attachments\":[{\"fileName\":\"report.txt\",\"fileMime\":\"text/plain\",\"fileContent\":\"c29tZSBmaWxlIGNvbnRlbnQ=\"}]}"

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

Shell

echo '{"subject":"Test email subject","smtpAccount":"1.test.smtp","tags":["test-tag"],"content":{"html":"<h1>Hello world</h1>","text":"Hello world","templateId":"as2sCwq"},"bcc":[{"email":"string","name":"string"}],"cc":[{"email":"string","name":"string"}],"from":{"email":"string","name":"string"},"replyTo":{"email":"string","name":"string"},"headers":{"X-TEST-HEADER":"val"},"to":[{"email":"[e-mail]","name":"Test sender","messageId":"[e-mail]","vars":{"test-var":"var-value"}}],"attachments":[{"fileName":"report.txt","fileMime":"text/plain","fileContent":"c29tZSBmaWxlIGNvbnRlbnQ="}]}' |  \
  http POST https://api.messageflow.com/v2.1/email \
  authorization:REPLACE_KEY_VALUE \
  content-type:application/jsonfileContent":"c29tZSBmaWxlIGNvbnRlbnQ="}]}'