PHPFUI/InstaDoc
 
Copied!
  • property string $campaign_activity_id Identifies a campaign activity in the V3 API.
  • property string $campaign_id Identifies a campaign in the V3 API.
  • property string $role The purpose of the individual campaign activity in the larger email campaign effort. Valid values are:
  • property array $contact_list_ids The contacts that Constant Contact sends the email campaign activity to as an array of contact list_id values. You cannot use contact lists and segments at the same time in an email campaign activity.
  • property array $segment_ids The contacts that Constant Contact sends the email campaign activity to as an array containing a single segment_id value. Only format_type 3, 4, and 5 email campaign activities support segments. You cannot use contact lists and segments at the same time in an email campaign activity.
  • property string $current_status The current status of the email campaign activity. Valid values are:
  • property int $format_type Identifies the type of email format. Valid values are:
  • property string $from_email The email "From Email" field for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to /account/emails to return a collection of account emails and their confirmation status.
  • property string $from_name The email "From Name" field for the email campaign activity.
  • property string $reply_to_email The email "Reply To Email" field for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to /account/emails to return a collection of account emails and their confirmation status.
  • property string $subject The email "Subject" field for the email campaign activity.
  • property string $html_content The HTML or XHTML content for the email campaign activity. Only format_type 1 and 5 (legacy custom code emails or modern custom code emails) can contain html_content.
  • property string $template_id Identifies the email layout and design template that the email campaign activity is using as a base.
  • property string $permalink_url The permanent link to a web accessible version of the email campaign content without any personalized email information. The permalink URL becomes accessible after you send an email campaign to contacts.
  • property string $preheader The email preheader for the email campaign activity. Only format_type 3, 4, and 5 email campaign activities use the preheader property.
  • property \PHPFUI\ConstantContact\Definition\EmailPhysicalAddress $physical_address_in_footer The physical address of the organization that is sending the email campaign. Constant Contact displays this information to contacts in the email message footer.
  • property \PHPFUI\ConstantContact\Definition\DocumentProperties $document_properties An object that contains optional properties for legacy format type emails (format_type 1 and 2). If you attempt to add a property that does apply to the email format_type, the API will ignore the property.
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
Properties
protected static array $fields = ['campaign_activity_id' => 'string', 'campaign_id' => 'string', 'role' => 'string', 'contact_list_ids' => 'array', 'segment_ids' => 'array', 'current_status' => 'string', 'format_type' => 'int', 'from_email' => 'string', 'from_name' => 'string', 'reply_to_email' => 'string', 'subject' => 'string', 'html_content' => 'string', 'template_id' => 'string', 'permalink_url' => 'string', 'preheader' => 'string', 'physical_address_in_footer' => '\PHPFUI\ConstantContact\Definition\EmailPhysicalAddress', 'document_properties' => '\PHPFUI\ConstantContact\Definition\DocumentProperties']
protected static array PHPFUI\ConstantContact\Definition\Base::$maxLength = []
 
  • var array<string,int> maximum allowed values. Arrays are size, int and float are values, strings are length.
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 = ['campaign_activity_id' => 'string', 'campaign_id' => 'string', 'role' => 'string', 'contact_list_ids' => 'array', 'segment_ids' => 'array', 'current_status' => 'string', 'format_type' => 'int', 'from_email' => 'string', 'from_name' => 'string', 'reply_to_email' => 'string', 'subject' => 'string', 'html_content' => 'string', 'template_id' => 'string', 'permalink_url' => 'string', 'preheader' => 'string', 'physical_address_in_footer' => '\PHPFUI\ConstantContact\Definition\EmailPhysicalAddress', 'document_properties' => '\PHPFUI\ConstantContact\Definition\DocumentProperties']
protected static array PHPFUI\ConstantContact\Definition\Base::$maxLength = []
 
  • var array<string,int> maximum allowed values. Arrays are size, int and float are values, strings are length.
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.
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration