API Documentation
Back to top  

AbuseReport

Extends \MailChimp\Core\Model

Manage abuse complaints for a specific list. An abuse complaint occurs when your recipient reports an email as spam in their mail program.

package

Default

Methods

__construct

__construct(array $data = NULL)
inherited

Arguments

$data

array

all

all() : \MailChimp\Response\AbuseReportListResponse

Get all abuse reports for a specific list.

Response

\MailChimp\Response\AbuseReportListResponse

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

read

read() : \MailChimp\Models\Lists\AbuseReport

Get details about a specific abuse report.

Response

\MailChimp\Models\Lists\AbuseReport

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 : float

The id for the abuse report

Type(s)

float

campaign_id

campaign_id : string

The campaign id for the abuse report

Type(s)

string

list_id

list_id : string

The list id for the abuse report.

Type(s)

string

email_id

email_id : string

The MD5 hash of the lowercase version of the list member’s email address.

Type(s)

string

email_address

email_address : string

Email address for a subscriber.

Type(s)

string

merge_fields

merge_fields : \MailChimp\Core\HashMap

An individual merge var and value for a member.

Type(s)

\MailChimp\Core\HashMap

vip

vip : boolean

VIP status for subscriber.

Type(s)

boolean

date

date : string

Date for the abuse report

Type(s)

string

_links

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

A list of link types and descriptions for the API schema documents.

Type(s)

array<mixed,\MailChimp\Data\Link>