Documentation

Installation | JS

To get started with ekiliRelay, download the SDK as a zip file and include it in your project.

  1. Download the SDK from the button below:
    Download SDK
  2. Get your api key api key
  3. Unzip the downloaded file.
  4. Import the SDK in your project 
import EkiliRelay from '../path-to/sdk/js/ekiliRelay.js';
Usage | JS/TS

After including the SDK, you can start using ekiliRelay to send emails. Here's a quick example:
(This apply for both javascript and typescript)

<script type="module">
const sendBtn = document.getElementById("send"); //some button
import EkiliRelay from '../path-to/sdk/js/ekiliRelay.js'; //importing EkiliRelay

// Initialize the SDK  
const sdk = new EkiliRelay('your-api-key');//your-api-key goes here

sendBtn.addEventListener("click", () => {//listening to a click event
  // Send an email
  sdk.sendEmail('email@example.com', 'Test Subject', 'This is a test message.', 'From: some-email@example.com')
    .then(response => {
      if (response.status === 'success') {
        console.log('Email sent successfully.');
      } else {
        console.log('Failed to send email: ' + response.message);
        console.log(response);
      }
    })
    .catch(error => {
      console.log('Error:', error);
    });
});
</script>

This simple example demonstrates how to initialize the ekiliRelay SDK and send an email in js/ts

FAQ | JS/TS
How do I get started with ekiliRelay?

Simply download the SDK, include it in your project, and follow the usage instructions.

Is ekiliRelay really free?

Yes, ekiliRelay is completely free to use.

Can I customize the email template?

Yes, you can customize the email body as per your requirements using HTML and CSS.

Contact | JS

If you have any questions or need further assistance, please reach out to us: