Download the PHP package ravisystems/ravimail-php without Composer
On this page you can find all versions of the php package ravisystems/ravimail-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ravisystems/ravimail-php
More information about ravisystems/ravimail-php
Files in ravisystems/ravimail-php
Package ravimail-php
Short Description Official PHP SDK for the RaviMail REST API v1 (api.ravimail.com.br).
License MIT
Homepage https://docs.ravimail.com.br
Informations about the package ravimail-php
RaviMail PHP SDK
Official PHP client for the RaviMail REST API v1.
Zero framework dependencies — only ext-curl + ext-json.
Why this exists. RaviMail is a Brazilian email infrastructure platform with 155 documented REST endpoints. This SDK gives you typed access to all of them, with idiomatic PHP 8.1+ ergonomics and clear exception hierarchy.
Installation
Requirements: PHP 8.1+, ext-curl, ext-json.
Quickstart — Hello World
That's it. The SDK takes care of auth, JSON encoding, error parsing, and timeouts.
Test mode (no billing, no real send)
Any token prefixed with rvm_test_* enables sandbox mode automatically. You can
develop end-to-end without spending credits.
Send to the Mailbox Simulator for
deterministic scenarios: [email protected], complaint@...,
opened@..., etc.
Available resources
All 23 resources mirror the REST API exactly. Most are CRUD; a few have helpers.
| Resource | What it covers |
|---|---|
$rm->me |
Token info + quotas |
$rm->transactional |
send, batch, list, get |
$rm->contacts |
CRUD + tags + suppress + bulk import |
$rm->lists |
CRUD |
$rm->templates |
CRUD + render + versioning |
$rm->campaigns |
CRUD + start/pause/resume/cancel/duplicate |
$rm->domains |
Add, verify, upgrade-to-panel |
$rm->files |
Upload (attachments) |
$rm->webhooks |
Endpoints + deliveries + rotateSecret + signature verifier |
$rm->suppression |
Suppress / unsuppress |
$rm->analytics |
Summary / timeseries / by domain, IP, node, ISP, device, country / heatmap |
$rm->events |
List + SSE stream URL |
$rm->verification |
Email + batch (DNS + MX + disposable + role detection) |
$rm->segments |
Dynamic segments + compute |
$rm->exports |
Async CSV jobs |
$rm->inboundRoutes |
Inbound parsing → forward webhook |
$rm->drips |
Drip campaigns + steps + subscribe |
$rm->subaccounts |
Multi-tenant (agency mode) |
$rm->reputation |
Score per domain / IP / node + summary |
$rm->customFields |
Custom field schema CRUD |
$rm->reports |
Scheduled reports |
$rm->account |
Billing + balance |
$rm->smtpRelay |
SMTP credentials lifecycle |
See examples/ for runnable snippets covering the most common flows.
Idempotency keys
For any write operation you want to retry safely, pass an Idempotency-Key:
The API guarantees that the second call with the same key returns the original response, byte for byte, even days later.
Webhook signature verification (server-side)
Webhooks are HMAC-signed with the per-endpoint signing_secret returned at
creation time.
Constant-time comparison via hash_equals internally — no timing leak.
Error handling
All non-2xx responses throw. Catch the most specific exception first.
The base ApiException exposes ->getCode() (HTTP status) and ->getMessage()
(server's title — detail if present).
Configuration
Links
- 📚 Full docs — concept guides, cookbooks, troubleshooting
- 🔌 API reference — 155 endpoints, all groups
- 📝 Changelog — releases history
- 💡 Conceitos — warmup, bounces, DKIM/SPF/DMARC explained
- 🐛 Issues — bug reports & feature requests
- 🤝 Contributing
License
MIT © Ravi Systems LTDA
All versions of ravimail-php with dependencies
ext-curl Version *
ext-json Version *