Email

Get email statuses

get

Use this method to get details of the email with statuses such as injected, ok, softbounce, hardbounce, spambounce, deffered and dropped. By default, you can only access data from the last week

Authorizations

APIKeyHeaderAPPKeyHeader

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

messageIdstringoptional

The unique ID of the message.

Example: [e-mail]

tostringoptional

The email address the email was sent to.

Example: [e-mail]

dateFromstringoptional

Search with date. The farthest date is specified by the TTL of your account (which is 1 week by default).

dateTostringoptional

Search with date.

Responses

application/json

objectoptional

application/json

application/json

application/json

get

CsharpGoJavaNodePhpPythonRubyShell

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?offset=0&limit=100&smtpAccount=1.test.smtp&messageId=[e-mail]&to=[e-mail]&dateFrom=<string>&dateTo=<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": [
    {
      "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": 1,
      "statusDesc": "text",
      "allStatuses": [
        {
          "status": "text",
          "statusTime": 1,
          "statusDesc": "text"
        }
      ]
    }
  ]
}

Send emails

post

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. Link tracking is enabled by default, you can disable it by adding a header {"X-TRACKING-OFF":1}

Authorizations

APIKeyHeaderAPPKeyHeader

Body

Object passed when sending emails.

subjectstringrequired

The subject of the message.

Example: Test email subject

smtpAccountstringrequired

The smtp account name the email will be sent from.

Example: 1.test.smtp

tagsstring[]optional

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

Example: test-tag

contentobjectrequired

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

bccobject[]optional

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

ccobject[]optional

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

fromobjectrequired

The details of sender.

replyToobjectoptional

The details of who the recipient can reply to.

headersobjectoptional

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

Example: {"X-TEST-HEADER":"val"}

globalVarsobjectoptional

The extra variables you can use in your e-mial template. You can find more information on how to use this feature in this section.

Example: {"sex":"unknown","hasNewsletter":false,"promos":{"1":{"name":"test40","value":300},"2":{"name":"test800","value":3008}},"footer":"<div><strong>crazy footer</strong></div>"}

toobject[]required

The details of the recipients.

attachmentsobject[]optional

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

Responses

application/json

objectoptional

application/json

application/json

application/json

application/json

post

CsharpGoJavaNodePhpPythonRubyShell

using System.Threading.Tasks;

internal class Program
{
    private static void Main(string[] args)
    {
        string requestBody = "{\"subject\":\"Test email subject\",\"smtpAccount\":\"1.test.smtp\",\"tags\":[\"test-tag\"],\"content\":[],\"bcc\":[[]],\"cc\":[[]],\"from\":[],\"replyTo\":[],\"headers\":{\"X-TEST-HEADER\":\"val\"},\"globalVars\":{\"sex\":\"unknown\",\"hasNewsletter\":false,\"promos\":{\"1\":{\"name\":\"test40\",\"value\":300},\"2\":{\"name\":\"test800\",\"value\":3008}},\"footer\":\"<div><strong>crazy footer<\\/strong><\\/div>\"},\"to\":[[]],\"attachments\":[[]]}";

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

            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": [
    {
      "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": 1,
      "statusDesc": "text",
      "allStatuses": [
        {
          "status": "text",
          "statusTime": 1,
          "statusDesc": "text"
        }
      ]
    }
  ]
}