3 * Test Generated example of using mail_settings create API
6 function mail_settings_create_example(){
9 'name' => 'my mail setting',
10 'domain' => 'setting.com',
11 'local_part' => 'civicrm+',
12 'server' => 'localhost',
18 $result = civicrm_api3('mail_settings', 'create', $params);
20 catch (CiviCRM_API3_Exception
$e) {
22 $errorMessage = $e->getMessage();
23 $errorCode = $e->getErrorCode();
24 $errorData = $e->getExtraParams();
25 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
32 * Function returns array of result expected from previous function
34 function mail_settings_create_expectedresult(){
36 $expectedResult = array(
45 'name' => 'my mail setting',
47 'domain' => 'setting.com',
51 'server' => 'localhost',
61 return $expectedResult;
66 * This example has been generated from the API test suite. The test that created it is called
68 * testCreateMailSettings and can be found in
69 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailSettingsTest.php
71 * You can see the outcome of the API tests at
72 * https://test.civicrm.org/job/CiviCRM-master-git/
74 * To Learn about the API read
75 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
77 * Browse the api on your own site with the api explorer
78 * http://MYSITE.ORG/path/to/civicrm/api/explorer
80 * Read more about testing here
81 * http://wiki.civicrm.org/confluence/display/CRM/Testing
83 * API Standards documentation:
84 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards