Download the PHP package shoutboxnet/shoutbox without Composer
On this page you can find all versions of the php package shoutboxnet/shoutbox. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shoutboxnet/shoutbox
More information about shoutboxnet/shoutbox
Files in shoutboxnet/shoutbox
Package shoutbox
Short Description Shoutbox.net is a Developer API designed to send transactional emails at scale.
License MIT
Informations about the package shoutbox
Language & Framework guides
Next.js - Typescript - Javascript - Python - PHP - Laravel - Go
Shoutbox.net Developer API
Shoutbox.net is a Developer API designed to send transactional emails at scale. This documentation covers all integration methods, from direct API calls to full framework integration.
Setup
For these integrations to work, you will need an account on Shoutbox.net. You can create and copy the required API key on the Shoutbox.net dashboard!
The API key is required for any call to the Shoutbox.net backend; for SMTP, the API key is your password and 'shoutbox' the user to send emails.
Integration Methods
There are three main ways to integrate with Shoutbox:
- Direct API calls (no dependencies)
- Using our PHP library with Composer
- Laravel framework integration
1. Direct API Integration (No Dependencies)
If you want to avoid dependencies, you can make direct API calls:
Direct API Features
- No dependencies required
- Simple cURL implementation
- Full control over the request
- Lightweight integration
- Suitable for simple implementations
2. PHP Library with Composer
Installation
2.1 API Client Usage
The API client provides an object-oriented interface to the REST API:
2.2 SMTP Client Usage
The SMTP client provides an alternative way to send emails:
Library Features
- Type-safe email options
- Built-in error handling
- File attachment support
- Custom headers support
- Multiple recipient types (to, cc, bcc)
- Choice between API and SMTP clients
3. Laravel Integration
Installation
-
Install the package:
-
Add configuration to
config/services.php
: - Add to
.env
:
Usage Examples
Basic Usage
Advanced Usage
Queue Support
Laravel Features
- Full Laravel Mail integration
- Queue support
- Rate limiting
- Exception handling
- Configuration management
- Service provider auto-discovery
EmailOptions Reference
The EmailOptions
class supports:
- from (string): Sender's email address
- to (string|string[]): Recipient email address(es)
- subject (string): Email subject
- html (string): HTML content
- text (string): Plain text content
- name (string): Sender's name
- replyTo (string): Reply-to address
- cc (string|string[]): CC recipients
- bcc (string|string[]): BCC recipients
- attachments (Attachment[]): File attachments
- headers (array): Custom headers
- tags (array): Email tags
Attachment Properties
- filepath: Path to the file
- filename: Name for the attachment (optional)
- contentType: MIME type (optional)
- content: Base64 encoded content (optional)
Considerations
API vs SMTP Client
- API Client is recommended for most use cases
- SMTP Client is useful for legacy system compatibility
- Both support the same features
Security
- Store API keys securely
- Use environment variables
- Validate email addresses
- Sanitize HTML content
Performance
- Use queues for bulk sending
- Implement rate limiting
- Handle errors gracefully
- Monitor API responses
Testing
- Use test API keys
- Mock API calls in tests
- Verify email delivery
- Check spam scores
Development
-
Clone the repository:
-
Install dependencies:
- Run tests:
Support
- GitHub Issues for bug reports
- Email support for critical issues
- Documentation for guides and examples
- Regular updates and maintenance
License
This library is licensed under the MIT License. See the LICENSE file for details.
All versions of shoutbox with dependencies
vlucas/phpdotenv Version ^5.4
phpmailer/phpmailer Version ^6.8
ext-curl Version *
ext-json Version *
ext-fileinfo Version *