API Documentation
Back to top  

Audience

Extends \MailChimp\Core\Model

A Mailchimp list is a powerful and flexible tool that helps you manage your contacts. Learn how to get started with lists in Mailchimp.

package

Default

Methods

__construct

__construct(array $data = NULL)
inherited

Arguments

$data

array

api

api()
inherited

clear

clear()
inherited

config

config()
inherited

getAction

getAction( $name)
inherited

Arguments

$name

Returns an ActionField object specified by `$action` and `$name`

getActionField(string $action, string $name) : \MailChimp\Core\ActionField
inherited

Arguments

$action

string

Action Name

$name

string

Field Name

Response

\MailChimp\Core\ActionField

Returns an array of action fields for an action

getActionFields(string $action) : array<mixed,\MailChimp\Core\ActionField>
inherited

Arguments

$action

string

Response

array<mixed,\MailChimp\Core\ActionField>

Returns Field Information

getField(string $name) : \MailChimp\Core\Field
inherited

Arguments

$name

string

Response

\MailChimp\Core\Field

Gets all allowed fields of a Data

getFields() : array
inherited

Response

array

Return API Path

getPath(\MailChimp\Core\string $child = NULL, array $params = NULL) : string
inherited

Arguments

$child

\MailChimp\Core\string

$params

array

Response

string

Return true if field exists or false otherwise

hasField(string $name) : boolean
inherited

Arguments

$name

string

Field name

Response

boolean

initialize

initialize()
inherited

jsonSerialize

jsonSerialize()
inherited

merge

merge( $data)
inherited

Arguments

$data

own

own( $class,  $args)
inherited

Arguments

$class

$args

parseActionPath

parseActionPath( &$params)
inherited

Arguments

$params

reference

reference( &$field,  $name)
inherited

Arguments

$field

$name

setApi

setApi(\MailChimp\Interfaces\MailChimpInterface &$api)
inherited

Arguments

$api

\MailChimp\Interfaces\MailChimpInterface

setConfig

setConfig(\MailChimp\Interfaces\ConfigInterface &$config)
inherited

Arguments

$config

\MailChimp\Interfaces\ConfigInterface

Properties

API Endpoint

path : string
inherited
var

Type(s)

string

Path Parameters

params : array
inherited
var

Type(s)

array

Action Fields Configurations

action : array
inherited
var

Type(s)

array

Info for all action fields

_action : array
inherited
var

Type(s)

array

Data holder for predefined fields

data : object
inherited
var

Type(s)

object

Info for unreferenced action fields

_fields : array
inherited
var

Type(s)

array

API Query builder

builder : \MailChimp\Core\Builder
inherited
var

Type(s)

\MailChimp\Core\Builder

Fields for the model

fields : array
inherited
var

Type(s)

array

Reference map for fields

_reference : array
inherited
var

Type(s)

array

_api

_api :
inherited

Type(s)

_config

_config :
inherited

Type(s)

id

id : string

Audience List ID

Type(s)

string

name

name : string

The name of the Audience list.

Type(s)

string

contact

contact : \MailChimp\Data\Contact

Contact information displayed in campaign footers to comply with international spam laws.

Type(s)

\MailChimp\Data\Contact

permission_reminder

permission_reminder : string

Type(s)

string

campaign_defaults

campaign_defaults : \MailChimp\Data\CampaignDefaults

Type(s)

\MailChimp\Data\CampaignDefaults

notify_on_subscribe

notify_on_subscribe : string

Type(s)

string

notify_on_unsubscribe

notify_on_unsubscribe : string

Type(s)

string

date_created

date_created : string

Type(s)

string

list_rating

list_rating : integer

Type(s)

integer

email_type_option

email_type_option : boolean

Type(s)

boolean

subscribe_url_short

subscribe_url_short : string

Type(s)

string

subscribe_url_long

subscribe_url_long : string

Type(s)

string

beamer_address

beamer_address : string

Type(s)

string

visibility

visibility : string

Type(s)

string

modules

modules : array

Type(s)

array

stats

stats : \MailChimp\Data\Stats

Type(s)

\MailChimp\Data\Stats

_links

_links : array<mixed,\MailChimp\Data\Link>

Type(s)

array<mixed,\MailChimp\Data\Link>