api/v3/examples/Email/Create.php

   1 <?php
   2 /**
   3  * Test Generated example of using email create API
   4  * *
   5  */
   6 function email_create_example(){
   7 $params = array(
   8   'contact_id' => 3,
   9   'location_type_id' => 6,
  10   'email' => 'api@a-team.com',
  11   'is_primary' => 1,
  12 );
  13
  14 try{
  15   $result = civicrm_api3('email', 'create', $params);
  16 }
  17 catch (CiviCRM_API3_Exception $e) {
  18   // handle error here
  19   $errorMessage = $e->getMessage();
  20   $errorCode = $e->getErrorCode();
  21   $errorData = $e->getExtraParams();
  22   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  23 }
  24
  25 return $result;
  26 }
  27
  28 /**
  29  * Function returns array of result expected from previous function
  30  */
  31 function email_create_expectedresult(){
  32
  33   $expectedResult = array(
  34   'is_error' => 0,
  35   'version' => 3,
  36   'count' => 1,
  37   'id' => 3,
  38   'values' => array(
  39       '3' => array(
  40           'id' => '3',
  41           'contact_id' => '3',
  42           'location_type_id' => '6',
  43           'email' => 'api@a-team.com',
  44           'is_primary' => '1',
  45           'is_billing' => '',
  46           'on_hold' => '',
  47           'is_bulkmail' => '',
  48           'hold_date' => '',
  49           'reset_date' => '',
  50           'signature_text' => '',
  51           'signature_html' => '',
  52         ),
  53     ),
  54 );
  55
  56   return $expectedResult;
  57 }
  58
  59
  60 /*
  61 * This example has been generated from the API test suite. The test that created it is called
  62 *
  63 * testCreateEmail and can be found in
  64 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EmailTest.php
  65 *
  66 * You can see the outcome of the API tests at
  67 * https://test.civicrm.org/job/CiviCRM-master-git/
  68 *
  69 * To Learn about the API read
  70 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  71 *
  72 * Browse the api on your own site with the api explorer
  73 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  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 */