Messages Calls

Email API API Books Getting Started

Messages Calls

Info! Do you have any questions on our Email API? Write to us at[email protected]

/messages/sendMail

Send a new transactional message through PowerEmail


Example Call

<?php

$recipients = array(
array(
'email' => '[email protected]',
'name' => 'Recipient1 Name'
),
array(
'email' => '[email protected]',
'name' => 'Recipient2 Name'
),
try {
require_once'PowerEmailMTA_PHP/PowerEmail.php';
$PowerEmail= new PowerEmail('owner_id', 'token', 'PowerEmailTES_APP_DOMAIN');
$smtp_user_name = "smtp12345",
foreach ($recipients as $recipient) {
$message = array();
$message["html"] = "Example HTML content";
$message["text"] = "Example text content";
$message["subject"] = "example subject";
$message["from_email"] = "[email protected]";
$message["to"] = array(
array("email" = $recipient['email'], "name" => $recipient['email'], "type" => "to")
),
$message["headers"] = array("Reply-To" => "[email protected]","X-Unique-Id" => "Id");
$message["attachments"] = array(array("type" => "text/plain","name" => "myfile.txt","content" => "ZXhhbXBsZSBmaWxl"));
$message["images"] = array(array("type" => "image/png", "name" => "IMAGECID","content" => "dgfdddger"));

$result = $PowerEmail->messages->sendMail($smtp_user_name, $message);

print_r($result);
/*
Array
(
[status] => "success"
[message] => "message have been Queued ... "
)
*/
}
} catch (PowerEmail_Error $e) {
# PowerEmailerrors are thrown as exceptions
echo "A PowerEmailerror occurred " . get_class($e) . " - " . $e->getMessage();
?>


Example Success Response

Array
(
[status] => "success"
[message] => "message have been Queued ... "
)


Example Error Response

Array
(
[status] => "error",
[code] => "-1",
[name] => "AuthenticationError",
[message] => Token MissMatch,
)


Parameters
owner_id* string a valid PowerEmailUser Id
token* string a valid token
PowerEmailTES_APP_DOMAIN* string a valid PowerEmailTES APP DOMAIN
smtp_user_name* string a valid smtp user name

* compulsory field

** Either 'html' field Or 'text' field compulsory

Return Value: Success
struct the results of sending mail
status string always success
message string human readable message
Return Value: Error
struct the error results when attempt to List Tracking Domain
statusstring error
messagestring human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. PowerEmailDevelopers will be notified.
AuthenticationError Provided owner_id and token was not matched.

/messages/sendTemplate

Send a new transactional message using templates


Example Call

<?php

$recipients = array(
array(
'email' => '[email protected]',
'name' => 'Recipient1 Name'
),
array(
'email' => '[email protected]',
'name' => 'Recipient2 Name'
),
try {
require_once'PowerEmailMTA_PHP/PowerEmail.php';
$PowerEmail= new PowerEmail('owner_id', 'token', 'PowerEmailTES_APP_DOMAIN');
$smtp_user_name = "smtp12345",
foreach ($recipients as $recipient) {
$message = array();
$message["template_id"] = "template_id";
$message["subject"] = "example subject";
$message["from_email"] = "[email protected]";
$message["to"] = array(
array("email" = $recipient['email'], "name" => $recipient['email'], "type" => "to")
),
$message["headers"] = array("Reply-To" => "[email protected]","X-Unique-Id" => "Id");
$message["dynamic_value"] = array("NAME" => "xyz","Email" => "[email protected]");
$message["attachments"] = array(array("type" => "text/plain","name" => "myfile.txt","content" => "ZXhhbXBsZSBmaWxl"));
$message["images"] = array(array("type" => "image/png", "name" => "IMAGECID","content" => "dgfdddger"));

$result = $PowerEmail->messages->sendTemplate($smtp_user_name, $message);

print_r($result);
/*
Array
(
[status] => "success"
[message] => "message have been Queued ... "
)
*/
}
} catch (PowerEmail_Error $e) {
# PowerEmailerrors are thrown as exceptions
echo "A PowerEmailerror occurred " . get_class($e) . " - " . $e->getMessage();
?>


Example Success Response

Array
(
[status] => "success"
[message] => "message have been Queued ... "
)


Example Error Response

Array
(
[status] => "error",
[code] => "-1",
[name] => "AuthenticationError",
[message] => Token MissMatch,
)


Parameters
owner_id* string a valid PowerEmailUser Id
token* string a valid token
PowerEmailTES_APP_DOMAIN* string a valid PowerEmailTES APP DOMAIN
smtp_user_name* string a valid smtp user name

* compulsory field

Return Value: Success
struct the results of sending mail
status string always success
message string human readable message
Return Value: Error
struct the error results when attempt to List Tracking Domain
statusstring error
messagestring human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. PowerEmailDevelopers will be notified.
AuthenticationError Provided owner_id and token was not matched.

/messages/sendTemplateHTTPGet

Send a new transactional message using templates (HTTP GET method). This method doesn't require PowerEmailLibrary.

Example Call

<?php

$query = array(
'owner_id' => 'owner_id',
'token' => 'token',
'smtp_user_name' => 'smtp123456',
'template_id' => 'template_id',
'subject' => 'hello',
'from_email' => '[email protected]',
'to':'[email protected]',
'dynamic_value[NAME]' => array('NAME' => 'xyz', 'Email' => '[email protected]')
),
$url = "http://api.PowerEmailTES_APP_DOMAIN/v1.0/messages/sendTemplateHTTPGet?" .
http_build_query($query);
echo file_get_contents($url);

?>


Example Success Response

{
"status": "success",
"message": "250 Message Queued...",
}


Example Error Response

{
"status": "error",
"code": "-1",
"name": "AuthenticationError",
"message": Token MissMatch,
}


Parameters
owner_id* string a valid PowerEmailUser Id
token* string a valid token
smtp_user_name* string a valid smtp user name
template_id* string a valid previously created template id
subject* string URL encoded subject
from_email* string URL encoded from email
to* string URL encoded to email
dynamic_value struct optional dynamic values to replace dynamic fields on template. Dynamic fields are case sensitive. Example
NAME URL encoded string xyz URL encoded string
Email URL encoded string info%40example.com URL encoded string

* compulsory field

Return Value: Success
struct the results of sending mail
status string queued
message string human readable message
Return Value: Error
struct the error results when attempt to List Tracking Domain
status string error
message string human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. PowerEmailDevelopers will be notified.
AuthenticationError Provided owner_id and token was not matched.

/messages/getMessageInfo

get list of messages of specific x-unique-id

Note:- By default first 100 record will be fetch if don't pass second argument i.e. 'skip_page' or pass value of 'skip_page' is 0, if you want to fetch next 100 record then pass value of 'skip_page' is 1, and so on.


Example Call

<?php
try {
require_once 'PowerEmailMTA_PHP/PowerEmail.php';
$PowerEmail = new PowerEmail('owner_id', 'token', 'PowerEmailTES_APP_DOMAIN')
$x_unique_id = "test";
$skip_page = 0;

$result = $PowerEmail_client.messages.getMessageInfo($x_unique_id, $skip_page)
print_r result
/*
Array
(
[status] => "success"
[message_data] => Array
(
[0] => Array
(
"subject" => "this is subject .."
"sender" => "[email protected]"
"email" => "[email protected]"
"sendFrom" => "10.0.0.0"
"mailSize" => 1919,
"attchSize" => 0
"status" => "delivered"
"time" => 1458034022169
"open" => 1
[openData] => Array
(
[ip] => Array
(
[0] => 0.0.0.0
[1] => 0.0.0.0
)
[ua] => Array
(
[0] => Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)
[1] => Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)
)

[time] => Array
(
[0] => 1458039067963
[1] => 1458039067978
)
)
[clickData] => Array
(
[ip] => Array
(
[0] => 0.0.0.0
[1] => 0.0.0.0
)
[ua] => Array
(
[0] => Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)
[1] => Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)
)

[time] => Array
(
[0] => 1458039068888
[1] => 1458039069999
)
)

[click] => 1
)
)
)
*/
} catch (PowerEmail_Error $e) {
// PowerEmailerrors are thrown as exceptions
echo 'A PowerEmailerror occurred: %s - %s' % (e.__class__, e)
?>


Example Success Response

Array
(
[status] => "success",
[message_data] => Array
(
[0] => Array
(
[subject] => this is subject ..
[sender] => [email protected]
[email] => [email protected]
[sendFrom] => 10.0.0.0
[mailSize] => 1919
[attchSize] => 0
[status] => delivered
[time] => 1458034022169
[open] => 1
[openData] => Array
(
[ip] => Array
(
[0] => 0.0.0.0
[1] => 0.0.0.0
)

[ua] => Array
(
[0] => "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
[1] => "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
)

[ip] => Array
(
[0] => 1458039067963
[1] => 1458039067978
)

)
[clickData] => Array
(
[ip] => Array
(
[0] => 0.0.0.0
[1] => 0.0.0.0
)

[ua] => Array
(
[0] => "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
[1] => "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
)

[time] => Array
(
[0] => 1458039068888
[1] => 1458039069999
)

)

[click] => 1
)
)
)


Example Error Response

Array
(
[status] => "error",
[code] => "-1",
[name] => "AuthenticationError",
[message] => Token MissMatch,
)


Parameters
owner_id* string a valid PowerEmailUser Id
token* string a valid token
PowerEmailTES_APP_DOMAIN* string a valid PowerEmailTES APP DOMAIN
x_unique_id* string a valid x-unique-id
skip_page* integer a valid skip page

* compulsory field

** Either 'html' field Or 'text' field compulsory

Return Value: Success
struct the results of get mail info
status string always success
message string human readable message
Return Value: Error
struct the error results when attempt to get mail info
status string error
message string human readable message
type string one of the error type as bellow table
Error types
ValidationError The parameters passed to the API call are invalid or not provided when required.
GeneralError An unexpected errors occurred processing the request. PowerEmailDevelopers will be notified.
AuthenticationError Provided owner_id and token was not matched.



Copyright © 2011 - Covalent Softwares Pvt. Ltd. All Rights Reserved.