alepha/dist/email/brevo/index.d.ts

Easy-to-use modern TypeScript framework for building many kind of applications.

import { EmailProvider, EmailSendOptions } from "alepha/email";
//#region ../../src/email/brevo/providers/BrevoEmailProvider.d.ts
/**
 * Email provider using Brevo (formerly Sendinblue) transactional email API.
 *
 * Sends emails via `POST https://api.brevo.com/v3/smtp/email`.
 *
 * Configuration is provided via environment variables:
 * - `BREVO_API_KEY`: Brevo API key
 * - `EMAIL_FROM`: Default sender email address
 *
 * @example
 * ```typescript
 * // .env
 * // BREVO_API_KEY=xkeysib-xxx
 * // EMAIL_FROM=noreply@example.com
 *
 * // app.ts
 * import { AlephaEmailBrevo } from "alepha/email/brevo";
 *
 * const app = Alepha.create().with(AlephaEmailBrevo);
 * ```
 */
declare class BrevoEmailProvider implements EmailProvider {
  protected readonly env: {
    BREVO_API_KEY: string;
    EMAIL_FROM: string;
  };
  protected readonly log: import("alepha/logger").Logger;
  send(options: EmailSendOptions): Promise<void>;
}
//#endregion
//#region ../../src/email/brevo/index.d.ts
/**
 * Plugin for Alepha Email that provides Brevo transactional email capabilities.
 *
 * @see {@link BrevoEmailProvider}
 * @module alepha.email.brevo
 */
declare const AlephaEmailBrevo: import("alepha").Service<import("alepha").Module>;
//#endregion
export { AlephaEmailBrevo, BrevoEmailProvider };
//# sourceMappingURL=index.d.ts.map