api/v3/examples/MailSettings/Get.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the MailSettings.get API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function mail_settings_get_example() {
   9   $params = array(
  10     'domain_id' => 1,
  11     'name' => 'my mail setting',
  12     'domain' => 'setting.com',
  13     'local_part' => 'civicrm+',
  14     'server' => 'localhost',
  15     'username' => 'sue',
  16     'password' => 'pass',
  17     'is_default' => 1,
  18   );
  19
  20   try{
  21     $result = civicrm_api3('MailSettings', 'get', $params);
  22   }
  23   catch (CiviCRM_API3_Exception $e) {
  24     // Handle error here.
  25     $errorMessage = $e->getMessage();
  26     $errorCode = $e->getErrorCode();
  27     $errorData = $e->getExtraParams();
  28     return array(
  29       'is_error' => 1,
  30       'error_message' => $errorMessage,
  31       'error_code' => $errorCode,
  32       'error_data' => $errorData,
  33     );
  34   }
  35
  36   return $result;
  37 }
  38
  39 /**
  40  * Function returns array of result expected from previous function.
  41  *
  42  * @return array
  43  *   API result array
  44  */
  45 function mail_settings_get_expectedresult() {
  46
  47   $expectedResult = array(
  48     'is_error' => 0,
  49     'version' => 3,
  50     'count' => 1,
  51     'id' => 4,
  52     'values' => array(
  53       '4' => array(
  54         'id' => '4',
  55         'domain_id' => '1',
  56         'name' => 'my mail setting',
  57         'is_default' => '1',
  58         'domain' => 'setting.com',
  59         'server' => 'localhost',
  60         'username' => 'sue',
  61         'password' => 'pass',
  62         'is_ssl' => 0,
  63       ),
  64     ),
  65   );
  66
  67   return $expectedResult;
  68 }
  69
  70 /*
  71 * This example has been generated from the API test suite.
  72 * The test that created it is called "testGetMailSettings"
  73 * and can be found at:
  74 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailSettingsTest.php
  75 *
  76 * You can see the outcome of the API tests at
  77 * https://test.civicrm.org/job/CiviCRM-master-git/
  78 *
  79 * To Learn about the API read
  80 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  81 *
  82 * Browse the api on your own site with the api explorer
  83 * http://MYSITE.ORG/path/to/civicrm/api
  84 *
  85 * Read more about testing here
  86 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  87 *
  88 * API Standards documentation:
  89 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  90 */