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