README

What is this bundle doing ?

This bundle provides Campaigner APIs' as Symfony services.

See Campaigner API User Guide for the list of web services and methods.

Installation

This bundle uses PHP's native SOAP objects.

Make sure soap module is enabled in your PHP's installation.

Download the bundle using composer

$ composer require exs/campaigner-bundle

Enable the bundle

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new EXS\CampaignerBundle\EXSCampaignerBundle(),
        // ...
    );
}

Configuration

Required configuration :

exs_campaigner:
    username: 'someusername'
    password: 'somepassword'

Complete configuration (with default values) :

exs_campaigner:
    username: 'someusername'
    password: 'somepassword'
    # Default values
    wsdl:
        campaign_management: 'https://ws.campaigner.com/2013/01/campaignmanagement.asmx?WSDL'
        contact_management: 'https://ws.campaigner.com/2013/01/contactmanagement.asmx?WSDL'
        content_management: 'https://ws.campaigner.com/2013/01/contentmanagement.asmx?WSDL'
        list_management: 'https://ws.campaigner.com/2013/01/listmanagement.asmx?WSDL'
        smtp_management: 'https://ws.csmtp.net/2014/06/SMTPService.asmx?WSDL'
        workflow_management: 'https://ws.campaigner.com/2013/01/workflowmanagement.asmx?WSDL'
    xsd:
        contacts_search_criteria: '@EXSCampaignerBundle/Resources/xsd/ContactsSearchCriteria2.xsd'

Web services and methods

• Campaign Management Web Service

  Service id : exs_campaigner.campaign_manager

  Methods :

  • CreateUpdateCampaign (Page 91)
  • DeleteCampaign (Page 98)
  • DeleteFromEmail (Page 100)
  • GetCampaignRunsSummaryReport (Page 102)
  • GetCampaignSummary (Page 110)
  • GetTrackedLinkSummaryReport (Page 117)
  • GetUnsubscribeMessages (Page 120)
  • ListCampaigns (Page 123)
  • ListFromEmails (Page 128)
  • ListTrackedLinksByCampaign (Page 131)
  • ScheduleCampaign (Page 134)
  • SendTestCampaign (Page 137)
  • SetCampaignRecipients (Page 139)
  • StopCampaign (Page 141)
  • ValidateFromEmail (Page 143)

• Contact Management Web Service

  Service id : exs_campaigner.contact_manager

  Methods :

  • CreateUpdateAttribute (Page 26)
  • DeleteAttribute (Page 30)
  • DeleteContacts (Page 32)
  • DownloadReport (Page 34)
  • GetContacts (Page 37)
  • GetUploadMassContactsResult (Page 45)
  • GetUploadMassContactsStatus (Page 49)
  • ImmediateUpload (Page 53)
  • InitiateDoubleOptIn (Page 63)
  • ListAttributes (Page 67)
  • ListContactFields (Page 71)
  • ListTestContacts (Page 75)
  • ResubscribeContact (Page 78)
  • RunReport (Page 82)
  • UploadMassContacts (Page 85)

• Content Management Web Service

  Service id : exs_campaigner.content_manager

  Methods :

  • CreateUpdateMyTemplates (Page 157)
  • DeleteMediaFiles (Page 161)
  • GetEmailTemplate (Page 163)
  • ListEmailTemplates (Page 165)
  • ListMediaFiles (Page 168)
  • ListProjects (Page 171)
  • UploadMediaFile (Page 173)

• List Management Web Service

  Service id : exs_campaigner.list_manager

  Methods :

  • CreateUpdateContactGroups (Page 146)
  • DeleteContactGroups (Page 150)
  • ListContactGroups (Page 152)

• SMTPService Web Service

  Service id : exs_campaigner.smtp_manager

  Methods :

  • DownloadReport (Page 183)
  • GetDetailSmtpStatus (Page 185)
  • GetSmtpActivityReport (Page 190)
  • GetSmtpBounceReport (Page 195)
  • GetSmtpReportGroupSummary (Page 200)
  • RunReport (Page 205)

• Workflow Management Web Service

  Service id : exs_campaigner.workflow_manager

  Methods :

  • ListWorkflows (Page 177)
  • TriggerWorkflow (Page 180)