PHPFUI/InstaDoc
 
Copied!
  • property array $email_addresses Array of email addresses to unsubscribe.
  • property string $update_source Required parameter to specify the update source performing the unsubscribe.
  • property string $opt_out_reason Optional parameter to specify the reason for the unsubscribe.
  • property bool $delete_contacts Optional parameter to specify if the contact(s) should be soft-deleted as part of the unsubscribe.
  • property bool $global_unsubscribe Optional parameter to specify if the contact's email address should be unsubscribed from all partner child accounts. When specified only a single email address in the email_addresses array can be specified.
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::jsonSerialize() : array
 

Impliment JsonSerializable

  • return array representation of data
public PHPFUI\ConstantContact\Definition\Base::toArray() : array
 

More descriptive alternative to getData()

  • return array representation of data
Properties
protected static array $fields = ['email_addresses' => 'array', 'update_source' => ['Account', 'Contact', 'System'], 'opt_out_reason' => 'string', 'delete_contacts' => 'bool', 'global_unsubscribe' => 'bool']
protected static array $maxLength = ['opt_out_reason' => 255]
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 $requiredFields = ['update_source']
Properties
protected static array $fields = ['email_addresses' => 'array', 'update_source' => ['Account', 'Contact', 'System'], 'opt_out_reason' => 'string', 'delete_contacts' => 'bool', 'global_unsubscribe' => 'bool']
protected static array $maxLength = ['opt_out_reason' => 255]
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 $requiredFields = ['update_source']
© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration