class MailchimpTemplates in Mailchimp 8

Mailchimp Templates library.

@package Mailchimp

Hierarchy

• class \Mailchimp\Mailchimp
  • class \Mailchimp\MailchimpTemplates

2 string references to 'MailchimpTemplates'

mailchimp_campaign_get_template in modules/mailchimp_campaign/mailchimp_campaign.module

Return full details for a Mailchimp Template.

mailchimp_campaign_list_templates in modules/mailchimp_campaign/mailchimp_campaign.module

Return all available user templates.

File

lib/mailchimp-api-php/src/MailchimpTemplates.php, line 10

Namespace

Mailchimp

class MailchimpTemplates extends Mailchimp {

  /**
   * Gets information about all templates owned by the authenticated account.
   *
   * @param array $parameters
   *   Associative array of optional request parameters.
   *
   * @return object
   *
   * @see http://developer.mailchimp.com/documentation/mailchimp/reference/templates/#read-get_templates
   */
  public function getTemplates($parameters = []) {
    return $this
      ->request('GET', '/templates', NULL, $parameters);
  }

  /**
   * Gets information a specific template.
   *
   * @param string $template_id
   *   The ID of the template.
   * @param array $parameters
   *   Associative array of optional request parameters.
   *
   * @return object
   *
   * @see http://developer.mailchimp.com/documentation/mailchimp/reference/templates/#read-get_templates_template_id
   */
  public function getTemplate($template_id, $parameters = []) {
    $tokens = [
      'template_id' => $template_id,
    ];
    return $this
      ->request('GET', '/templates/{template_id}', $tokens, $parameters);
  }

  /**
   * Gets the default content of a specific template.
   *
   * @param string $template_id
   *   The ID of the template.
   * @param array $parameters
   *   Associative array of optional request parameters.
   *
   * @return object
   *
   * @see http://developer.mailchimp.com/documentation/mailchimp/reference/templates/default-content/#read-get_templates_template_id_default_content
   */
  public function getTemplateContent($template_id, $parameters = []) {
    $tokens = [
      'template_id' => $template_id,
    ];
    return $this
      ->request('GET', '/templates/{template_id}/default-content', $tokens, $parameters);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Mailchimp::$api_key	private	property	The Mailchimp API key to authenticate with.
Mailchimp::$api_user	private	property	The Mailchimp API username to authenticate with.
Mailchimp::$batch_operations	private	property	Array of pending batch operations.
Mailchimp::$client	protected	property	The HTTP client.
Mailchimp::$debug_error_code	private	property	A Mailchimp API error code to return with every API response.
Mailchimp::$endpoint	protected	property	The REST API endpoint.
Mailchimp::$version	public	property	API version.
Mailchimp::addBatchOperation	protected	function	Adds a pending batch operation.
Mailchimp::DEFAULT_DATA_CENTER		constant
Mailchimp::ERROR_CODE_API_KEY_INVALID		constant
Mailchimp::ERROR_CODE_API_KEY_MISSING		constant
Mailchimp::ERROR_CODE_BAD_REQUEST		constant
Mailchimp::ERROR_CODE_COMPLIANCE_RELATED		constant
Mailchimp::ERROR_CODE_FORBIDDEN		constant
Mailchimp::ERROR_CODE_INTERNAL_SERVER_ERROR		constant
Mailchimp::ERROR_CODE_INVALID_ACTION		constant
Mailchimp::ERROR_CODE_INVALID_METHOD_OVERRIDE		constant
Mailchimp::ERROR_CODE_INVALID_RESOURCE		constant
Mailchimp::ERROR_CODE_JSON_PARSE_ERROR		constant
Mailchimp::ERROR_CODE_METHOD_NOT_ALLOWED		constant
Mailchimp::ERROR_CODE_REQUESTED_FIELDS_INVALID		constant
Mailchimp::ERROR_CODE_RESOURCE_NESTING_TOO_DEEP		constant
Mailchimp::ERROR_CODE_RESOURCE_NOT_FOUND		constant
Mailchimp::ERROR_CODE_TOO_MANY_REQUESTS		constant
Mailchimp::ERROR_CODE_USER_DISABLED		constant
Mailchimp::ERROR_CODE_WRONG_DATACENTER		constant
Mailchimp::getAccount	public	function	Gets Mailchimp account information for the authenticated account.
Mailchimp::getBatchOperation	public	function	Gets the status of a batch request.
Mailchimp::getDataCenter	private	function	Gets the ID of the data center associated with an API key.
Mailchimp::getDefaultHttpClient	private	function	Instantiates a default HTTP client based on the local environment.
Mailchimp::processBatchOperations	public	function	Processes all pending batch operations.
Mailchimp::request	public	function	Makes a request to the Mailchimp API.
Mailchimp::setClient	public	function	Sets a custom HTTP client to be used for all API requests.
Mailchimp::setDebugErrorCode	public	function	Sets a Mailchimp error code to be returned by all requests.
Mailchimp::VERSION		constant
Mailchimp::__construct	public	function	Mailchimp constructor.	7
MailchimpTemplates::getTemplate	public	function	Gets information a specific template.
MailchimpTemplates::getTemplateContent	public	function	Gets the default content of a specific template.
MailchimpTemplates::getTemplates	public	function	Gets information about all templates owned by the authenticated account.