Messages Calls
/messages/sendMail
Send a new transactional message through PowerEmail
Example Request JSON
{
"owner_id": "example id",
"token": "example token",
"smtp_user_name": "smtp12345",
"message": {
"html": "Example HTML content",
"text": "Example text content",
"subject": "example subject",
"from_email": "[email protected]",
"from_name": "Example Name",
"to": [
{
"email": "[email protected]",
"name": "Recipient Name",
"type": "to",
}
],
"headers": {
"Reply-To": "[email protected]",
"X-Unique-Id": "id",
},
"attachments": [
{
"type": "text/plain",
"name": "myfile.txt",
"content": "ZXhhbXBsZSBmaWxl",
}
],
"images": [
{
"type": "image/png",
"name": "IMAGECID",
"content": "ZXhhbXBsZSBmaWxl",
}
]
}
}
Example Success Response
{
"status": "success",
"message": "message have been 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 |
| 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 Request JSON
{
"owner_id": "example id",
"token": "example token",
"smtp_user_name": "smtp12345",
"message": {
"template_id": "Template Id",
"subject": "example subject",
"from_email": "[email protected]",
"from_name": "Example Name",
"to": [
{
"email": "[email protected]",
"name": "Recipient Name",
"type": "to",
}
],
"headers": {
"Reply-To": "[email protected]",
"X-Unique-Id": "id",
},
"dynamic_value": {
"NAME": "xyz",
"Email": "[email protected]",
},
"attachments": [
{
"type": "text/plain",
"name": "myfile.txt",
"content": "ZXhhbXBsZSBmaWxl",
}
],
"images": [
{
"type": "image/png",
"name": "IMAGECID",
"content": "ZXhhbXBsZSBmaWxl",
}
]
}
}
Example Success Response
{
"status": "success",
"message": "250 Message Queued...",
}
Example Error Response JSON
{
"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)
Note: Use this method to integrate third party applications (Like IVR webhooks). It requires less dependency. All name and values should be URL encoded.
Example HTTP GET request using cURL
curl "http://api.PowerEmailTES_APP_DOMAIN/v1.0/messages/sendTemplateHTTPGet?owner_id=owner_id&token=token&smtp_user_name=smtp12345&template_id=template_id&subject=hello&from_email=info%40example.com&to=xyz%40example.com&dynamic_value%5BNAME%5D=xyz&dynamic_value%5BEmail%5D=xyz%40example.com"
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
Example Call
{
"owner_id": "example id",
"token": "example token",
"token": "x_unique_id",
"skip_page": 0
}
Example Response JSON
{
"status": "success",
"message_data": [{
"subject": "this is subject ..",
"sender": "[email protected]",
"email": "[email protected]",
"sendFrom": "0.0.0.0",
"mailSize": 1919,
"attchSize": 0,
"status": "delivered",
"time": 1458034022169,
"open": 1,
"openData": {
"ip": [
"0.0.0.0", "0.0.0.0"
],
"ua": [
"Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
"Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)"
],
"time": [
1458039067963, 1458039067978
],
},
"clickData": {
"ip": [
"0.0.0.0", "0.0.0.0"
],
"ua": [
"Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
"Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)"
],
"time": [
1458039067963, 1458039067978
]
},
"click": 1
}]
}
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 |
| 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
| 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. |
