Thank you for your order #12345.
", "body_text": "Order Confirmed\n\nThank you for your order #12345." }' ``` ### Send to Multiple Recipients[](#send-to-multiple-recipients) ``` curl -X POST "https://example.com/api/v2/email" \ -H "X-DreamFactory-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "to": [ {"email": "[email protected]", "name": "User One"}, {"email": "[email protected]", "name": "User Two"} ], "cc": [ {"email": "[email protected]", "name": "Manager"} ], "bcc": [ {"email": "[email protected]"} ], "subject": "Team Update", "body_text": "Here is the weekly team update..." }' ``` ### Send with Custom Sender[](#send-with-custom-sender) ``` curl -X POST "https://example.com/api/v2/email" \ -H "X-DreamFactory-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "to": [ {"email": "[email protected]"} ], "from_name": "Support Team", "from_email": "[email protected]", "reply_to_email": "[email protected]", "subject": "Re: Your Support Request", "body_text": "Thank you for contacting support..." }' ``` ### Send with Attachments[](#send-with-attachments) ``` curl -X POST "https://example.com/api/v2/email" \ -H "X-DreamFactory-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "to": [ {"email": "[email protected]"} ], "subject": "Invoice Attached", "body_text": "Please find your invoice attached.", "attachments": [ { "name": "invoice-2026-001.pdf", "content": "JVBERi0xLjQKJeLjz9MKMSAwIG9i...", "content_type": "application/pdf" } ] }' ``` The `content` field must be Base64-encoded. Encode a file: ``` base64 invoice.pdf | tr -d '\n' ``` --- ## Email Templates with Variables[](#email-templates-with-variables) Include dynamic content using placeholders: ``` curl -X POST "https://example.com/api/v2/email" \ -H "X-DreamFactory-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "to": [ {"email": "[email protected]"} ], "subject": "Welcome, {first_name}!", "body_html": "Hello {first_name},
Your account is ready.
", "body_text": "Welcome to {company_name}\n\nHello {first_name},\n\nYour account is ready.", "template_data": { "first_name": "John", "company_name": "Acme Corp" } }' ``` --- ## SMTP Port and Encryption[](#smtp-port-and-encryption) PortEncryptionDescription25NoneUnencrypted (not recommended)465SSLImplicit TLS (legacy)587TLSSTARTTLS (recommended) ### Encryption Types[](#encryption-types) - **TLS (STARTTLS)**: Starts unencrypted, upgrades to encrypted. Use port 587. - **SSL**: Encrypted from the start. Use port 465. - **None**: Unencrypted. Only use for local development. --- ## Authentication Methods[](#authentication-methods) ### Username/Password[](#usernamepassword) Most common method. Use your email credentials or app-specific password. ### OAuth2 (Microsoft 365)[](#oauth2-microsoft-365) For Microsoft 365 with modern authentication, you may need to configure OAuth2 instead of basic authentication. ### AWS SES Credentials[](#aws-ses-credentials) For Amazon SES, generate SMTP credentials in the SES console (different from IAM credentials). --- ## Common Errors[](#common-errors) Error CodeMessageCauseSolution400Bad RequestInvalid email formatCheck recipient addresses401UnauthorizedMissing API keyAdd DreamFactory API key500Authentication failedWrong SMTP credentialsVerify username/password500Connection refusedWrong host/portCheck SMTP server settings500Connection timed outFirewall blockingAllow outbound SMTP ports500Certificate errorTLS issueCheck encryption setting ### Troubleshooting[](#troubleshooting) **Authentication Failed:** 1. Verify username and password are correct 2. For Gmail: Use an App Password, not your regular password 3. Check if account has 2FA enabled (requires app password) 4. Verify the account allows SMTP access **Connection Refused:** 1. Verify the SMTP host is correct 2. Check the port matches the encryption type 3. Ensure firewall allows outbound connections on the port **TLS/SSL Errors:** 1. Match encryption setting with port (587 = TLS, 465 = SSL) 2. Check server certificate validity 3. Try `tls` instead of `ssl` or vice versa ### Test SMTP Connection[](#test-smtp-connection) From the command line: ``` # Test TLS connection (port 587)openssl s_client -starttls smtp -connect smtp.gmail.com:587# Test SSL connection (port 465)openssl s_client -connect smtp.gmail.com:465 ``` --- ## Rate Limits[](#rate-limits) SMTP providers enforce sending limits: ProviderLimitGmail (free)500/dayGoogle Workspace2,000/dayMicrosoft 36510,000/dayAmazon SESBased on account ### Handling Rate Limits[](#handling-rate-limits) 1. **Monitor usage** to stay within limits 2. **Queue emails** for gradual sending 3. **Use dedicated email service** for high volume --- ## Security Best Practices[](#security-best-practices) ### Credential Security[](#credential-security) - Store SMTP passwords in DreamFactory, never in client code - Use app-specific passwords when available - Rotate credentials periodically ### Sender Authentication[](#sender-authentication) Configure these DNS records for better deliverability: 1. **SPF**: Authorize your SMTP server to send for your domain 2. **DKIM**: Sign emails cryptographically 3. **DMARC**: Policy for handling authentication failures ### Access Control[](#access-control) Configure role-based access: 1. Limit which roles can send email 2. Restrict sender addresses if needed 3. Apply rate limiting per role --- ## PHP Mail Configuration[](#php-mail-configuration) For DreamFactory installations using PHP's mail configuration, set these in `.env`: ``` MAIL_DRIVER=smtpMAIL_HOST=smtp.example.comMAIL_PORT=587MAIL_USERNAME=your_usernameMAIL_PASSWORD=your_passwordMAIL_ENCRYPTION=tls[email protected]MAIL_FROM_NAME=DreamFactory ``` --- ## Next Steps[](#next-steps) - **[Email Overview](/api-generation-and-connections/api-types/email/email-overview)**: Compare email service options - **[Role-Based Access Control](/api-security/rbac)**: Restrict email permissions - **[Rate Limiting](/api-security/rate-limiting)**: Prevent email abuse