Documentation
Documentation
Everything you need to master Laravel Mail
Quick Start
Getting Started
Learn the basics and set up your first campaign in minutes
Email Campaigns
Create, manage and optimize your email marketing campaigns
Automation
Automate workflows and scale your marketing efforts
Analytics & Reports
Track performance and make data-driven decisions
Getting Started
Welcome to Laravel Mail! This guide will help you get started with the platform and create your first email campaign.
Installation & Setup
Setting up Laravel Mail is quick and easy. Follow these steps to get your account up and running:
- Create Your Account: Sign up at outreachly.com with your email address
- Verify Your Email: Check your inbox for the verification email
- Complete Your Profile: Add your company details and preferences
- Connect Email Provider: Integrate with your email service provider
- Import Contacts: Upload your contact list or connect your CRM
Pro Tip
Make sure to complete email authentication (SPF, DKIM, DMARC) for better deliverability rates.
Quick Setup Code
If you're integrating via API, here's a quick setup example:
// Initialize Laravel Mail SDK import Laravel Mail from '@outreachly/sdk'; const client = new Laravel Mail({ apiKey: 'your_api_key_here', region: 'us-east-1' }); // Create your first campaign const campaign = await client.campaigns.create({ name: 'Welcome Series', subject: 'Welcome to Our Platform!', from: 'hello@yourcompany.com', template: 'welcome-v1' }); console.log('Campaign
created:', campaign.id); # Initialize Laravel Mail SDK from outreachly import Client client = Client( api_key='your_api_key_here', region='us-east-1' ) # Create your first campaign campaign = client.campaigns.create( name='Welcome Series', subject='Welcome to Our Platform!', from_email='hello@yourcompany.com', template='welcome-v1' ) print(f'Campaign created: {campaign.id}') curl -X POST https://api.outreachly.com/v1/campaigns \ -H "Authorization: Bearer your_api_key_here" \ -H "Content-Type: application/json" \ -d '{ "name": "Welcome Series", "subject": "Welcome to Our Platform!", "from": "hello@yourcompany.com", "template": "welcome-v1" }' Configuration Options
Here are the key configuration parameters you can use:
| Parameter | Type | Description |
|---|---|---|
apiKey | string | Your API authentication key |
region | string | Server region (us-east-1, eu-west-1, etc.) |
timeout | number | Request timeout in milliseconds (default: 30000) |
Email Campaigns
Learn how to create, manage, and optimize your email marketing campaigns with Laravel Mail's powerful campaign management system.
Creating Your First Campaign
Follow these steps to create an effective email campaign:
Step 1: Campaign Setup
Navigate to Campaigns → Create New Campaign and fill in the basic details:
const campaign = await client.campaigns.create({ // Basic Information name: 'Summer Sale 2024', subject: 'Get 30% Off Everything This Summer! 🌞', preheader: 'Limited time offer - Shop now', // Sender Information from: { email: 'hello@yourcompany.com', name: 'Your Company' }, replyTo: 'support@yourcompany.com', // Content template: 'sale-template-v2', variables: { discount:
'30%', endDate: '2024-08-31' }, // Targeting segments: ['active-customers', 'vip-list'], excludeSegments: ['recent-purchasers'], // Scheduling sendAt: '2024-07-15T10:00:00Z', timezone: 'America/New_York', // Advanced Options trackOpens: true, trackClicks: true, enableABTest: true, abTestVariants: ['subject-a', 'subject-b'] }); Best Practice
Always test your campaigns with a small segment before sending to your entire list. Use A/B testing to optimize subject lines, content, and send times.
Step 2: Design Your Email
Use our drag-and-drop editor or code your own HTML template:
- Drag & Drop Editor: No coding required, perfect for quick campaigns
- HTML Editor: Full control over design and layout
- AI Template Generator: Generate templates using AI based on your requirements
- Template Library: Choose from 100+ pre-designed templates
Step 3: Add Personalization
Use merge tags to personalize your emails:
Hi {{firstName}}, We noticed you were interested in {{lastViewedProduct}}. Good news! It's now {{discount}}% off as part of our {{campaignName}}. Your exclusive code: {{uniqueCouponCode}} Best regards, {{senderName}} P.S. This offer expires on {{expiryDate | date: 'MMMM dd, yyyy'}} Campaign Types
Laravel Mail supports various campaign types for different use cases:
Broadcast
Send one-time emails to your entire list or specific segments
Drip Sequence
Automated series of emails sent over time
Triggered
Emails triggered by user actions or events
A/B Test
Test different versions to optimize performance
Important
Always include an unsubscribe link in your emails to comply with CAN-SPAM and GDPR regulations. Laravel Mail automatically adds this to all campaigns.
Marketing Automation
Automate your marketing workflows to save time and improve engagement with your audience.
Creating Automation Workflows
Automation workflows allow you to set up sophisticated email sequences based on user behavior, time delays, and conditional logic.
Workflow Structure
Every workflow consists of three main components:
- Trigger: What starts the workflow (e.g., new subscriber, purchase, form submission)
- Actions: What happens in the workflow (send email, wait, add tag, etc.)
- Conditions: Logic that determines the path users take
const workflow = await client.automation.create({ name: 'Welcome Sequence', // Trigger: When someone subscribes trigger: { type: 'subscriber.created', filters: { source: 'website-form' } }, // Workflow Steps steps: [ { type: 'send_email', template: 'welcome-email-1', subject: 'Welcome to {{companyName}}! 🎉' }, { type: 'wait', duration: '2 days' }, { type: 'condition',
condition: 'email.opened', ifTrue: [ { type: 'send_email', template: 'welcome-email-2', subject: 'Here\'s what you can do next' } ], ifFalse: [ { type: 'send_email', template: 'welcome-email-alternate', subject: 'We\'d love to help you get started' } ] }, { type: 'wait', duration: '3 days' }, { type: 'send_email', template: 'welcome-email-3', subject: 'Your exclusive offer inside
🎁' }, { type: 'add_tag', tags: ['welcomed', 'engaged'] } ] }); Popular Automation Templates
Welcome Series
Onboard new subscribers with a series of educational emails
Abandoned Cart Recovery
Recover lost sales with timely cart abandonment emails
Re-engagement Campaign
Win back inactive subscribers with targeted content
Advanced Workflow Features
Conditional Logic
Use conditions to create dynamic workflows that adapt to user behavior:
- Email Engagement: Branch based on opens, clicks, or no activity
- User Properties: Segment by demographics, location, or custom fields
- Behavioral Triggers: React to purchases, page visits, or app events
- Time-Based Rules: Send emails at optimal times for each user
Pro Tip
Use our AI-powered workflow builder to automatically create optimized sequences based on your goals and audience data.
Analytics & Reporting
Track your campaign performance and make data-driven decisions with Laravel Mail's comprehensive analytics suite.
Key Metrics
Monitor these essential metrics to measure your email marketing success:
Open Rate
Percentage of recipients who opened your email
Industry Average:
21.5%
Click-Through Rate
Percentage who clicked on links in your email
Industry Average:
2.6%
Conversion Rate
Percentage who completed desired action
Industry Average:
1.3%
Bounce Rate
Percentage of undeliverable emails
Target:
< 2%
Accessing Analytics Data
Retrieve analytics data programmatically using our API:
// Get detailed analytics for a campaign const analytics = await client.analytics.getCampaign({ campaignId: 'camp_123456', metrics: ['opens', 'clicks', 'conversions', 'revenue'], groupBy: 'day', startDate: '2024-07-01', endDate: '2024-07-31' }); console.log('Total Opens:', analytics.opens.total); console.log('Unique Opens:', analytics.opens.unique); console.log('Open Rate:',
analytics.opens.rate); console.log('Revenue Generated:', analytics.revenue.total); // Get segment performance comparison const segmentAnalytics = await client.analytics.getSegments({ campaignId: 'camp_123456', segments: ['vip-customers', 'regular-customers'], metrics: ['opens', 'clicks', 'conversions'] }); // Export data to CSV const csvData = await client.analytics.export({
campaignId: 'camp_123456', format: 'csv', fields: ['email', 'opens', 'clicks', 'revenue'] }); Custom Reports
Create custom reports tailored to your specific needs:
- Campaign Performance: Compare multiple campaigns side-by-side
- Segment Analysis: Understand how different audiences engage
- Time-Based Trends: Identify patterns in engagement over time
- Revenue Attribution: Track ROI and revenue generated by campaigns
- Deliverability Reports: Monitor email health and reputation
Advanced Analytics
Upgrade to our Pro plan to access predictive analytics, AI-powered insights, and advanced segmentation analysis.
Video Tutorials
Watch step-by-step video guides to master Laravel Mail quickly
Getting Started with Laravel Mail
A complete walkthrough for new users
Creating Your First Campaign
Step-by-step campaign creation guide
Advanced Automation Workflows
Build complex automation sequences
Analytics & Reporting Deep Dive
Master data analysis and reporting
Frequently Asked Questions
Quick answers to common questions about Laravel Mail
Related Articles
Email Deliverability Best Practices
Learn how to maximize inbox placement and avoid spam filters
Building Effective Drip Campaigns
Step-by-step guide to creating high-converting email sequences
API Integration Guide
Complete reference for integrating Laravel Mail into your app
Need More Help?
Can't find what you're looking for? Our support team is here to help you succeed.