Overview

Namespaces

  • Ctct
    • Auth
    • Components
      • Account
      • Activities
      • Contacts
      • EmailMarketing
      • Library
      • Tracking
    • Exceptions
    • Services
    • Util
    • WebHooks

Classes

  • Address
  • Contact
  • ContactList
  • CustomField
  • EmailAddress
  • Note
  • Overview
  • Namespace
  • Class

Class Contact

Represents a single Contact in Constant Contact

Ctct\Components\Component
Extended by Ctct\Components\Contacts\Contact
Namespace: Ctct\Components\Contacts
Package: Components\Contacts
Author: Constant Contact
Located at Components/Contacts/Contact.php
Methods summary
public static Ctct\Components\Contacts\Contact
# create( array $props )

Factory method to create a Contact object from an array

Factory method to create a Contact object from an array

Parameters

$props
  • Associative array of initial properties to set

Returns

Ctct\Components\Contacts\Contact
public
# addList( mixed $contactList )

Add a ContactList

Add a ContactList

Parameters

$contactList
  • ContactList object or contact list id
public
# addEmail( mixed $emailAddress )

Add an EmailAddress

Add an EmailAddress

Parameters

$emailAddress
  • EmailAddress object or email address
public
# addCustomField( Ctct\Components\Contacts\CustomField $customField )

Add a custom field to the contact object

Add a custom field to the contact object

Parameters

$customField
  • custom field to add to the contact
public
# addAddress( Ctct\Components\Contacts\Address $address )

Add an address

Add an address

Parameters

$address
  • Address to add
public
# toJson( )
Methods inherited from Ctct\Components\Component
getValue()
Properties summary
public string $id

Unique identifier for the contact

Unique identifier for the contact

#
public string $status

Status of the contact, must be one of "ACTIVE", "UNCONFIRMED", "OPTOUT", "REMOVED", "NON_SUBSCRIBER", "VISITOR"

Status of the contact, must be one of "ACTIVE", "UNCONFIRMED", "OPTOUT", "REMOVED", "NON_SUBSCRIBER", "VISITOR"

#
public string $first_name

First name of the contact

First name of the contact

#
public string $last_name

Last name of the contact

Last name of the contact

#
public boolean $confirmed

Whether or not the contact is confirmed

Whether or not the contact is confirmed

#
public string $source

Contact source information

Contact source information

#
public Ctct\Components\Contacts\EmailAddress[] $email_addresses

Array of email addresses associated with this contact

Array of email addresses associated with this contact

# array()
public string $prefix_name

The prefix name of the contact

The prefix name of the contact

#
public string $job_title

The job title of the contact

The job title of the contact

#
public Ctct\Components\Contacts\Address[] $addresses

Array of addresses associated with this contact

Array of addresses associated with this contact

# array()
public Ctct\Components\Contacts\Note[] $notes

Array of notes associated with this contact

Array of notes associated with this contact

# array()
public string $company_name

Company name this contact works for

Company name this contact works for

#
public string $home_phone

Contact's home phone number

Contact's home phone number

#
public string $work_phone

Contact's work phone number

Contact's work phone number

#
public string $cell_phone

Contact's cell phone number

Contact's cell phone number

#
public string $fax

Contact's fax number

Contact's fax number

#
public Ctct\Components\Contacts\CustomField[] $custom_fields

Array of custom fields associated with this contact

Array of custom fields associated with this contact

# array()
public Ctct\Components\Contacts\ContactList[] $lists

Array of contact lists this contact belongs to

Array of contact lists this contact belongs to

# array()
public string $created_date

Date the contact was created

Date the contact was created

#
public string $modified_date

Date the contact was last modified

Date the contact was last modified

#
public string $source_details

Contact source details

Contact source details

#
API documentation generated by ApiGen