Overview

Namespaces

  • Ctct
    • Auth
    • Components
      • Account
      • Activities
      • Contacts
      • EmailMarketing
      • Tracking
    • Exceptions
    • Services
  • PHP

Classes

  • AccountService
  • ActivityService
  • BaseService
  • CampaignScheduleService
  • CampaignTrackingService
  • ContactService
  • ContactTrackingService
  • EmailMarketingService
  • ListService
  • Overview
  • Namespace
  • Class
  • Tree

Class ListService

Performs all actions pertaining to Constant Contact Lists

Ctct\Services\BaseService
Extended by Ctct\Services\ListService
Namespace: Ctct\Services
Package: Services
Author: Constant Contact
Located at Ctct/Services/ListService.php
Methods summary
public Array
# getLists( mixed $accessToken )

Get lists within an account

Get lists within an account

Parameters

$accessToken
mixed
$accessToken - Constant Contact OAuth2 access token

Returns

Array
- ContactLists
public Ctct\Components\Contacts\ContactList
# addList( string $accessToken, Ctct\Components\Contacts\ContactList $list )

Create a new Contact List

Create a new Contact List

Parameters

$accessToken
string
$accessToken - Constant Contact OAuth2 access token
$list
Ctct\Components\Contacts\ContactList
$list

Returns

Ctct\Components\Contacts\ContactList
public Ctct\Components\Contacts\ContactList
# updateList( string $accessToken, Ctct\Components\Contacts\ContactList $list )

Update a Contact List

Update a Contact List

Parameters

$accessToken
string
$accessToken - Constant Contact OAuth2 access token
$list
Ctct\Components\Contacts\ContactList
$list - ContactList to be updated

Returns

Ctct\Components\Contacts\ContactList
public Ctct\Components\Contacts\ContactList
# getList( mixed $accessToken, mixed $list_id )

Get an individual contact list

Get an individual contact list

Parameters

$accessToken
mixed
$accessToken - Constant Contact OAuth2 access token
$list_id
mixed
$list_id - list id

Returns

Ctct\Components\Contacts\ContactList
public Ctct\Components\ResultSet
# getContactsFromList( string $accessToken, string $list_id, array $params = null )

Get all contacts from an individual list

Get all contacts from an individual list

Parameters

$accessToken
string
$accessToken - Constant Contact OAuth2 access token
$list_id
string
$list_id - list id to retrieve contacts for
$params
array
$params - query params to attach to request

Returns

Ctct\Components\ResultSet
Methods inherited from Ctct\Services\BaseService
__construct(), buildUrl(), getHeaders(), getRestClient()
Properties inherited from Ctct\Services\BaseService
$apiKey, $rest_client
Appconnect PHP SDK API documentation generated by ApiGen 2.8.0