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', | |
6a488035 TO |
15 | ); |
16 | ||
fb32de45 | 17 | try{ |
18 | $result = civicrm_api3('mail_settings', 'get', $params); | |
19 | } | |
20 | catch (CiviCRM_API3_Exception $e) { | |
21 | // handle error here | |
22 | $errorMessage = $e->getMessage(); | |
23 | $errorCode = $e->getErrorCode(); | |
24 | $errorData = $e->getExtraParams(); | |
25 | return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
26 | } | |
6a488035 | 27 | |
fb32de45 | 28 | return $result; |
6a488035 TO |
29 | } |
30 | ||
fb32de45 | 31 | /** |
6a488035 TO |
32 | * Function returns array of result expected from previous function |
33 | */ | |
34 | function mail_settings_get_expectedresult(){ | |
35 | ||
53ca8fd7 | 36 | $expectedResult = array( |
6a488035 TO |
37 | 'is_error' => 0, |
38 | 'version' => 3, | |
39 | 'count' => 1, | |
40 | 'id' => 2, | |
53ca8fd7 | 41 | 'values' => array( |
42 | '2' => array( | |
6a488035 TO |
43 | 'id' => '2', |
44 | 'domain_id' => '1', | |
45 | 'name' => 'my mail setting', | |
46 | 'is_default' => 0, | |
47 | 'domain' => 'setting.com', | |
48 | 'server' => 'localhost', | |
49 | 'username' => 'sue', | |
50 | 'password' => 'pass', | |
51 | 'is_ssl' => 0, | |
52 | ), | |
53 | ), | |
54 | ); | |
55 | ||
fb32de45 | 56 | return $expectedResult; |
6a488035 TO |
57 | } |
58 | ||
59 | ||
60 | /* | |
61 | * This example has been generated from the API test suite. The test that created it is called | |
62 | * | |
63 | * testGetMailSettings and can be found in | |
64 | * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/MailSettingsTest.php | |
65 | * | |
66 | * You can see the outcome of the API tests at | |
67 | * http://tests.dev.civicrm.org/trunk/results-api_v3 | |
68 | * | |
69 | * To Learn about the API read | |
70 | * http://book.civicrm.org/developer/current/techniques/api/ | |
71 | * | |
72 | * and review the wiki at | |
73 | * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs | |
74 | * | |
75 | * Read more about testing here | |
76 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
77 | * | |
78 | * API Standards documentation: | |
79 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
80 | */ |