mirror of
https://github.com/xtr-dev/payload-mailing.git
synced 2025-12-10 08:13:23 +00:00
🔥 REMOVE: Deprecate outdated documentation for simplified API and template engine
- Delete `simplified-api-guide.md` and `template-syntax-migration.md` - Content now covered in more streamlined and up-to-date guides - Declutter repository by removing redundant files Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -1,167 +0,0 @@
|
||||
# Simplified API Guide
|
||||
|
||||
The mailing plugin now uses a much simpler, type-safe API that leverages PayloadCMS's existing collection system instead of custom email methods.
|
||||
|
||||
## New API Approach
|
||||
|
||||
### ✅ **Recommended: Use Payload Collections Directly**
|
||||
|
||||
```typescript
|
||||
import { payload, renderTemplate } from '@xtr-dev/payload-mailing'
|
||||
|
||||
// 1. Render a template (optional)
|
||||
const rendered = await renderTemplate(payload, 'welcome-email', {
|
||||
name: 'John Doe',
|
||||
activationLink: 'https://example.com/activate/123'
|
||||
})
|
||||
|
||||
// 2. Create an email using Payload's collection API
|
||||
const email = await payload.create({
|
||||
collection: 'emails', // Your email collection name
|
||||
data: {
|
||||
to: ['user@example.com'],
|
||||
subject: rendered.subject, // or your own subject
|
||||
html: rendered.html, // or your own HTML
|
||||
text: rendered.text, // or your own text
|
||||
// Add any custom fields you've defined in your collection
|
||||
priority: 1,
|
||||
scheduledAt: new Date('2024-01-01T10:00:00Z'), // Optional scheduling
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### ❌ **Old API (Removed)**
|
||||
|
||||
```typescript
|
||||
// These methods have been removed to simplify the API
|
||||
await sendEmail(payload, { to: '...', subject: '...' })
|
||||
await scheduleEmail(payload, { to: '...', scheduledAt: new Date() })
|
||||
```
|
||||
|
||||
## Benefits of the New Approach
|
||||
|
||||
### 🎯 **Type Safety**
|
||||
- Full TypeScript support using your generated Payload types
|
||||
- IntelliSense for all your custom collection fields
|
||||
- Compile-time validation of email data
|
||||
|
||||
### 🚀 **Flexibility**
|
||||
- Use any fields you've added to your email collection
|
||||
- Leverage Payload's built-in validation, hooks, and access control
|
||||
- Full control over email data structure
|
||||
|
||||
### 🧹 **Simplicity**
|
||||
- One consistent API (Payload collections) instead of custom methods
|
||||
- No duplicate type definitions
|
||||
- Less code to maintain
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic Email with Template
|
||||
```typescript
|
||||
import { renderTemplate } from '@xtr-dev/payload-mailing'
|
||||
|
||||
const { html, text, subject } = await renderTemplate(payload, 'order-confirmation', {
|
||||
orderNumber: '#12345',
|
||||
customerName: 'Jane Smith',
|
||||
items: [
|
||||
{ name: 'Product 1', price: 29.99 },
|
||||
{ name: 'Product 2', price: 49.99 }
|
||||
]
|
||||
})
|
||||
|
||||
await payload.create({
|
||||
collection: 'emails',
|
||||
data: {
|
||||
to: ['customer@example.com'],
|
||||
subject,
|
||||
html,
|
||||
text,
|
||||
priority: 2,
|
||||
// Add your custom fields
|
||||
orderId: '12345',
|
||||
customerSegment: 'premium'
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### Bulk Email Creation
|
||||
```typescript
|
||||
const customers = await payload.find({
|
||||
collection: 'customers',
|
||||
where: { newsletter: { equals: true } }
|
||||
})
|
||||
|
||||
for (const customer of customers.docs) {
|
||||
const { html, text, subject } = await renderTemplate(payload, 'newsletter', {
|
||||
name: customer.name,
|
||||
unsubscribeLink: `https://example.com/unsubscribe/${customer.id}`
|
||||
})
|
||||
|
||||
await payload.create({
|
||||
collection: 'emails',
|
||||
data: {
|
||||
to: [customer.email],
|
||||
subject,
|
||||
html,
|
||||
text,
|
||||
scheduledAt: new Date('2024-01-15T09:00:00Z'), // Send next week
|
||||
}
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
### Direct HTML Email (No Template)
|
||||
```typescript
|
||||
await payload.create({
|
||||
collection: 'emails',
|
||||
data: {
|
||||
to: ['admin@example.com'],
|
||||
subject: 'System Alert',
|
||||
html: '<h1>Server Error</h1><p>Please check the logs immediately.</p>',
|
||||
text: 'Server Error: Please check the logs immediately.',
|
||||
priority: 10, // High priority
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## Available Helper Functions
|
||||
|
||||
```typescript
|
||||
import {
|
||||
renderTemplate, // Render email templates with variables
|
||||
processEmails, // Process pending emails manually
|
||||
retryFailedEmails, // Retry failed emails
|
||||
getMailing // Get mailing service instance
|
||||
} from '@xtr-dev/payload-mailing'
|
||||
```
|
||||
|
||||
## Migration Guide
|
||||
|
||||
If you were using the old `sendEmail`/`scheduleEmail` methods, update your code:
|
||||
|
||||
**Before:**
|
||||
```typescript
|
||||
await sendEmail(payload, {
|
||||
templateSlug: 'welcome',
|
||||
to: 'user@example.com',
|
||||
variables: { name: 'John' }
|
||||
})
|
||||
```
|
||||
|
||||
**After:**
|
||||
```typescript
|
||||
const { html, text, subject } = await renderTemplate(payload, 'welcome', { name: 'John' })
|
||||
|
||||
await payload.create({
|
||||
collection: 'emails',
|
||||
data: {
|
||||
to: ['user@example.com'],
|
||||
subject,
|
||||
html,
|
||||
text
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
This new approach gives you the full power and type safety of PayloadCMS while keeping the mailing functionality simple and consistent! 🚀
|
||||
@@ -1,160 +0,0 @@
|
||||
# Template Engine Options
|
||||
|
||||
The plugin now supports flexible template rendering with multiple options:
|
||||
|
||||
1. **String-based Configuration** (easy setup with built-in engines)
|
||||
2. **Custom Template Renderer Hook** (maximum flexibility)
|
||||
3. **Simple Variable Replacement** (fallback, no dependencies)
|
||||
|
||||
## Configuration Options
|
||||
|
||||
### String-based Template Engine Configuration
|
||||
Easy setup using built-in template engines:
|
||||
|
||||
```typescript
|
||||
// Using LiquidJS (default, requires: npm install liquidjs)
|
||||
mailingPlugin({
|
||||
templateEngine: 'liquidjs'
|
||||
})
|
||||
|
||||
// Using Mustache (requires: npm install mustache)
|
||||
mailingPlugin({
|
||||
templateEngine: 'mustache'
|
||||
})
|
||||
|
||||
// Using simple variable replacement (no dependencies)
|
||||
mailingPlugin({
|
||||
templateEngine: 'simple'
|
||||
})
|
||||
```
|
||||
|
||||
### Custom Template Renderer Hook
|
||||
```typescript
|
||||
// Example with Handlebars
|
||||
import Handlebars from 'handlebars'
|
||||
|
||||
mailingPlugin({
|
||||
templateRenderer: async (template: string, variables: Record<string, any>) => {
|
||||
const compiled = Handlebars.compile(template)
|
||||
return compiled(variables)
|
||||
}
|
||||
})
|
||||
|
||||
// Example with Mustache
|
||||
import Mustache from 'mustache'
|
||||
|
||||
mailingPlugin({
|
||||
templateRenderer: async (template: string, variables: Record<string, any>) => {
|
||||
return Mustache.render(template, variables)
|
||||
}
|
||||
})
|
||||
|
||||
// Example with Nunjucks
|
||||
import nunjucks from 'nunjucks'
|
||||
|
||||
mailingPlugin({
|
||||
templateRenderer: async (template: string, variables: Record<string, any>) => {
|
||||
return nunjucks.renderString(template, variables)
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### Using LiquidJS (Optional)
|
||||
Install the optional dependency:
|
||||
```bash
|
||||
npm install liquidjs
|
||||
# or
|
||||
pnpm add liquidjs
|
||||
```
|
||||
|
||||
### Fallback Mode
|
||||
If no custom renderer is provided and neither LiquidJS nor Mustache are installed, simple `{{variable}}` replacement is used.
|
||||
|
||||
## Template Syntax Reference
|
||||
|
||||
### Mustache Syntax (Logic-less)
|
||||
```mustache
|
||||
Hello {{user.name}},
|
||||
|
||||
{{#user.isPremium}}
|
||||
Welcome to premium! Your balance is {{balance}}.
|
||||
{{/user.isPremium}}
|
||||
|
||||
{{#orders}}
|
||||
Order: {{id}} - {{date}}
|
||||
{{/orders}}
|
||||
```
|
||||
|
||||
### LiquidJS Syntax (With Logic)
|
||||
```liquid
|
||||
Hello {{user.name}},
|
||||
|
||||
{% if user.isPremium %}
|
||||
Welcome to premium! Your balance is {{balance | formatCurrency}}.
|
||||
{% endif %}
|
||||
|
||||
{% for order in orders %}
|
||||
Order: {{order.id}} - {{order.date | formatDate: "short"}}
|
||||
{% endfor %}
|
||||
```
|
||||
|
||||
### Simple Variable Replacement
|
||||
```
|
||||
Hello {{user.name}},
|
||||
Your balance is {{balance}}.
|
||||
```
|
||||
|
||||
## Migration from Handlebars
|
||||
|
||||
### Variables
|
||||
- **Handlebars**: `{{variable}}`
|
||||
- **LiquidJS**: `{{variable}}` (same)
|
||||
|
||||
### Conditionals
|
||||
- **Handlebars**: `{{#if condition}}content{{/if}}`
|
||||
- **LiquidJS**: `{% if condition %}content{% endif %}`
|
||||
|
||||
### Loops
|
||||
- **Handlebars**: `{{#each items}}{{this}}{{/each}}`
|
||||
- **LiquidJS**: `{% for item in items %}{{item}}{% endfor %}`
|
||||
|
||||
### Filters/Helpers
|
||||
- **Handlebars**: `{{formatDate date "short"}}`
|
||||
- **LiquidJS**: `{{date | formatDate: "short"}}`
|
||||
|
||||
### Available Filters
|
||||
- `formatDate` - Format dates (short, long, or default)
|
||||
- `formatCurrency` - Format currency amounts
|
||||
- `capitalize` - Capitalize first letter
|
||||
|
||||
### Comparison Operations (LiquidJS Advantage)
|
||||
- **Handlebars**: Required `{{#ifEquals}}` helper
|
||||
- **LiquidJS**: Built-in: `{% if user.role == "admin" %}`
|
||||
|
||||
## Example Migration
|
||||
|
||||
### Before (Handlebars)
|
||||
```handlebars
|
||||
Hello {{user.name}},
|
||||
|
||||
{{#if user.isPremium}}
|
||||
Welcome to premium! Your balance is {{formatCurrency balance}}.
|
||||
{{/if}}
|
||||
|
||||
{{#each orders}}
|
||||
Order: {{this.id}} - {{formatDate this.date "short"}}
|
||||
{{/each}}
|
||||
```
|
||||
|
||||
### After (LiquidJS)
|
||||
```liquid
|
||||
Hello {{user.name}},
|
||||
|
||||
{% if user.isPremium %}
|
||||
Welcome to premium! Your balance is {{balance | formatCurrency}}.
|
||||
{% endif %}
|
||||
|
||||
{% for order in orders %}
|
||||
Order: {{order.id}} - {{order.date | formatDate: "short"}}
|
||||
{% endfor %}
|
||||
```
|
||||
Reference in New Issue
Block a user