Bring Your Own Storage (BYOS)

npm install @mailhooks/sdk

import express from 'express';
import { parseEml } from '@mailhooks/sdk';
import { S3Client, GetObjectCommand } from '@aws-sdk/client-s3';

const app = express();
app.use(express.json());

// Configure S3 client for your storage (e.g., Cloudflare R2)
const s3 = new S3Client({
  region: 'auto',
  endpoint: process.env.R2_ENDPOINT,
  credentials: {
    accessKeyId: process.env.R2_ACCESS_KEY_ID!,
    secretAccessKey: process.env.R2_SECRET_ACCESS_KEY!,
  },
});

app.post('/api/webhooks/mailhooks', async (req, res) => {
  const { event, data } = req.body;

  if (event === 'email.received') {
    // Check if email uses custom storage
    if (data.usesCustomStorage && data.storagePath) {
      // Fetch the raw EML from your bucket
      const response = await s3.send(new GetObjectCommand({
        Bucket: process.env.R2_BUCKET!,
        Key: data.storagePath,
      }));

      // Parse the EML content
      const emlBuffer = Buffer.from(
        await response.Body!.transformToByteArray()
      );
      const email = await parseEml(emlBuffer);

      // Now you have full access to the parsed email
      console.log('From:', email.from);
      console.log('Subject:', email.subject);
      console.log('Body:', email.body);
      console.log('HTML:', email.html);
      console.log('Attachments:', email.attachments.length);
      console.log('Headers:', email.headers);

      // Process the email...
      await processEmail(email);
    }
  }

  res.status(200).send('OK');
});

async function processEmail(email: ParsedEmail) {
  // Your custom processing logic here
  // e.g., extract data, store in database, trigger workflows
}

import { BlobServiceClient } from '@azure/storage-blob';
import { parseEml } from '@mailhooks/sdk';

const blobService = BlobServiceClient.fromConnectionString(
  process.env.AZURE_STORAGE_CONNECTION_STRING!
);
const containerClient = blobService.getContainerClient('emails');

async function getEmailFromAzure(storagePath: string) {
  const blobClient = containerClient.getBlobClient(storagePath);
  const downloadResponse = await blobClient.download();

  // Convert stream to buffer
  const chunks: Buffer[] = [];
  for await (const chunk of downloadResponse.readableStreamBody!) {
    chunks.push(Buffer.from(chunk));
  }
  const emlBuffer = Buffer.concat(chunks);

  // Parse the email
  return await parseEml(emlBuffer);
}

import { Storage } from '@google-cloud/storage';
import { parseEml } from '@mailhooks/sdk';

const storage = new Storage({
  projectId: process.env.GCP_PROJECT_ID,
  keyFilename: process.env.GCP_KEY_FILE,
});
const bucket = storage.bucket(process.env.GCS_BUCKET!);

async function getEmailFromGCS(storagePath: string) {
  const file = bucket.file(storagePath);
  const [contents] = await file.download();

  // Parse the email
  return await parseEml(contents);
}