@tozielinski/next-brevo-api-helper 1.0.0 → 1.0.2

package/README.md

@@ -7,4 +7,69 @@
 ### Install the package:
 ```bash
 npm install @tozielinski/next-brevo-api-helper
-```
+```
+### Create an API Key in Brevo: and add it to your Next.js environment variables:
+```
+BREVO_API_KEY=your-brevo-api-key
+```
+https://www.brevo.com/api-keys
+### Create a ServerAction, and use it in your Next.js page:
+```tsx
+'use server'
+
+import {BrevoClient, BrevoEmailRecipient, BrevoSendEmailRequest} from "@tozielinski/next-brevo-api-helper";
+
+const brevoClient = new BrevoClient();
+
+const mail: BrevoSendEmailRequest = {
+    to:
+        [{
+            email: string
+        }]
+    ,
+    // sender: {
+    //     email: string
+    // } satisfies BrevoEmailRecipient,
+    // cc?: BrevoEmailRecipient[];
+    // bcc?: BrevoEmailRecipient[];
+    // replyTo?: {
+    //     email: string,
+    //     name?: string,
+    // } satisfies BrevoEmailRecipient,
+    // subject: string,
+    // htmlContent: string,
+    // textContent: "this is a test content for a mail",
+    // textContent: mailObject.email + "\n" + (fullName.toString() && "\n") + mailObject.phone + "\nVielen Dank für die Anfrage zum Thema '" + mailObject.topic + "'\n\nDeine Nachricht lautet:\n" + mailObject.message,
+    // templateId?: number;
+    // params?: Record<string, string | number | boolean>;
+    // headers?: Record<string, string>;
+    // attachment?: {
+    //     url?: string;
+    //     content?: string; // Base64 encoded
+    //     name?: string;
+    // }[];
+    // tags?: string[];
+};
+
+export async function sendMail() {
+    return brevoClient.sendEmail(mail);
+}
+
+export async function getFolders(apiKey?:string) {
+    const brevoClient = new BrevoClient();
+    return brevoClient.getFolders();
+}
+
+export async function getFolderDetails(folderId: number, apiKey?:string) {
+    const brevoClient = new BrevoClient();
+    return brevoClient.getFolderDetails({id: folderId});
+}
+
+export async function createFolder(name: string) {
+    return brevoClient.createFolder({name: name});
+}
+
+export async function deleteFolder(id: number) {
+    return brevoClient.deleteFolder({id: id});
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tozielinski/next-brevo-api-helper",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Lightweight helper to use Brevo to send mails via the Brevo API and maintain all",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",