NewsMAN API: transactional.messageSendRaw

Sections

KB Newsman

HomeAPITransactionaltransactional.messageSendRaw

Newsman Api Method: transactional.messageSendRaw

Prototype: transactional.messageSendRaw(list_id, mime_message, recipients, account_id)

Description: Sends a mail message over http API. The SMTP account will be chosen based on the from address of the list or a specific account may be sent.

HTTP method: POST

Endpoint HTTP: /transactional.messageSendRaw.json

Endpoint XML-RPC: transactional.messageSendRaw

Return type: array

Return info: Array containing a list of dict items (email, status, reason, send_id) for each recipient

Request parameters POST

Variable	Type	Description
list_id	int\|string	The ID of the list from which to identify the SMTP account
mime_message	array\|struct	The mime encoded message
recipients	array\|struct	Array containing the message recipients. Each item must be an array with the following keys: email (required) name (optional, may be empty string) params (optional - key / value array with props)
account_id	string\|boolean	The id of a specific SMTP ACCOUNT through which to send (optional).

Response parameters

Parameter	Description
array	array containing a list of dict items (email, status, reason, send_id) for each recipient

// https://github.com/Newsman/newsman-api-php

<?php
 
require_once("Newsman/Client.php");
 
// you can get your API KEY, your newsman_user_id and list_id from My account -> API
$newsman_user_id = "your-user-id";
$api_key = "your-api-key";
 
$list_id = "your-list-id";
 
$mime_message = "Date: Thu, 13 Sep 2018 10:39:49 +0300\r\nFrom: Acme Company <acme@example.com>\r\nReply-To: Acme Company <acme@example.com>\r\nOrganization: Acme Company\r\nMessage-ID: <1547610873.20180913103949@example.com>\r\nTo: recipient@example.com\r\nSubject: hi there - test message\r\nMIME-Version: 1.0\r\nContent-Type: multipart\/alternative;\r\n boundary=\"----------0BD00325510B473B0\"\r\n\r\n------------0BD00325510B473B0\r\nContent-Type: text\/plain; charset=iso-8859-15\r\nContent-Transfer-Encoding: quoted-printable\r\n\r\nThis is an amazing test.\r\n\r\n--=20\r\nAcme Company\r\nhttps:\/\/www.example.com\r\n------------0BD00325510B473B0\r\nContent-Type: text\/html; charset=iso-8859-15\r\nContent-Transfer-Encoding: quoted-printable\r\n\r\n<html><head><title>hi there - test message<\/title>\r\n<\/head>\r\n<body>\r\n<span style=3D\" font-family:'courier new'; font-size: 9pt;\"><b>This<\/b>&nbs=\r\np;is an amazing test.<br>\r\n<br>\r\n<span style=3D\" font-family:'arial'; color: #c0c0c0;\"><i>--<br>\r\nAcme Company\r\n<\/i><\/span><\/span><a style=3D\" font-family:'arial'; font-size: 9pt;\" href=\r\n=3D\"http:\/\/www.newsman.ro\">https:\/\/www.example.com<\/a><br>\r\n<a style=3D\" font-family:'arial'; font-size: 9pt;\" href=3D\"http:\/\/www.examp=\r\nle.com\">https:\/\/www.example.com<\/a><\/body><\/html>\r\n------------0BD00325510B473B0--";
 
$recipients = array(
      array( "email" => "recipient-1@company.com", "name" => "Recipient 1", "params" => array("name" => "Johnny")  ),
      array( "email" => "recipient-2@company.com", "name" => "Recipient 2", "params" => array("name" => "Mark") )
);
 
try {
	$client = new Newsman_Client($newsman_user_id, $api_key);
	$ret = $client->transactional->messageSendRaw($list_id, $mime_message, $recipients);
} catch (Exception $e) {
	//do something with the error, eg: log $e->getMessage()
}
 
return $ret;
 
?>

// https://github.com/Newsman/newsman-api-dotnet

RESTClient client = new RESTClient("your_user_id", "your_api_key");
 
var _params = new NameValueCollection();
    _params["list_id"] = "your-list-id";
 
    _params["recipients[0][email]"] = "recipient-1@company.com";
    _params["recipients[0][name]"] = "Recipient 1";
    _params["recipients[0][params][name]"] = "Johnny";
    _params["recipients[1][email]"] = "recipient-2@company.com";
    _params["recipients[1][name]"] = "Recipient 2";
    _params["recipients[1][params][name]"] = "Mark";        
 
    _params["mime_message"] = "Date: Thu, 13 Sep 2018 10:39:49 +0300\r\nFrom: Acme Company <acme@example.com>\r\nReply-To: Acme Company <acme@example.com>\r\nOrganization: Acme Company\r\nMessage-ID: <1547610873.20180913103949@example.com>\r\nTo: recipient@example.com\r\nSubject: hi there - test message\r\nMIME-Version: 1.0\r\nContent-Type: multipart\/alternative;\r\n boundary=\"----------0BD00325510B473B0\"\r\n\r\n------------0BD00325510B473B0\r\nContent-Type: text\/plain; charset=iso-8859-15\r\nContent-Transfer-Encoding: quoted-printable\r\n\r\nThis is an amazing test.\r\n\r\n--=20\r\nAcme Company\r\nhttps:\/\/www.example.com\r\n------------0BD00325510B473B0\r\nContent-Type: text\/html; charset=iso-8859-15\r\nContent-Transfer-Encoding: quoted-printable\r\n\r\n<html><head><title>hi there - test message<\/title>\r\n<\/head>\r\n<body>\r\n<span style=3D\" font-family:'courier new'; font-size: 9pt;\"><b>This<\/b>&nbs=\r\np;is an amazing test.<br>\r\n<br>\r\n<span style=3D\" font-family:'arial'; color: #c0c0c0;\"><i>--<br>\r\nAcme Company\r\n<\/i><\/span><\/span><a style=3D\" font-family:'arial'; font-size: 9pt;\" href=\r\n=3D\"http:\/\/www.newsman.ro\">https:\/\/www.example.com<\/a><br>\r\n<a style=3D\" font-family:'arial'; font-size: 9pt;\" href=3D\"http:\/\/www.examp=\r\nle.com\">https:\/\/www.example.com<\/a><\/body><\/html>\r\n------------0BD00325510B473B0--";    
 
var response = client.CallMethod("transactional", "messageSendRaw", _params);

Output example

[
    {
        "send_id": "xxxxx-xxxxx-xxxxx-xxxxx",
        "status": "queued",
        "reason": "",
        "email": "john@example.com"
    }
]

Response Errors

Code	Message	Description
407	Missing required param list_id	list_id param is required
407	Missing required param mime_message	mime_message param is required
407	Missing required param recipients	recipients param is required
101	Not allowed for list_id = %s	Invalid access to list_id
17001	Invalid mime_message	mime_message param value is invalid
17002	Invalid recipients	Recipients param value is invalid
17003	Could not find the SMTP account	Transactional account not found
17004	The SMTP account is inactive	The transactional account is inactive
17005	Could not send message: error_reason	Could not send message

Error examples

{
    "err": true,
    "message": "Missing required param list_id",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param mime_message",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param recipients",
    "code": 407
}

{
    "err": true,
    "message": "Invalid message",
    "code": 17001
}

{
    "err": true,
    "message": "Invalid recipients",
    "code": 17002
}

{
    "err": true,
    "message": "Could not find the SMTP account",
    "code": 17003
}

{
    "err": true,
    "message": "The SMTP account is inactive",
    "code": 17004
}

{
    "err": true,
    "message": "Could not send message: Request error",
    "code": 17005
}