@upyo/mailgun 0.1.0-dev.10 → 0.1.0-dev.12

package/README.md

@@ -3,9 +3,17 @@
 @upyo/mailgun
 =============
 
-[Mailgun] transport for Upyo email library.
+[![JSR][JSR badge]][JSR]
+[![npm][npm badge]][npm]
 
+[Mailgun] transport for the [Upyo] email library.
+
+[JSR]: https://jsr.io/@upyo/mailgun
+[JSR badge]: https://jsr.io/badges/@upyo/mailgun
+[npm]: https://www.npmjs.com/package/@upyo/mailgun
+[npm badge]: https://img.shields.io/npm/v/@upyo/mailgun?logo=npm
 [Mailgun]: https://www.mailgun.com/
+[Upyo]: https://upyo.org/
 
 
 Installation
@@ -24,22 +32,31 @@ Usage
 -----
 
 ~~~~ typescript
-import { MailgunTransport } from '@upyo/mailgun';
+import { createMessage } from "@upyo/core";
+import { MailgunTransport } from "@upyo/mailgun";
+import fs from "node:fs/promises";
+import process from "node:process";
+
+const message = createMessage({
+  from: "sender@example.com",
+  to: "recipient@example.net",
+  subject: "Hello from Upyo!",
+  content: { text: "This is a test email." },
+  attachments: [
+    new File(
+      [await fs.readFile("image.jpg"), "image.jpg", { type: "image/jpeg" }]
+    )
+  ],
+});
 
 const transport = new MailgunTransport({
-  apiKey: 'your-api-key',
-  domain: 'your-domain.com'
+  apiKey: process.env.MAILGUN_KEY!,
+  domain: process.env.MAILGUN_DOMAIN!,
+  region: process.env.MAILGUN_REGION as "us" | "eu",
 });
 
-const message = {
-  sender: { address: 'sender@example.com' },
-  recipients: [{ address: 'recipient@example.com' }],
-  subject: 'Hello from Mailgun!',
-  content: { text: 'Hello, World!' }
-};
-
 const receipt = await transport.send(message);
-console.log('Message sent:', receipt.messageId);
+console.log("Email sent:", receipt.successful);
 ~~~~
 
 

package/dist/index.cjs

@@ -162,11 +162,11 @@ var MailgunApiError = class extends Error {
 *
 * @example
 * ```typescript
-* const formData = convertMessage(message, config);
+* const formData = await convertMessage(message, config);
 * const response = await fetch(url, { method: 'POST', body: formData });
 * ```
 */
-function convertMessage(message, config) {
+async function convertMessage(message, config) {
 	const formData = new FormData();
 	formData.append("from", formatAddress(message.sender));
 	for (const recipient of message.recipients) formData.append("to", formatAddress(recipient));
@@ -191,7 +191,7 @@ function convertMessage(message, config) {
 	}
 	for (const tag of message.tags) formData.append("o:tag", tag);
 	for (const [key, value] of message.headers.entries()) if (!isStandardHeader(key)) formData.append(`h:${key}`, value);
-	for (const attachment of message.attachments) appendAttachment(formData, attachment);
+	for (const attachment of message.attachments) await appendAttachment(formData, attachment);
 	if (config.tracking !== void 0) formData.append("o:tracking", config.tracking ? "yes" : "no");
 	if (config.clickTracking !== void 0) formData.append("o:tracking-clicks", config.clickTracking ? "yes" : "no");
 	if (config.openTracking !== void 0) formData.append("o:tracking-opens", config.openTracking ? "yes" : "no");
@@ -216,8 +216,8 @@ function formatAddress(address) {
 * @param formData - The FormData to append to
 * @param attachment - The attachment to append
 */
-function appendAttachment(formData, attachment) {
-	const blob = new Blob([attachment.content], { type: attachment.contentType });
+async function appendAttachment(formData, attachment) {
+	const blob = new Blob([await attachment.content], { type: attachment.contentType });
 	if (attachment.contentId) formData.append("inline", blob, attachment.filename);
 	else formData.append("attachment", blob, attachment.filename);
 }
@@ -314,7 +314,7 @@ var MailgunTransport = class {
 	async send(message, options) {
 		options?.signal?.throwIfAborted();
 		try {
-			const formData = convertMessage(message, this.config);
+			const formData = await convertMessage(message, this.config);
 			options?.signal?.throwIfAborted();
 			const response = await this.httpClient.sendMessage(formData, options?.signal);
 			return {

package/dist/index.js

@@ -161,11 +161,11 @@ var MailgunApiError = class extends Error {
 *
 * @example
 * ```typescript
-* const formData = convertMessage(message, config);
+* const formData = await convertMessage(message, config);
 * const response = await fetch(url, { method: 'POST', body: formData });
 * ```
 */
-function convertMessage(message, config) {
+async function convertMessage(message, config) {
 	const formData = new FormData();
 	formData.append("from", formatAddress(message.sender));
 	for (const recipient of message.recipients) formData.append("to", formatAddress(recipient));
@@ -190,7 +190,7 @@ function convertMessage(message, config) {
 	}
 	for (const tag of message.tags) formData.append("o:tag", tag);
 	for (const [key, value] of message.headers.entries()) if (!isStandardHeader(key)) formData.append(`h:${key}`, value);
-	for (const attachment of message.attachments) appendAttachment(formData, attachment);
+	for (const attachment of message.attachments) await appendAttachment(formData, attachment);
 	if (config.tracking !== void 0) formData.append("o:tracking", config.tracking ? "yes" : "no");
 	if (config.clickTracking !== void 0) formData.append("o:tracking-clicks", config.clickTracking ? "yes" : "no");
 	if (config.openTracking !== void 0) formData.append("o:tracking-opens", config.openTracking ? "yes" : "no");
@@ -215,8 +215,8 @@ function formatAddress(address) {
 * @param formData - The FormData to append to
 * @param attachment - The attachment to append
 */
-function appendAttachment(formData, attachment) {
-	const blob = new Blob([attachment.content], { type: attachment.contentType });
+async function appendAttachment(formData, attachment) {
+	const blob = new Blob([await attachment.content], { type: attachment.contentType });
 	if (attachment.contentId) formData.append("inline", blob, attachment.filename);
 	else formData.append("attachment", blob, attachment.filename);
 }
@@ -313,7 +313,7 @@ var MailgunTransport = class {
 	async send(message, options) {
 		options?.signal?.throwIfAborted();
 		try {
-			const formData = convertMessage(message, this.config);
+			const formData = await convertMessage(message, this.config);
 			options?.signal?.throwIfAborted();
 			const response = await this.httpClient.sendMessage(formData, options?.signal);
 			return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@upyo/mailgun",
-  "version": "0.1.0-dev.10+c222d7c6",
+  "version": "0.1.0-dev.12+d36debdf",
   "description": "Mailgun transport for Upyo email library",
   "keywords": [
     "email",
@@ -53,7 +53,7 @@
   },
   "sideEffects": false,
   "peerDependencies": {
-    "@upyo/core": "0.1.0-dev.10+c222d7c6"
+    "@upyo/core": "0.1.0-dev.12+d36debdf"
   },
   "devDependencies": {
     "@dotenvx/dotenvx": "^1.47.3",