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( | |
5be22f39 | 29 | 'is_error' => 1, |
30 | 'error_message' => $errorMessage, | |
50fb255d | 31 | 'error_code' => $errorCode, |
32 | 'error_data' => $errorData, | |
33 | ); | |
34 | } | |
35 | ||
36 | return $result; | |
6a488035 TO |
37 | } |
38 | ||
fb32de45 | 39 | /** |
50fb255d | 40 | * Function returns array of result expected from previous function. |
41 | * | |
42 | * @return array | |
43 | * API result array | |
6a488035 | 44 | */ |
50fb255d | 45 | function mail_settings_get_expectedresult() { |
6a488035 | 46 | |
53ca8fd7 | 47 | $expectedResult = array( |
50fb255d | 48 | 'is_error' => 0, |
49 | 'version' => 3, | |
50 | 'count' => 1, | |
51 | 'id' => 4, | |
52 | 'values' => array( | |
89bf81b4 | 53 | '4' => array( |
50fb255d | 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 | ), | |
6a488035 | 64 | ), |
50fb255d | 65 | ); |
6a488035 | 66 | |
fb32de45 | 67 | return $expectedResult; |
6a488035 TO |
68 | } |
69 | ||
a828d7b8 | 70 | /* |
50fb255d | 71 | * This example has been generated from the API test suite. |
a828d7b8 CW |
72 | * The test that created it is called "testGetMailSettings" |
73 | * and can be found at: | |
69d79249 | 74 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailSettingsTest.php |
6a488035 TO |
75 | * |
76 | * You can see the outcome of the API tests at | |
69d79249 | 77 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
78 | * |
79 | * To Learn about the API read | |
69d79249 | 80 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 81 | * |
69d79249 | 82 | * Browse the api on your own site with the api explorer |
41d4d31f | 83 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
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 | |
b259a4ab | 90 | */ |