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