api/v3/examples/MailSettings/Delete.php

   1 <?php
   2 /**
   3  * Test Generated example of using mail_settings delete API
   4  * *
   5  */
   6 function mail_settings_delete_example(){
   7 $params = array(
   8   'id' => 2,
   9 );
  10
  11 try{
  12   $result = civicrm_api3('mail_settings', 'delete', $params);
  13 }
  14 catch (CiviCRM_API3_Exception $e) {
  15   // handle error here
  16   $errorMessage = $e->getMessage();
  17   $errorCode = $e->getErrorCode();
  18   $errorData = $e->getExtraParams();
  19   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  20 }
  21
  22 return $result;
  23 }
  24
  25 /**
  26  * Function returns array of result expected from previous function
  27  */
  28 function mail_settings_delete_expectedresult(){
  29
  30   $expectedResult = array(
  31   'is_error' => 0,
  32   'version' => 3,
  33   'count' => 1,
  34   'values' => 1,
  35 );
  36
  37   return $expectedResult;
  38 }
  39
  40
  41 /*
  42 * This example has been generated from the API test suite. The test that created it is called
  43 *
  44 * testDeleteMailSettings and can be found in
  45 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailSettingsTest.php
  46 *
  47 * You can see the outcome of the API tests at
  48 * https://test.civicrm.org/job/CiviCRM-master-git/
  49 *
  50 * To Learn about the API read
  51 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  52 *
  53 * Browse the api on your own site with the api explorer
  54 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  55 *
  56 * Read more about testing here
  57 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  58 *
  59 * API Standards documentation:
  60 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  61 */