Node.js SDK

1
import { BrevoClient } from '@getbrevo/brevo';
2
3
const brevo = new BrevoClient({
4
  apiKey: 'your-api-key',
5
});
6
7
const result = await brevo.transactionalEmails.sendTransacEmail({
8
  subject: "Hello",
9
  textContent: "Hello world!",
10
  sender: { name: "Sender", email: "sender@brevo.com" },
11
  to: [{ email: "recipient@example.com" }]
12
});
13
14
console.log('Email sent:', result);

1
const brevo = new BrevoClient({
2
  apiKey: 'your-api-key',
3
  timeoutInSeconds: 30,      // 30 seconds
4
  maxRetries: 3              // Default: 2
5
});

1
import { 
2
  BrevoError, 
3
  UnauthorizedError, 
4
  TooManyRequestsError 
5
} from '@getbrevo/brevo';
6
7
try {
8
  await brevo.transactionalEmails.sendTransacEmail({
9
    subject: "Hello",
10
    textContent: "Hello world!",
11
    sender: { name: "Sender", email: "sender@brevo.com" },
12
    to: [{ email: "recipient@example.com" }]
13
  });
14
} catch (err) {
15
  if (err instanceof UnauthorizedError) {
16
    console.error('Invalid API key');
17
  } else if (err instanceof TooManyRequestsError) {
18
    const retryAfter = err.rawResponse.headers['retry-after'];
19
    console.error(`Rate limited. Retry after ${retryAfter} seconds`);
20
  } else if (err instanceof BrevoError) {
21
    console.error(`API Error ${err.statusCode}:`, err.message);
22
  }
23
}

1
// Client-level configuration
2
const brevo = new BrevoClient({
3
  apiKey: 'your-api-key',
4
  maxRetries: 3
5
});
6
7
// Request-level configuration
8
await brevo.transactionalEmails.sendTransacEmail({
9
  subject: "Hello",
10
  textContent: "Hello world!",
11
  sender: { name: "Sender", email: "sender@brevo.com" },
12
  to: [{ email: "recipient@example.com" }]
13
}, {
14
  maxRetries: 5
15
});

1
// Client-level timeout
2
const brevo = new BrevoClient({
3
  apiKey: 'your-api-key',
4
  timeoutInSeconds: 30
5
});
6
7
// Request-level timeout
8
await brevo.transactionalEmails.sendTransacEmail({
9
  subject: "Hello",
10
  textContent: "Hello world!",
11
  sender: { name: "Sender", email: "sender@brevo.com" },
12
  to: [{ email: "recipient@example.com" }]
13
}, {
14
  timeoutInSeconds: 10
15
});

1
await brevo.transactionalEmails.sendTransacEmail({
2
  subject: "Hello",
3
  textContent: "Hello world!",
4
  sender: { name: "Sender", email: "sender@brevo.com" },
5
  to: [{ email: "recipient@example.com" }]
6
}, {
7
  headers: {
8
    'X-Custom-Header': 'custom-value'
9
  }
10
});

1
await brevo.transactionalEmails.sendTransacEmail({
2
  subject: "Hello",
3
  textContent: "Hello world!",
4
  sender: { name: "Sender", email: "sender@brevo.com" },
5
  to: [{ email: "recipient@example.com" }]
6
}, {
7
  queryParams: {
8
    'customParam': 'value'
9
  }
10
});

1
const controller = new AbortController();
2
3
await brevo.transactionalEmails.sendTransacEmail({
4
  subject: "Hello",
5
  textContent: "Hello world!",
6
  sender: { name: "Sender", email: "sender@brevo.com" },
7
  to: [{ email: "recipient@example.com" }]
8
}, {
9
  abortSignal: controller.signal
10
});
11
12
// Cancel the request
13
controller.abort();

1
const { data, rawResponse } = await brevo.transactionalEmails.sendTransacEmail({
2
  subject: "Hello",
3
  textContent: "Hello world!",
4
  sender: { name: "Sender", email: "sender@brevo.com" },
5
  to: [{ email: "recipient@example.com" }]
6
}).withRawResponse();
7
8
console.log(rawResponse.headers['X-My-Header']);

1
const response = await brevo.inboundParsing.getInboundEmailAttachment(
2
  attachmentId,
3
  downloadToken
4
);
5
6
// Choose one:
7
const stream = response.stream();
8
// const arrayBuffer = await response.arrayBuffer();
9
// const blob = await response.blob();
10
// const bytes = await response.bytes();

1
import { Brevo } from '@getbrevo/brevo';
2
3
const request: Brevo.SendTransacEmailRequest = {
4
  subject: "First email",
5
  textContent: "Hello world!",
6
  sender: { name: "Bob Wilson", email: "bob.wilson@brevo.com" },
7
  to: [{ email: "sarah.davis@example.com", name: "Sarah Davis" }]
8
};

1
import { BrevoClient, logging } from '@getbrevo/brevo';
2
3
const brevo = new BrevoClient({
4
  apiKey: 'your-api-key',
5
  logging: {
6
    level: logging.LogLevel.Debug,
7
    logger: new logging.ConsoleLogger(),
8
    silent: false
9
  }
10
});

1
import winston from 'winston';
2
3
const winstonLogger = winston.createLogger({
4
  level: 'info',
5
  format: winston.format.json(),
6
  transports: [new winston.transports.Console()]
7
});
8
9
const logger: logging.ILogger = {
10
  debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
11
  info: (msg, ...args) => winstonLogger.info(msg, ...args),
12
  warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
13
  error: (msg, ...args) => winstonLogger.error(msg, ...args),
14
};
15
16
const brevo = new BrevoClient({
17
  apiKey: 'your-api-key',
18
  logging: {
19
    level: logging.LogLevel.Debug,
20
    logger: logger
21
  }
22
});

1
const customFetcher = async (
2
  url: string, 
3
  options?: RequestInit
4
): Promise<Response> => {
5
  // Your custom implementation
6
  return fetch(url, options);
7
};
8
9
const brevo = new BrevoClient({
10
  apiKey: 'your-api-key',
11
  fetcher: customFetcher
12
});