Copied!
  • property \PHPFUI\ConstantContact\UUID[] $contact_ids Exports up to 500 specific contacts. This property is mutually exclusive with all other filtering criteria except withstatus.
  • property \PHPFUI\ConstantContact\UUID[] $list_ids Exports all of the contacts inside of up to 50 contact lists. This property is mutually exclusive with all other filtering criteria except with either status or exclude.
  • property \PHPFUI\ConstantContact\UUID[] $tag_ids Exports contacts assigned one or more of the tags (tag_id) specified. This property is mutually exclusive with all other filtering criteria.
  • property bool $new_subscriber Set to true to only export contacts that subscribed within the last 30 days. Default setting is false. This property is mutually exclusive with all other filtering criteria except with either list_ids or exclude.
  • property int $segment_id Specify the segment_id from which you want to export all contacts that meet the specified segment_criteria. You can only specify one segment_id. This property is mutually exclusive with all other filtering criteria.
  • property array $fields By default , all fields are returned. Use this array to only export specific contact fields. You must export email_address to successfully export email_optin_source, email_optin_date, email_optout_source, email_optout_date, or email_optout_reason.
  • property string $status Allows you to export only contacts that have a specific status value. This property is mutually exclusive with all other filtering criteria except with either contact_ids or list_ids.
  • property \PHPFUI\ConstantContact\Definition\Exclude $exclude
CloneableInstantiable
Methods
public PHPFUI\ConstantContact\Definition\Base::__construct(array $initialValues = [])
public PHPFUI\ConstantContact\Definition\Base::__get(string $field) : ?mixed
 

Unset fields will return null

public PHPFUI\ConstantContact\Definition\Base::__set(string $field, ?mixed $value)
 
  • return mixed value being set to allow for assignment chaining
public PHPFUI\ConstantContact\Definition\Base::getData() : array
 
  • return array representation of data
public PHPFUI\ConstantContact\Definition\Base::getFields() : array
 
  • return array all the valid fields for the object. Index is field name and value is the type.
public PHPFUI\ConstantContact\Definition\Base::getJSON() : string
 
  • return string pretty print JSON
public PHPFUI\ConstantContact\Definition\Base::toArray() : array
 

More descriptive alternative to getData()

  • return array representation of data
Properties
protected static array $fields = ['contact_ids' => 'array<\PHPFUI\ConstantContact\UUID>', 'list_ids' => 'array<\PHPFUI\ConstantContact\UUID>', 'tag_ids' => 'array<\PHPFUI\ConstantContact\UUID>', 'new_subscriber' => 'bool', 'segment_id' => 'int', 'fields' => 'array', 'status' => 'string', 'exclude' => '\PHPFUI\ConstantContact\Definition\Exclude']
protected static array $maxLength = ['contact_ids' => 500, 'list_ids' => 50, 'tag_ids' => 50]
protected static array PHPFUI\ConstantContact\Definition\Base::$minLength = []
 
  • var array<string,int> minimum allowed values. Arrays are size, int and float are values, strings are length.
protected static array PHPFUI\ConstantContact\Definition\Base::$requiredFields = []
 
  • var string[] required fields.
Properties
protected static array $fields = ['contact_ids' => 'array<\PHPFUI\ConstantContact\UUID>', 'list_ids' => 'array<\PHPFUI\ConstantContact\UUID>', 'tag_ids' => 'array<\PHPFUI\ConstantContact\UUID>', 'new_subscriber' => 'bool', 'segment_id' => 'int', 'fields' => 'array', 'status' => 'string', 'exclude' => '\PHPFUI\ConstantContact\Definition\Exclude']
protected static array $maxLength = ['contact_ids' => 500, 'list_ids' => 50, 'tag_ids' => 50]
protected static array PHPFUI\ConstantContact\Definition\Base::$minLength = []
 
  • var array<string,int> minimum allowed values. Arrays are size, int and float are values, strings are length.
protected static array PHPFUI\ConstantContact\Definition\Base::$requiredFields = []
 
  • var string[] required fields.
© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration