Overview

Namespaces

  • None
  • PHP

Classes

  • Mandrill
  • Mandrill_Exports
  • Mandrill_Inbound
  • Mandrill_Internal
  • Mandrill_Ips
  • Mandrill_Messages
  • Mandrill_Metadata
  • Mandrill_Rejects
  • Mandrill_Senders
  • Mandrill_Subaccounts
  • Mandrill_Tags
  • Mandrill_Templates
  • Mandrill_Urls
  • Mandrill_Users
  • Mandrill_Webhooks
  • Mandrill_Whitelists

Exceptions

  • Mandrill_Error
  • Mandrill_HttpError
  • Mandrill_Invalid_CustomDNS
  • Mandrill_Invalid_CustomDNSPending
  • Mandrill_Invalid_DeleteDefaultPool
  • Mandrill_Invalid_DeleteNonEmptyPool
  • Mandrill_Invalid_EmptyDefaultPool
  • Mandrill_Invalid_Key
  • Mandrill_Invalid_Reject
  • Mandrill_Invalid_Tag_Name
  • Mandrill_Invalid_Template
  • Mandrill_IP_ProvisionLimit
  • Mandrill_Metadata_FieldLimit
  • Mandrill_NoSendingHistory
  • Mandrill_PaymentRequired
  • Mandrill_PoorReputation
  • Mandrill_ServiceUnavailable
  • Mandrill_Unknown_Export
  • Mandrill_Unknown_InboundDomain
  • Mandrill_Unknown_InboundRoute
  • Mandrill_Unknown_IP
  • Mandrill_Unknown_Message
  • Mandrill_Unknown_MetadataField
  • Mandrill_Unknown_Pool
  • Mandrill_Unknown_Sender
  • Mandrill_Unknown_Subaccount
  • Mandrill_Unknown_Template
  • Mandrill_Unknown_TrackingDomain
  • Mandrill_Unknown_Url
  • Mandrill_Unknown_Webhook
  • Mandrill_ValidationError
  • Overview
  • Namespace
  • Class
  • Tree

Class Mandrill_Metadata

Located at Mandrill/Metadata.php
Methods summary
public
# __construct( Mandrill $master )
public array
# getList( )

Get the list of custom metadata fields indexed for the account.

Get the list of custom metadata fields indexed for the account.

Returns

array
the custom metadata fields for the account - return[] struct the individual custom metadata field info - name string the unique identifier of the metadata field to update - state string the current state of the metadata field, one of "active", "delete", or "index" - view_template string Mustache template to control how the metadata is rendered in your activity log
public struct
# add( string $name, string $view_template = null )

Add a new custom metadata field to be indexed for the account.

Add a new custom metadata field to be indexed for the account.

Parameters

$name
string
$name a unique identifier for the metadata field
$view_template
string
$view_template optional Mustache template to control how the metadata is rendered in your activity log

Returns

struct
the information saved about the new metadata field - name string the unique identifier of the metadata field to update - state string the current state of the metadata field, one of "active", "delete", or "index" - view_template string Mustache template to control how the metadata is rendered in your activity log
public struct
# update( string $name, string $view_template )

Update an existing custom metadata field.

Update an existing custom metadata field.

Parameters

$name
string
$name the unique identifier of the metadata field to update
$view_template
string
$view_template optional Mustache template to control how the metadata is rendered in your activity log

Returns

struct
the information for the updated metadata field - name string the unique identifier of the metadata field to update - state string the current state of the metadata field, one of "active", "delete", or "index" - view_template string Mustache template to control how the metadata is rendered in your activity log
public struct
# delete( string $name )

Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.

Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.

Parameters

$name
string
$name the unique identifier of the metadata field to update

Returns

struct
the information for the deleted metadata field - name string the unique identifier of the metadata field to update - state string the current state of the metadata field, one of "active", "delete", or "index" - view_template string Mustache template to control how the metadata is rendered in your activity log
API documentation generated by ApiGen 2.8.0