3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This class introduces component to the system and provides all the
30 * information about it. It needs to extend CRM_Core_Component_Info
34 * @copyright CiviCRM LLC (c) 2004-2014
38 class CRM_Mailing_Info
extends CRM_Core_Component_Info
{
43 protected $keyword = 'mailing';
50 public function getInfo() {
53 'translatedName' => ts('CiviMail'),
54 'title' => 'CiviCRM Mailing Engine',
56 'showActivitiesInCore' => 1,
61 * EXPERIMENTAL: Get a list of AngularJS modules
64 * list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules)
65 * @see CRM_Utils_Hook::angularModules
67 public function getAngularModules() {
69 $result['crmMailing'] = array(
72 'js/angular-crmMailing.js',
73 'js/angular-crmMailing/*.js',
75 'css' => array('css/angular-crmMailing.css'),
76 'partials' => array('partials/crmMailing'),
78 $result['crmMailingAB'] = array(
81 'js/angular-crmMailingAB.js',
82 'js/angular-crmMailingAB/*.js',
84 'css' => array('css/angular-crmMailingAB.css'),
85 'partials' => array('partials/crmMailingAB'),
87 $result['crmD3'] = array(
90 'js/angular-crmD3.js',
91 'bower_components/d3/d3.min.js',
95 $config = CRM_Core_Config
::singleton();
96 $session = CRM_Core_Session
::singleton();
97 $contactID = $session->get('userID');
98 $civiMails = civicrm_api3('Mailing', 'get', array());
99 $campNames = civicrm_api3('Campaign', 'get', array());
100 $mailingabNames = civicrm_api3('MailingAB', 'get', array());
101 $mailStatus = civicrm_api3('MailingJob', 'get', array());
102 $groupNames = civicrm_api3('Group', 'get', array());
103 $headerfooterList = civicrm_api3('MailingComponent', 'get', array(
110 $emailAdd = civicrm_api3('Email', 'get', array(
113 'contact_id' => $contactID,
115 $mesTemplate = civicrm_api3('MessageTemplate', 'get', array(
117 'return' => array("msg_html", "id", "msg_title", "msg_subject", "msg_text"),
119 'workflow_id' => array('IS NULL' => ""),
121 $mailGrp = civicrm_api3('MailingGroup', 'get', array());
122 $mailTokens = civicrm_api3('Mailing', 'gettokens', array('entity' => array('contact', 'mailing'), 'sequential' => 1));
123 $fromAddress = civicrm_api3('OptionGroup', 'get', array(
125 'name' => "from_email_address",
126 'api.OptionValue.get' => array(),
128 CRM_Core_Resources
::singleton()->addSetting(array(
129 'crmMailing' => array(
130 'mailingabNames' => array_values($mailingabNames['values']),
131 'civiMails' => array_values($civiMails['values']),
132 'campNames' => array_values($campNames['values']),
133 'mailStatus' => array_values($mailStatus['values']),
134 'groupNames' => array_values($groupNames['values']),
135 'headerfooterList' => array_values($headerfooterList['values']),
136 'mesTemplate' => array_values($mesTemplate['values']),
137 'emailAdd' => array_values($emailAdd['values']),
138 'mailGrp' => array_values($mailGrp['values']),
139 'mailTokens' => $mailTokens['values'],
140 'contactid' => $contactID,
141 'requiredTokens' => CRM_Utils_Token
::getRequiredTokens(),
142 'enableReplyTo' => (int) CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
, 'replyTo'),
143 'fromAddress' => array_values($fromAddress['values'][0]['api.OptionValue.get']['values']),
144 'defaultTestEmail' => civicrm_api3('Contact', 'getvalue', array(
145 'id' => 'user_contact_id',
148 'visibility' => array(
149 array('value' => 'Public Pages', 'label' => ts('Public Pages')),
150 array('value' => 'User and User Admin Only', 'label' => ts('User and User Admin Only')),
152 'workflowEnabled' => CRM_Mailing_Info
::workflowEnabled(),
155 CRM_Core_Resources
::singleton()->addPermissions(array(
161 'delete in CiviMail',
170 public static function workflowEnabled() {
171 $config = CRM_Core_Config
::singleton();
173 // early exit, since not true for most
174 if (!$config->userSystem
->is_drupal ||
175 !function_exists('module_exists')
180 if (!module_exists('rules')) {
184 $enableWorkflow = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
190 return ($enableWorkflow &&
191 $config->userSystem
->is_drupal
197 * @param bool $getAllUnconditionally
201 public function getPermissions($getAllUnconditionally = FALSE) {
202 $permissions = array(
204 'access CiviMail subscribe/unsubscribe pages',
205 'delete in CiviMail',
206 'view public CiviMail content',
209 if (self
::workflowEnabled() ||
$getAllUnconditionally) {
210 $permissions[] = 'create mailings';
211 $permissions[] = 'schedule mailings';
212 $permissions[] = 'approve mailings';
223 public function getUserDashboardElement() {
224 // no dashboard element for this component
231 public function getUserDashboardObject() {
232 // no dashboard element for this component
240 public function registerTab() {
242 'title' => ts('Mailings'),
253 public function registerAdvancedSearchPane() {
255 'title' => ts('Mailings'),
264 public function getActivityTypes() {
269 * add shortcut to Create New.
272 public function creatNewShortcut(&$shortCuts) {