sddproductions/sdd-sparkpost-transport-bundle

SDDProductions/SDDSparkPostTransportBundle Bundle

0.1 2017-01-03 08:39 UTC

This package is not auto-updated.

Last update: 2024-10-26 21:03:52 UTC


README

This bundle is an integration between DigitalState/Platform-Transport-Bundle and SparkPost/php-sparkpost

Configuration

The ususal composer require !

Transport and Profile configuration

Transport

You need to add a new Transport with the following data:

{
    "api_key":"YOUR_SPARKPOST_API_KEY",
    "allowed_sender_domains":
    [
        "example.com",
        "other.example.com"
    ]
}

The api_key is self explanatory. The allowed_sender_domains is the list of domains that are currently allowed and configured in SparkPost.

Profile

You need to add a new profile with the following data:

The Field send_from is used to configured the emails will that is used to send emails through the Transport

Possible values :

  • Send from specific email:
{
    "send_from": {
        "fullName" : "John Doe",
        "email" : "john.doe@example.com"
    }    
}
  • WIP:CURRENT_USER The from address will be the email address of the current connected user (The user pressing the SEND Button)
{
   "send_from":"CURRENT_USER"
}
  • WIP: ENTITY_OWNER The from address will be the email address of the user that is the Owner of the recipient
{
   "send_from":"ENTITY_OWNER"
}