npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

refire-client

v0.1.3

Published

Refire Email API Client

Downloads

496

Readme

Refire Email Client

A lightweight TypeScript client for sending transactional emails through the Refire Email API.

Getting Your API Key

Before using the client, you'll need an API key:

  1. Create a company account in the Refire dashboard
  2. Navigate to your company view page
  3. Find your API key in a secure, masked input field
  4. Click the field to copy your API key to clipboard

Keep your API key secure and never share it publicly or commit it to version control.

Installation

npm install refire-client

Usage

Initialize the Client

import { Refire } from "refire-client";

const refire = new Refire({
  apiKey: "your-api-key",
});

You can optionally specify a custom API URL during initialization:

const refire = new Refire({
  apiKey: "your-api-key",
  apiUrl: "https://api.refire.email/v1",
});

Sending Basic Emails

To send a basic email without a template:

refire.sendEmail({
  to: "[email protected]",
  subject: "Hello",
  name: "John Doe",
  message: "Your email content here",
});

Sending Template-Based Emails

To send an email using a pre-defined template:

refire.sendEmailFromTemplate({
  to: "[email protected]",
  templateId: "<your_template_id>",
});

Method Chaining

You can also use method chaining if preferred:

Sending a basic email:

new Refire("<your_api_key>").sendEmail({
  to: "[email protected]",
  subject: "Hello",
  name: "John Doe",
  message: "Your email content here",
});

Sending a template-based email:

new Refire("<your_api_key>").sendEmailFromTemplate({
  to: "[email protected]",
  templateId: "<your_template_id>",
});

API Reference

SendEmailParams

Parameters for sending a basic email:

  • to (string): Recipient email address
  • subject (string): Email subject line
  • name (string): Recipient name
  • message (string): Email content

SendEmailFromTemplateParams

Parameters for sending a template-based email:

  • to (string): Recipient email address
  • templateId (string): ID of the template to use

Error Handling

The client includes built-in error handling. Both sendEmail and sendEmailFromTemplate methods will throw an error if the API request fails:

try {
  await refire.sendEmail({
    to: "[email protected]",
    subject: "Hello",
    name: "John Doe",
    message: "Your email content here",
  });
} catch (error) {
  console.error("Failed to send email:", error);
}

License

MIT

Author

Refire

For more information and detailed documentation, visit refire.email.