api/v3/examples/MailSettingsDelete.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function mail_settings_delete_example(){
   7 $params = array(
   8   'domain_id' => 1,
   9   'name' => 'my mail setting',
  10   'domain' => 'setting.com',
  11   'local_part' => 'civicrm+',
  12   'server' => 'localhost',
  13   'username' => 'sue',
  14   'password' => 'pass',
  15   'version' => 3,
  16 );
  17
  18   $result = civicrm_api( 'mail_settings','delete',$params );
  19
  20   return $result;
  21 }
  22
  23 /*
  24  * Function returns array of result expected from previous function
  25  */
  26 function mail_settings_delete_expectedresult(){
  27
  28   $expectedResult = array(
  29   'is_error' => 0,
  30   'version' => 3,
  31   'count' => 1,
  32   'values' => 1,
  33 );
  34
  35   return $expectedResult  ;
  36 }
  37
  38
  39 /*
  40 * This example has been generated from the API test suite. The test that created it is called
  41 *
  42 * testDeleteMailSettings and can be found in
  43 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/MailSettingsTest.php
  44 *
  45 * You can see the outcome of the API tests at
  46 * http://tests.dev.civicrm.org/trunk/results-api_v3
  47 *
  48 * To Learn about the API read
  49 * http://book.civicrm.org/developer/current/techniques/api/
  50 *
  51 * and review the wiki at
  52 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  53 *
  54 * Read more about testing here
  55 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  56 *
  57 * API Standards documentation:
  58 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  59 */