Skip to content

Mandrill_Metadata

Mathieu Nayrolles edited this page Jan 20, 2016 · 1 revision

Mandrill_Metadata

  • Class name: Mandrill_Metadata
  • Namespace:

Methods

__construct

mixed Mandrill_Metadata::__construct(\Mandrill $master)
  • Visibility: public

Arguments

getList

array Mandrill_Metadata::getList()

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

  • Visibility: public

add

\struct Mandrill_Metadata::add(string $name, string $view_template)

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

  • Visibility: public

Arguments

  • $name string - <p>a unique identifier for the metadata field</p>
  • $view_template string - <p>optional Mustache template to control how the metadata is rendered in your activity log</p>

update

\struct Mandrill_Metadata::update(string $name, string $view_template)

Update an existing custom metadata field.

  • Visibility: public

Arguments

  • $name string - <p>the unique identifier of the metadata field to update</p>
  • $view_template string - <p>optional Mustache template to control how the metadata is rendered in your activity log</p>

delete

\struct Mandrill_Metadata::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.

  • Visibility: public

Arguments

  • $name string - <p>the unique identifier of the metadata field to update</p>
Clone this wiki locally