Download the PHP package stechstudio/email-event-parser without Composer
On this page you can find all versions of the php package stechstudio/email-event-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download stechstudio/email-event-parser
More information about stechstudio/email-event-parser
Files in stechstudio/email-event-parser
Package email-event-parser
Short Description Parses event data from a variety of email service providers
License MIT
Informations about the package email-event-parser
Email Event Parser
Easily parse event data from a variety of email service providers. Currently supports SendGrid and Mailgun webhook formats.
Installation
Basic usage
When you know where the event is coming from, you can create the adapter yourself:
The adapter $payload
should be an array of event data. It's up to you to json_decode
this if needed. In some cases it might be appropriate to just pass in $_POST
as the payload.
Automatic service detection
If you are expecting webhooks from multiple service providers, you can use the automatic detection:
This will examine the event data and figure out which service sent the event, and which adapter to use.
API
Once you have an event object, here is a list of methods that are available:
Method | Description |
---|---|
getType() | Event type (delivered, bounced, etc) |
getService() | Service provider name (SendGrid, Mailgun) |
getMessageId() | SMTP ID of the email |
getRecipient() | Recipient email address |
getTimestamp() | Unix timestamp for the event |
getResponse() | Response from the remote SMTP server |
getReason() | Additional explanation for the event type |
getCode() | Status or error code |
getTags() | Collection of tag values |
getData() | Additional custom data attached to the email, as a collection of key/value pairs |
get($key) | Retrieve any $key from the original event data payload |
toArray() | Returns... ya know |