Email Transactional

A transactional email is a kind of email that is triggered by a user action on an app. It is sent to facilitate an agreed-upon transaction between the sender and the recipient.

Various kinds of transactional email are:

• Password resets
• Shipping confirmations
• Invoices and receipts
• Account notifications
• Social media updates
• Welcome emails

These types of emails are generally sent programmatically through an API or SMTP relay.

Showing

• This Taximail API endpoint allows you to get all the transactional list.
• You are required to send GET request to /transactional API.
• Taximail API will return an array of transactional groups.

GET https://api.taximail.com/v2/transactional

Example Request

GET v2/transactional?session_id=24bca90bac40b23e9fdcc8082299049d HTTP/1.1
Host: api.taximail.com

Example Result

{
  "status": "success",
  "code": 200,
  "data": {
            "transaction_group": [
                  {
                        "transactional_group_id": 217,
                        "transactional_group_name": "Default"
                  },
                  {
                        "transactional_group_id": 930,
                        "transactional_group_name": "Welcome"
                  },
                  {
                        "transactional_group_id": 1062,
                        "transactional_group_name": "eInvoice"
                  }
            ]
      }
}

Fields

Response Code

Sending

• This API endpoint allows you to send email to a recipient.
• You are required to send POST request and email content to /transactional API.
• Taximail API will return the message_id to be used in message status.

POST https://api.taximail.com/v2/transactional

Example Request

POST v2/transactional HTTP/1.1
Host: api.taximail.com

session_id=24bca90bac40b23e9fdcc8082299049d&message_id=mid_0000001&transactional_group_name=Welcome&subject=New+Member+Welcome&to_name=John+Smith&to_email=john%40example.com&from_name=Customer+Support&from_email=support%40example.com&reply_name=Customer+Support&reply_email=support%40example.com&template_key=16567a52906fb2a&content_html=&content_plain=&report_type=Full

Example Result

{
    "status": "success",
    "code": 202,
    "data": {
                "message_id": "mid_0000001",
                "claimed" : 1
          }
}

Fields

Response Code

Steps to send a transactional email

In this section, you will learn how to send a transactional email via the Taximail API. Usually, it requires a developer should set up a system that will send templates to specific recipients. In Taximail, you can quickly create transactional emails like you would any email. You can send these emails to almost all contacts in your audience.

Our Integrations section helps you to kickstart the procedure for sending transactional email.

Taximail offers two ways to send the transactional email:

• via the API( which is essentially an API call)
• via SMTP relay( which is an SMTP connect).

For a free subscription, we provide only the API call mode.

For paid subscription, we provide both the mode's - API as well as SMTP relay.

The following steps will help you get started:

1. Go to the Integrations section on the main menu of Taximail app.

2. Look for the SMTP relay section, select it and open it.

3. Under SMTP Relay configuration section, three params need to be defined.

   SMTP Relay server - This is similar to an email server like gmail.

   Password - This is similar to login credential like gmail password.

   Username - This is similar to login credentials like gmail username.

The following code segment is an example of inserting params in the SMTP server configuration.

$smtp_server['host'] = "smtp-dev.taximail.com";
$smtp_server['username'] = "sm170001";
$smtp_server['password'] = "ftLgAgfdrErtr";

Similarly, in the app, it will be displayed as follows:

4. For both modes, we use the following two ways:

• By Template key
• By custom HTML content

There’s an added layer of value to sending through Taximail's SMTP Relay. Before our SMTP servers send an email, our system automatically adds link trackers in the body of your message. This then allows you, as the user, to properly track opens and clicks after an email has been received.

5. By template key method, you need to insert the parameter for the template key in the API.

$mail->addCustomHeader("X-TAXIMAIL-TEMPLATE-KEY: 13095cf8c3137fea8");

In APP, it will be displayed as follows:

To specify the template key as a parameter, it should be defined in the Transaction API endpoint.

An example is shown below:

POST v2/transactional HTTP/1.1
Host: api.taximail.com

session_id=24bca90bac40b23e9fdcc8082299049d&message_id=mid_0000001&transactional_group_name=Welcome&subject=New+Member+Welcome&to_name=John+Smith&to_email=john%40example.com&from_name=Customer+Support&from_email=support%40example.com&reply_name=Customer+Support&reply_email=support%40example.com&template_key=16567a52906fb2a&content_html=&content_plain=&report_type=Full

6. Template key parameter is inserted as a JSON string to the body of the HTML section.

7. The email content will be inserted to JSON data as follows:

   $json_data = '{"CF_HTMLContent":"some html content"}';

In the SMTP method, a variable like 'Hello username' is passed as a custom field in the template.

     For example:  $arr = [
                      "CF_Firstname" => 'Firstname'
                     ];

8. By HTML method, the email content will be passed as an HTML string in the body parameter.

9. The following code example shows an example of how HTML content is inserted in the body parameter.

   $body = '{"CF_HTMLContent":"some html content"}';

You can classify your transactional email by grouping, sending with saved template email, and etc.

Hopefully, this guide helped you to understand how transactional emails work.

Now, it’s your chance to start using transactional emails to get the possible value and continue building positive customer relationships.

Message status

• This Taximail API endpoint allows you to get the status of delivered transactional email to the recipient.
• You are required to send GET request to transactional/{message_id} API.
• Taximail API will return message status object such as email, ready time, sent time, open time and other.

GET https://api.taximail.com/v2/transactional/{message_id}

Example Request

GET v2/transactional/mid_0000001?session_id=24bca90bac40b23e9fdcc8082299049d HTTP/1.1
Host: api.taximail.com

Example Result

{
    "status": "success",
    "code": 200,
    "data": {
                "email": "john@example.com",
                "ready": "2016-01-07 10:13:15",
                "sent": "2016-01-07 10:13:19",
                "open": [
                      "2016-01-07 10:14:03"
                ],
                "open_count": 1,
                "click": [],
                "click_count": 0
       }
}

Fields

Response Code