How do I send mail via API?
If you are a developer building an application we recommend using this HTTP API, which is more flexible and efficient than standard SMTP.
This API is a powerful service which allows direct access to all functionality for the Zolute Email Dashboard and additional calls that may be required for tight integration with our Email services.
To send Email use the following API
URL: http://api.zolute.email/email/send
| Name | Type | Required | Default | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. | |
| bodyHtml | string | No | null | Html email body |
| bodyText | string | No | null | Text email body |
| channel | string | No | null | An ID field (max 191 chars) that can be used for reporting [will default to HTTP API or SMTP API] |
| charset | string | No | null | Text value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more… |
| charsetBodyHtml | string | No | null | Sets charset for body html MIME part (overrides default value from charset parameter) |
| charsetBodyText | string | No | null | Sets charset for body text MIME part (overrides default value from charset parameter) |
| encodingType | Integer | No | ApiTypes.EncodingType.None | 0 for None, 1 for Raw7Bit, 2 for Raw8Bit, 3 for QuotedPrintable, 4 for Base64 (Default), 5 for Uue note that you can also provide the text version such as "Raw7Bit" for value 1. NOTE: Base64 or QuotedPrintable is recommended if you are validating your domain(s) with DKIM. |
| from | string | No | null | From email address |
| fromName | string | No | null | Display name for from email address |
| headers | Repeated list of string keys and string values | No | null | Optional Custom Headers. Request parameters prefixed by headers_ like headers_customheader1, headers_customheader2. Note: a space is required after the colon before the custom header value. headers_xmailer=xmailer: header-value1 |
| isTransactional | boolean | No | false | True, if email is transactional (non-bulk, non-marketing, non-commercial). Otherwise, false |
| lists | List of string | No | null | The name of a contact list you would like to send to. Separate multiple contact lists by commas or semicolons. |
| merge | Repeated list of string keys and string values | No | null | Request parameters prefixed by merge_ like merge_firstname, merge_lastname. If sending to a template you can send merge_ fields to merge data with the template. Template fields are entered with {firstname}, {lastname} etc. |
| mergeSourceFilename | string | No | null | File name one of attachments which is a CSV list of Recipients. |
| msgBcc | Repeated list of string | No | null | Optional parameter. Will be ignored if the 'to' parameter is also provided. List of email recipients (each email is treated seperately). Separated by comma or semicolon. |
| msgCC | Repeated list of string | No | null | Optional parameter. Will be ignored if the 'to' parameter is also provided. List of email recipients (visible to all other recipients of the message as CC MIME header). Separated by comma or semicolon. |
| msgFrom | string | No | null | Optional parameter. Sets FROM MIME header. |
| msgFromName | string | No | null | Optional parameter. Sets FROM name of MIME header. |
| msgTo | Repeated list of string | No | null | Optional parameter. Will be ignored if the 'to' parameter is also provided. List of email recipients (visible to all other recipients of the message as TO MIME header). Separated by comma or semicolon. |
| poolName | string | No | null | Name of your custom IP Pool to be used in the sending process |
| postBack | string | No | null | Optional header returned in notifications. |
| replyTo | string | No | null | Email address to reply to |
| replyToName | string | No | null | Display name of the reply to address |
| segments | List of string | No | null | The name of a segment you would like to send to. Separate multiple segments by comma or semicolon. Insert "0" for all Active contacts. |
| sender | string | No | null | Email address of the sender |
| senderName | string | No | null | Display name sender |
| subject | string | No | null | Email subject |
| template | string | No | null | The name of an email template you have created in your account. |
| timeOffSetMinutes | string | No | null | Number of minutes in the future this email should be sent |
| to | List of string | No | null | List of email recipients (each email is treated separately, like a BCC). Separated by comma or semicolon. We suggest using the "msgTo" parameter if backward compatibility with API version 1 is not a must. |
Attach the file as POST multipart/form-data file upload |
||||
Returns
{"success": true, "error": null, "data": { } }
| Properties | Description | Example | Type |
|---|---|---|---|
| MessageID | Unique identifier for this email. | -HHGPM_9RPhSMiaJq_ab4g3 | string |
| TransactionID | ID number of transaction | TransactionID | string |
