First commit
This commit is contained in:
commit
c6e2478c40
13918 changed files with 2303184 additions and 0 deletions
83
sites/all/modules/civicrm/api/v3/MailingJob.php
Normal file
83
sites/all/modules/civicrm/api/v3/MailingJob.php
Normal file
|
@ -0,0 +1,83 @@
|
|||
<?php
|
||||
/*
|
||||
+--------------------------------------------------------------------+
|
||||
| CiviCRM version 4.7 |
|
||||
+--------------------------------------------------------------------+
|
||||
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||||
+--------------------------------------------------------------------+
|
||||
| This file is a part of CiviCRM. |
|
||||
| |
|
||||
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||||
| under the terms of the GNU Affero General Public License |
|
||||
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||||
| |
|
||||
| CiviCRM is distributed in the hope that it will be useful, but |
|
||||
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
||||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
||||
| See the GNU Affero General Public License for more details. |
|
||||
| |
|
||||
| You should have received a copy of the GNU Affero General Public |
|
||||
| License and the CiviCRM Licensing Exception along |
|
||||
| with this program; if not, contact CiviCRM LLC |
|
||||
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||||
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||||
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||||
+--------------------------------------------------------------------+
|
||||
*/
|
||||
|
||||
/**
|
||||
*
|
||||
* APIv3 functions for registering/processing mailing jobs.
|
||||
*
|
||||
* @package CiviCRM_APIv3
|
||||
*/
|
||||
|
||||
/**
|
||||
* Handle creation of a MailingJob for a Mailing.
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* @throws \API_Exception
|
||||
*/
|
||||
function civicrm_api3_mailing_job_create($params) {
|
||||
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adjust Metadata for Create action.
|
||||
*
|
||||
* The metadata is used for setting defaults, documentation & validation.
|
||||
*
|
||||
* @param array $params
|
||||
* Array of parameters determined by getfields.
|
||||
*/
|
||||
function _civicrm_api3_mailing_job_create_spec(&$params) {
|
||||
$params['status']['api.default'] = 'Scheduled';
|
||||
$params['scheduled_date']['api.default'] = 'now';
|
||||
$params['is_test']['api.default'] = 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns array of Mailing Jobs matching a set of one or more group properties.
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* API return Array of matching mailing jobs.
|
||||
*/
|
||||
function civicrm_api3_mailing_job_get($params) {
|
||||
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle deletion of a Mailing Job for a Mailing.
|
||||
*
|
||||
* @param array $params
|
||||
*
|
||||
* @return array
|
||||
* @throws \API_Exception
|
||||
*/
|
||||
function civicrm_api3_mailing_job_delete($params) {
|
||||
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue