simpleweb / silverpopphp

PHP API for Silverpop

Silverpop PHP Client Library

PHP client library for the Silverpop API.

Note. This project is not actively maintained. I suggest if it is useful, you fork your own version of it.

Pull requests that are non-breaking will be merged.

Installation

Installation via composer . Create a composer.json file in the root folder of you project and paste the code below.

{
    "require": {
        "simpleweb/silverpopphp": "master-dev"
    }
}

With composer installed, just run php composer.phar install or simply composer install if you did a global install.

Usage

<?php

// Include the library
require_once 'vendor/autoload.php';

// Require the Silverpop Namespace
use Silverpop\EngagePod;

// Set some useful variables
$databaseID   = 'XXX';
$templateID   = 'XXX';
$contactsList = 'XXX';

// Initialize the library
$silverpop = new EngagePod(array(
  'username'       => 'XXX',
  'password'       => 'XXX',
  'engage_server'  => 4,
));

// Fetch all contact lists
$lists = $silverpop->GetLists(18);
var_dump($lists);

// Add a record to a contact
$recipientID = $silverpop->addContact(
  $databaseID,
  true,
  array(
    'name'  => 'christos',
    'email' => '[email protected]',
  )
);
echo $recipientID;

// Create a new mailing and send in 1 minute
$mailingID = $silverpop->sendEmail(
  $templateID,
  $databaseID,
  'API Mailing Test - ' . date("d/m/Y H:i:s", time()),
  time() + 60,
);
echo $mailingID;

silverpopphp's Issues

Login Error: BLOCKED

Login Error: Unable to login user: [email protected] - BLOCKED. Attempt made from IP address: xxx.xxx.xxx.xxx

I get that when I try to use the library.

Please help.

Versioned releases

It would be great if releases were tagged so within composer we can make sure we are getting specific releases.

/lib/Silverpop/Util/ArrayToXml.php Rename

For the people that load this repo via Composer your ArrayToXML class name does not match the filename which can cause issues in some os' when autloading please rename this file to ArrayToXML.php

Email Image Upload?

Does anyone know if this module, or if there is even a method at all to automate uploading email images into Silverpop?

OAuth authentication?

Do you support OAuth to access the API?

I look through the code and could not find anything about that, so I thought I should ask here.

Thank you,
Radi.

Nomenclature questions, class constants

Hey Guys,

Thanks for writing what looks like a pretty useful library. I've got a couple of questions:

• What's with the naming convention? EngagePod4 doesn't make a lot of sense compared to something like SilverpopApiService or SilverpopClient. What's the motivation behind that? For something you hope others to adopt, it'd be great to have a more sensible name for this class.

• It looks like you've got a bunch of integer values that denote different list types ( https://github.com/simpleweb/SilverpopPHP/blob/master/lib/EngagePod4.php#L41 ). The comments are useful, but from what I've seen, a better practice is to set these as class constants. This would be something like:

  const LIST_TYPE_DATABASE = 0;

It looks like there are some plans to improve documentation, which I'm all for. Constants make the code that consumes this API a bit easier to understand than just passing a strict integer value, and it helps improve documentation because then you can document each constant.

These are just some stray observations. I will likely use this library for some stuff I'd like to work on. So I may contribute these changes back if no one on your end has the time :)

Declared doubleOptInContact() twice

On line 107 and on line 286 you have doubleOptInContact() declared, which function is the correct one to have in the class?

Provide create_from parameter in addContact method

The current addContact method hard codes CREATED_FROM value to 1. Adding as a param, will allow callers to set this value.

Branded domains expiring

Silverpop domains will be retired in 2020 after Silverpop was purchased by Acoustic and the engagepod servers specified will no longer work. They have a blog post with the URL changes located at https://help.goacoustic.com/hc/en-us/articles/360048880034-Standardized-Acoustic-URLs.

Extend silverpop

I would like to extend it in order to export a list but everything is set as private. Is there a way that you intended for this to be extended?

Visitor Key in addContact() and updateContact()

Would it be possible to add the VISITOR_KEY FIELD to the EngagePod->addContact() and EngagePod->updateContact() functions?

Email Arabic character issue

Hi,

Email containing arabic character is not readable. Anybody here to help? Thanks

Need to be able to override _baseURL

My account runs on an instance of Pod5 rather than 4, so I need to be able to set that in the configuration, rather than having it be hard coded.

add addContactToContactList method

When adding email address to a double opt-in database, we first need to use addContact method, followed up with doubleOptInContact to double opt-in the email.

Once the email is double opt-in, need to useaddContactToContactList to assign email to a contact list.

Unable to submit multi-select values

I'm trying to submit data to a "multi-select" field type in Silverpop using the following data;

[title] => mr
[where_purchased] => Array
    (
        [0] => lidl, 
        [1] => mothercare
        [2] => marks and spencer
    )

[your_date_of_birth] => 2000-01-01

But the field is always empty after submission. All other fields are populated correctly.

Error: Class 'Silverpop\Util\ArrayToXML' not found

Hello an thank you for your lib,

I've got an error "Error: Class 'Silverpop\Util\ArrayToXML' not found" because the class name is different from the filename.
This file ArrayToXML.php has to be renamed ArrayToXml because of case sensitivity.

Thank you.

xml2array function problem

I'm having a problem to deploy the new version of this library due an error call to \Silverpop\Util\xml2array. After looking the code I've seen some refactoring would be necessary.

I will raise a pull request (hopefully this week) to make the XML to Array and Array to XML manipulation better...