function MCAPI::ping in Mailchimp 5

Same name and namespace in other branches

1. 5.2 MCAPI.class.php \MCAPI::ping()
2. 6.2 MCAPI.class.php \MCAPI::ping()
3. 6 MCAPI.class.php \MCAPI::ping()
4. 7 MCAPI.class.php \MCAPI::ping()

"Ping" the MailChimp API - a simple method you can call that will return a constant value as long as everything is good. Note than unlike most all of our methods, we don't throw an Exception if we are having issues. You will simply receive a different string back that will explain our view on what is going on.

@section Helper @example xml-rpc_ping.php

Return value

string returns "Everything's Chimpy!" if everything is chimpy, otherwise returns an error message

File

./MCAPI.class.php, line 1007

Class

MCAPI

Code

function ping() {
  $params = array();
  return $this
    ->callServer("ping", $params);
}