Ctct\ConstantContact
Exposes all implemented Constant Contact API functionality
- Author: Constant Contact
Synopsis
class ConstantContact
{
- // members
- private $apiKey;
- private ContactService $contactService;
- private CampaignService $emailMarketingService;
- private ListService $listService;
- private ActivityService $activityService;
- private CampaignTrackingService $campaignTrackingService;
- private ContactTrackingService $contactTrackingService;
- private CampaignScheduleService $campaignScheduleService;
- private AccountService $accountService;
- // methods
- public void __construct()
- public ResultSet getContacts()
- public Contact getContact()
- public ResultSet getContactByEmail()
- public Contact addContact()
- public boolean deleteContact()
- public boolean deleteContactFromLists()
- public boolean deleteContactFromList()
- public Contact updateContact()
- public array getLists()
- public ContactList getList()
- public ContactList addList()
- public ContactList updateList()
- public ResultSet getContactsFromList()
- public ResultSet getEmailCampaigns()
- public void getEmailCampaign()
- public boolean deleteEmailCampaign()
- public Campaign addEmailCampaign()
- public Campaign updateEmailCampaign()
- public Campaign addEmailCampaignSchedule()
- public array getEmailCampaignSchedules()
- public Schedule getEmailCampaignSchedule()
- public Schedule updateEmailCampaignSchedule()
- public boolean deleteEmailCampaignSchedule()
- public TestSend sendEmailCampaignTest()
- public TrackingActivity getEmailCampaignSends()
- public ResultSet getEmailCampaignBounces()
- public ResultSet getEmailCampaignClicks()
- public ResultSet getEmailCampaignOpens()
- public ResultSet getEmailCampaignForwards()
- public ResultSet getEmailCampaignUnsubscribes()
- public TrackingSummary getEmailCampaignSummaryReport()
- public ResultSet getContactSends()
- public ResultSet getContactBounces()
- public ResultSet getContactClicks()
- public ResultSet getContactOpens()
- public ResultSet getContactForwards()
- public TrackingActivity getContactUnsubscribes()
- public array getVerifiedEmailAddresses()
- public TrackingSummary getContactSummaryReport()
- public array getActivities()
- public Activity getActivity()
- public void addCreateContactsActivity()
- public void addClearListsActivity()
- public void addRemoveContactsFromListsActivity()
- public Activity addExportContactsActivity()
- private int getArgumentId()
- private array determineParam()
Members
private
- $accountService
—
Ctct\Services\AccountService
AccountService - $activityService
—
Ctct\Services\ActivityService
ActivityService - $apiKey
—
string
Constant Contact API Key - $campaignScheduleService
—
Ctct\Services\CampaignScheduleService
CampaignScheduleService - $campaignTrackingService
—
Ctct\Services\CampaignTrackingService
CampaignTrackingService - $contactService
—
Ctct\Services\ContactService
ContactService - $contactTrackingService
—
Ctct\Services\ContactTrackingService
ContactTrackingService - $emailMarketingService
—
Ctct\CampaignService
CampaignService - $listService
—
Ctct\Services\ListService
ListService
Methods
private
- determineParam() — Builds an array of query parameters to be added to the request
- getArgumentId() — Get the id of object, or attempt to convert the argument to an int
public
- __construct() — Class constructor
- addClearListsActivity() — Add an ClearLists Activity to remove all contacts from the provided lists
- addContact() — Add a new contact to an account
- addCreateContactsActivity() — Add an AddContacts Activity to add contacts in bulk
- addEmailCampaign() — Create a new campaign
- addEmailCampaignSchedule() — Schedule a campaign to be sent
- addExportContactsActivity() — Create an Export Contacts Activity
- addList() — Add a new contact list to an account
- addRemoveContactsFromListsActivity() — Add a Remove Contacts From Lists Activity
- deleteContact() — Sets an individual contact to 'REMOVED' status
- deleteContactFromList() — Delete a contact from all contact lists
- deleteContactFromLists() — Delete a contact from all contact lists
- deleteEmailCampaign() — Delete an individual campaign
- deleteEmailCampaignSchedule() — Delete a specific schedule associated with a given campaign
- getActivities() — Get an array of activities
- getActivity() — Get a single activity by id
- getContact() — Get an individual contact
- getContactBounces() — Get bounces for a Contact
- getContactByEmail() — Get contacts with a specified email eaddress
- getContactClicks() — Get clicks for a Contact
- getContactForwards() — Get forwards for a Contact
- getContactOpens() — Get opens for a Contact
- getContactSends() — Get sends for a Contact
- getContactSummaryReport() — Get a reporting summary for a Contact
- getContactUnsubscribes() — Get opt outs for a Contact
- getContacts() — Get a set of campaigns
- getContactsFromList() — Get contact that belong to a specific list
- getEmailCampaign() — Get an individual campaign
- getEmailCampaignBounces() — Get bounces for a campaign
- getEmailCampaignClicks() — Get clicks for a campaign
- getEmailCampaignForwards() — Get forwards for a campaign
- getEmailCampaignOpens() — Get opens for a campaign
- getEmailCampaignSchedule() — Get a specific schedule associated with a given campaign
- getEmailCampaignSchedules() — Get an array of schedules associated with a given campaign
- getEmailCampaignSends() — Get sends for a campaign
- getEmailCampaignSummaryReport() — Get a reporting summary for a campaign
- getEmailCampaignUnsubscribes() — Get unsubscribes for a campaign
- getEmailCampaigns() — Get a set of campaigns
- getList() — Get an individual list
- getLists() — Get lists
- getVerifiedEmailAddresses() — Get verified addresses for the account
- sendEmailCampaignTest() — Send a test send of a campaign
- updateContact() — Update an individual contact
- updateEmailCampaign() — Update a specific campaign
- updateEmailCampaignSchedule() — Update a specific schedule associated with a given campaign
- updateList() — Update a contact list