api/v3/examples/MailSettings/Create.php

   1 <?php
   2 /**
   3  * Test Generated example of using mail_settings create API
   4  * *
   5  */
   6 function mail_settings_create_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 );
  16
  17 try{
  18   $result = civicrm_api3('mail_settings', 'create', $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 }
  27
  28 return $result;
  29 }
  30
  31 /**
  32  * Function returns array of result expected from previous function
  33  */
  34 function mail_settings_create_expectedresult(){
  35
  36   $expectedResult = array(
  37   'is_error' => 0,
  38   'version' => 3,
  39   'count' => 1,
  40   'id' => 2,
  41   'values' => array(
  42       '2' => array(
  43           'id' => '2',
  44           'domain_id' => '1',
  45           'name' => 'my mail setting',
  46           'is_default' => '',
  47           'domain' => 'setting.com',
  48           'localpart' => '',
  49           'return_path' => '',
  50           'protocol' => '',
  51           'server' => 'localhost',
  52           'port' => '',
  53           'username' => 'sue',
  54           'password' => 'pass',
  55           'is_ssl' => '',
  56           'source' => '',
  57         ),
  58     ),
  59 );
  60
  61   return $expectedResult;
  62 }
  63
  64
  65 /*
  66 * This example has been generated from the API test suite. The test that created it is called
  67 *
  68 * testCreateMailSettings and can be found in
  69 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailSettingsTest.php
  70 *
  71 * You can see the outcome of the API tests at
  72 * https://test.civicrm.org/job/CiviCRM-master-git/
  73 *
  74 * To Learn about the API read
  75 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  76 *
  77 * Browse the api on your own site with the api explorer
  78 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  79 *
  80 * Read more about testing here
  81 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  82 *
  83 * API Standards documentation:
  84 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  85 */