Welcome to the Simpu Email SDK documentation! This guide will help you get started with using the SDK components and hooks in your React applications.

​
Installation

The Simpu Email SDK is designed to work within this monorepo structure. If you’re building an external application, you would install it via npm:

npm install @simpu/mail-sdk
# or
yarn add @simpu/mail-sdk
# or
pnpm add @simpu/mail-sdk

​
Configuration

  1. Configure the SDK with your Simpu API credentials:
<SimpuProvider
  apiUrl="https://api.simpu.co"           // API base URL
  accessToken="your-access-token"         // Your authentication token
  organisationID="your-organisation-id"   // Your organisation ID
>

Always wrap your app with the SimpuProvider - This ensures all components and hooks have access to the necessary Simpu API context.

  1. Import CSS styles (optional)
import "@simpu/mail-sdk/styles.css";

​
Next Steps

  • Explore the Core SDK package if you need to implement core email functionality without the SDK’s built-in UI components.
  • Check out the UI package with pre-built UI components and pages for quickly integrating email marketing into your product.
  • See Examples for complete implementation examples.
  • Review the API documentation for backend integration details.

Happy building! 🚀