api/v3/examples/MailSettingsGet.php

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