121 lines
3.3 KiB
PHP
121 lines
3.3 KiB
PHP
<?php
|
|
/**
|
|
* Test Generated example demonstrating the Mailing.submit API.
|
|
*
|
|
* @return array
|
|
* API result array
|
|
*/
|
|
function mailing_submit_example() {
|
|
$params = array(
|
|
'scheduled_date' => '2014-12-13 10:00:00',
|
|
'approval_date' => '2014-12-13 00:00:00',
|
|
'id' => 18,
|
|
);
|
|
|
|
try{
|
|
$result = civicrm_api3('Mailing', 'submit', $params);
|
|
}
|
|
catch (CiviCRM_API3_Exception $e) {
|
|
// Handle error here.
|
|
$errorMessage = $e->getMessage();
|
|
$errorCode = $e->getErrorCode();
|
|
$errorData = $e->getExtraParams();
|
|
return array(
|
|
'is_error' => 1,
|
|
'error_message' => $errorMessage,
|
|
'error_code' => $errorCode,
|
|
'error_data' => $errorData,
|
|
);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Function returns array of result expected from previous function.
|
|
*
|
|
* @return array
|
|
* API result array
|
|
*/
|
|
function mailing_submit_expectedresult() {
|
|
|
|
$expectedResult = array(
|
|
'is_error' => 0,
|
|
'version' => 3,
|
|
'count' => 1,
|
|
'id' => 18,
|
|
'values' => array(
|
|
'18' => array(
|
|
'id' => '18',
|
|
'domain_id' => '1',
|
|
'header_id' => '',
|
|
'footer_id' => '27',
|
|
'reply_id' => '8',
|
|
'unsubscribe_id' => '5',
|
|
'resubscribe_id' => '6',
|
|
'optout_id' => '7',
|
|
'name' => 'mailing name',
|
|
'mailing_type' => 'standalone',
|
|
'from_name' => 'FIXME',
|
|
'from_email' => 'info@EXAMPLE.ORG',
|
|
'replyto_email' => 'info@EXAMPLE.ORG',
|
|
'template_type' => 'traditional',
|
|
'template_options' => '',
|
|
'subject' => 'Hello {contact.display_name}',
|
|
'body_text' => 'This is {contact.display_name}.
|
|
https://civicrm.org
|
|
{domain.address}{action.optOutUrl}',
|
|
'body_html' => '<p>Look ma, magic tokens in the markup!</p>',
|
|
'url_tracking' => '1',
|
|
'forward_replies' => 0,
|
|
'auto_responder' => 0,
|
|
'open_tracking' => '1',
|
|
'is_completed' => '',
|
|
'msg_template_id' => '',
|
|
'override_verp' => '1',
|
|
'created_id' => '40',
|
|
'created_date' => '2013-07-28 08:49:19',
|
|
'scheduled_id' => '41',
|
|
'scheduled_date' => '20130728085413',
|
|
'approver_id' => '41',
|
|
'approval_date' => '20130728085413',
|
|
'approval_status_id' => '1',
|
|
'approval_note' => '',
|
|
'is_archived' => 0,
|
|
'visibility' => 'Public Pages',
|
|
'campaign_id' => '',
|
|
'dedupe_email' => '1',
|
|
'sms_provider_id' => '',
|
|
'hash' => '67eac7789eaee00',
|
|
'location_type_id' => '',
|
|
'email_selection_method' => 'automatic',
|
|
'language' => '',
|
|
),
|
|
),
|
|
);
|
|
|
|
return $expectedResult;
|
|
}
|
|
|
|
/*
|
|
* This example has been generated from the API test suite.
|
|
* The test that created it is called "testMailerSubmit"
|
|
* and can be found at:
|
|
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MailingTest.php
|
|
*
|
|
* You can see the outcome of the API tests at
|
|
* https://test.civicrm.org/job/CiviCRM-master-git/
|
|
*
|
|
* To Learn about the API read
|
|
* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
|
|
*
|
|
* Browse the api on your own site with the api explorer
|
|
* http://MYSITE.ORG/path/to/civicrm/api
|
|
*
|
|
* Read more about testing here
|
|
* http://wiki.civicrm.org/confluence/display/CRM/Testing
|
|
*
|
|
* API Standards documentation:
|
|
* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
|
|
*/
|