api/v3/examples/EmailCreate.php

   1 <?php
   2
   3 /*
   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   'version' => 3,
  13 );
  14
  15   $result = civicrm_api( 'email','create',$params );
  16
  17   return $result;
  18 }
  19
  20 /*
  21  * Function returns array of result expected from previous function
  22  */
  23 function email_create_expectedresult(){
  24
  25   $expectedResult = array(
  26   'is_error' => 0,
  27   'version' => 3,
  28   'count' => 1,
  29   'id' => 3,
  30   'values' => array(
  31       '3' => array(
  32           'id' => '3',
  33           'contact_id' => '3',
  34           'location_type_id' => '6',
  35           'email' => 'api@a-team.com',
  36           'is_primary' => '1',
  37           'is_billing' => '',
  38           'on_hold' => '',
  39           'is_bulkmail' => '',
  40           'hold_date' => '',
  41           'reset_date' => '',
  42           'signature_text' => '',
  43           'signature_html' => '',
  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 * testCreateEmail and can be found in
  56 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/EmailTest.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 */