api/v3/examples/MailSettings/GetOptions.php

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