@ever-works/mailgun-plugin 1.0.0 → 1.0.5

package/dist/index.d.cts

@@ -0,0 +1,30 @@
+import { IEmailOutboundPlugin, IEmailInboundPlugin, PluginCategory, JsonSchema, EmailSendInput, EmailOptions, EmailSendResult, EmailVerification, EmailInboundMessage } from '@ever-works/plugin';
+
+/**
+ * Mailgun email provider plugin (outbound + inbound).
+ *
+ * Outbound uses the official `mailgun.js` SDK (Messages API, US/EU
+ * regions). Inbound verifies the Mailgun HMAC-SHA256 signature
+ * (`HMAC(signingKey, timestamp + token)`) with Node `crypto` — Mailgun
+ * ships no SDK helper for inbound-route parsing/verification — and
+ * decodes the parsed message.
+ */
+declare class MailgunPlugin implements IEmailOutboundPlugin, IEmailInboundPlugin {
+    readonly id = "mailgun";
+    readonly name = "Mailgun";
+    readonly version = "1.0.0";
+    readonly category: PluginCategory;
+    readonly capabilities: readonly ["email-outbound", "email-inbound"];
+    readonly settingsSchema: JsonSchema;
+    onLoad(): Promise<void>;
+    onUnload(): Promise<void>;
+    private readonly idempotencyCache;
+    sendEmail(input: EmailSendInput, options: EmailOptions): Promise<EmailSendResult>;
+    verifyAddress(address: string, _options: EmailOptions): Promise<EmailVerification>;
+    verifyWebhookSignature(rawBody: Buffer, _headers: Readonly<Record<string, string>>, options: EmailOptions): void;
+    extractInboundRecipients(rawBody: Buffer, _headers: Readonly<Record<string, string>>): readonly string[];
+    parseInboundWebhook(rawBody: Buffer, _headers: Readonly<Record<string, string>>, _options: EmailOptions): Promise<EmailInboundMessage>;
+}
+declare const mailgunPlugin: MailgunPlugin;
+
+export { MailgunPlugin, mailgunPlugin };

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import { IEmailOutboundPlugin, IEmailInboundPlugin, PluginCategory, JsonSchema, EmailSendInput, EmailOptions, EmailSendResult, EmailVerification, EmailInboundMessage } from '@ever-works/plugin';
+
+/**
+ * Mailgun email provider plugin (outbound + inbound).
+ *
+ * Outbound uses the official `mailgun.js` SDK (Messages API, US/EU
+ * regions). Inbound verifies the Mailgun HMAC-SHA256 signature
+ * (`HMAC(signingKey, timestamp + token)`) with Node `crypto` — Mailgun
+ * ships no SDK helper for inbound-route parsing/verification — and
+ * decodes the parsed message.
+ */
+declare class MailgunPlugin implements IEmailOutboundPlugin, IEmailInboundPlugin {
+    readonly id = "mailgun";
+    readonly name = "Mailgun";
+    readonly version = "1.0.0";
+    readonly category: PluginCategory;
+    readonly capabilities: readonly ["email-outbound", "email-inbound"];
+    readonly settingsSchema: JsonSchema;
+    onLoad(): Promise<void>;
+    onUnload(): Promise<void>;
+    private readonly idempotencyCache;
+    sendEmail(input: EmailSendInput, options: EmailOptions): Promise<EmailSendResult>;
+    verifyAddress(address: string, _options: EmailOptions): Promise<EmailVerification>;
+    verifyWebhookSignature(rawBody: Buffer, _headers: Readonly<Record<string, string>>, options: EmailOptions): void;
+    extractInboundRecipients(rawBody: Buffer, _headers: Readonly<Record<string, string>>): readonly string[];
+    parseInboundWebhook(rawBody: Buffer, _headers: Readonly<Record<string, string>>, _options: EmailOptions): Promise<EmailInboundMessage>;
+}
+declare const mailgunPlugin: MailgunPlugin;
+
+export { MailgunPlugin, mailgunPlugin };