*/
/**
- * File for the CiviCRM APIv3 mailing_component functions
+ * This api exposes CiviCRM MailingComponent (header and footer).
*
* @package CiviCRM_APIv3
- * @subpackage API_mailing_component
*/
/**
- * Save a mailing_component.
+ * Save a MailingComponent.
*
* @param array $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 $spec
+ * Array of parameters determined by getfields.
+ */
+function _civicrm_api3_mailing_component_create_spec(&$spec) {
+ $spec['is_active']['api.default'] = 1;
+}
+
/**
- * Get a mailing_component.
+ * Get a MailingComponent.
*
* @param array $params
*
}
/**
- * Delete a mailing_component.
+ * Adjust metadata for get.
+ *
+ * @param array $params
+ */
+function _civicrm_api3_mailing_component_get_spec(&$params) {
+ // fetch active records by default
+ $params['is_active']['api.default'] = 1;
+}
+
+/**
+ * Delete a MailingComponent.
*
* @param array $params
*