pixart/addemar

PHP Library to easy talk to the Addemar API

PHP API Wrapper for Addemar

Fully rewritten this old stuff. Is now unittested and contains 3 managers so far., _(*1)

ContactManager
SendingManager
ContactGroupsManager

All correspond with the structure of the addemar documentation here: https://ws-email.addemar.com/docs/current/, _(*2)

Settings

Settings are needed to connect to the client. In the constructor you can set your Token. Other parameters are pre-defined but can be updated., _(*3)

class Settings
{
    private $token;
    private $version = 1.4;
    private $wsdl = 'https://ws-email.addemar.com/soap/wsdl/';
    private $options = array();

    ...
}

Connection

Connection is an extension from the standard SoapClient. You don't need to know much about this component. Just pass your settings and this will give you a working connection., _(*4)

Managers

Managers are just grouping names for functions of a specific catergory. Each manager is contains function that you'll be able to find in the documentation from addemar. You can load a manager by calling the Factory., _(*5)

Example, _(*6)

use Addemar\Factory\ManagerFactory;
use Addemar\Client\Connection;
use Addemar\Configuration\Settings;

$connection = new Connection(new Settings('Your Token'));
ManagerFactory::create($connection, 'Addemar\Manager\ContactGroupsManager');

ContactManager

List of Functions:, _(*7)

getStructure()

Get structure from contact, _(*8)

return: structure ContactData, _(*9)

create($structure)

Create a new contact, _(*10)

• ContactData $contact_data: structure: ContactData

return: integer (contact id), _(*11)

getContactId($status, $filter, $search_field_id = 1)

Get list of contact ids, _(*12)

• integer $status: 0=all 1=not unsubscribed 2=unsubscribed
• string $filter: Text to search on
• integer $search_field_id: Field id to search on

return: integer array (contact id's), _(*13)

getContactData($cid)

Get data from contact specified by the contact id, _(*14)

• integer $cid: Contact id

return: structure ContactData, _(*15)

getFieldIdByName($name)

Get list of field ids, _(*16)

• string $parameter: Field parameter to search on

return: array (field id's), _(*17)

update($contact_data)

Update contact, _(*18)

• ContactData $contact_data: Structure: ContactData

return: boolean (true=successful, false=unsuccessful), _(*19)

delete($cid)

Remove/delete contact specified by the contact id, _(*20)

• integer $cid: Contact id

return: boolean (true=successful, false=unsuccessful), _(*21)

subscribeContact($cid, $mgid)

Subscribe contact specified by the contact id, _(*22)

• integer $cid: Contact id
• integer $mgid: Mailgroup id

return: boolean (true=successful, false=unsuccessful), _(*23)

ContactGroupsManager

List of Functions:, _(*24)

getMailgroupId($name)

Get list of mailgroup ids, _(*25)

• string $name: Mailgroup name to search on

return: array (mailgroup id's), _(*26)

SendingManager

List of Functions:, _(*27)

sendTriggeredItem(SendItem $senditem)

Send triggered item (Campaign Item exists), _(*28)

object $senditem: instance of Addemar\Model\SendItem, _(*29)

return: integer (eid), _(*30)