private $_domain = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * @param $job_id
- * @param null $mailing_id
+ * @param int $job_id
+ * @param int $mailing_id
* @param null $mode
*
* @return int
// note that $job_id is used only as a variable in the temp table construction
// and does not play a role in the queries generated
/**
- * @param $job_id
- * @param null $mailing_id
+ * @param int $job_id
+ * @param int $mailing_id
* @param null $offset
* @param null $limit
* @param bool $storeRecipients
$group = CRM_Contact_DAO_Group::getTableName();
$g2contact = CRM_Contact_DAO_GroupContact::getTableName();
+ $m = new CRM_Mailing_DAO_Mailing();
+ $m->id = $mailing_id;
+ $m->find(TRUE);
+
+ $email_selection_method = $m->email_selection_method;
+ $location_type_id = $m->location_type_id;
+
+ // Note: When determining the ORDER that results are returned, it's
+ // the record that comes last that counts. That's because we are
+ // INSERT'ing INTO a table with a primary id so that last record
+ // over writes any previous record.
+ switch($email_selection_method) {
+ case 'location-exclude':
+ $location_filter = "($email.location_type_id != $location_type_id)";
+ // If there is more than one email that doesn't match the location,
+ // prefer the one marked is_bulkmail, followed by is_primary.
+ $order_by = "ORDER BY $email.is_bulkmail, $email.is_primary";
+ break;
+ case 'location-only':
+ $location_filter = "($email.location_type_id = $location_type_id)";
+ // If there is more than one email of the desired location, prefer
+ // the one marked is_bulkmail, followed by is_primary.
+ $order_by = "ORDER BY $email.is_bulkmail, $email.is_primary";
+ break;
+ case 'location-prefer':
+ $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1 OR $email.location_type_id = $location_type_id)";
+
+ // ORDER BY is more complicated because we have to set an arbitrary
+ // order that prefers the location that we want. We do that using
+ // the FIELD function. For more info, see:
+ // https://dev.mysql.com/doc/refman/5.5/en/string-functions.html#function_field
+ // We assign the location type we want the value "1" by putting it
+ // in the first position after we name the field. All other location
+ // types are left out, so they will be assigned the value 0. That
+ // means, they will all be equally tied for first place, with our
+ // location being last.
+ $order_by = "ORDER BY FIELD($email.location_type_id, $location_type_id), $email.is_bulkmail, $email.is_primary";
+ break;
+ case 'automatic':
+ // fall through to default
+ default:
+ $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1)";
+ $order_by = "ORDER BY $email.is_bulkmail";
+ }
+
/* Create a temp table for contact exclusion */
$mailingGroup->query(
"CREATE TEMPORARY TABLE X_$job_id
AND $contact.do_not_email = 0
AND $contact.is_opt_out = 0
AND $contact.is_deceased = 0
- AND ($email.is_bulkmail = 1 OR $email.is_primary = 1)
+ AND $location_filter
AND $email.email IS NOT NULL
AND $email.email != ''
AND $email.on_hold = 0
AND $mg.mailing_id = {$mailing_id}
AND X_$job_id.contact_id IS null
- ORDER BY $email.is_bulkmail";
+ $order_by";
if ($mode == 'sms') {
$phoneTypes = CRM_Core_OptionGroup::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
AND $contact.do_not_email = 0
AND $contact.is_opt_out = 0
AND $contact.is_deceased = 0
- AND ($email.is_bulkmail = 1 OR $email.is_primary = 1)
+ AND $location_filter
AND $email.on_hold = 0
AND $mg.mailing_id = {$mailing_id}
AND X_$job_id.contact_id IS null
- ORDER BY $email.is_bulkmail";
+ $order_by";
if ($mode == 'sms') {
$query = "REPLACE INTO I_$job_id (phone_id, contact_id)
$smartGroupInclude = "
INSERT IGNORE INTO I_$job_id (email_id, contact_id)
-SELECT e.id as email_id, c.id as contact_id
+SELECT civicrm_email.id as email_id, c.id as contact_id
FROM civicrm_contact c
-INNER JOIN civicrm_email e ON e.contact_id = c.id
+INNER JOIN civicrm_email ON civicrm_email.contact_id = c.id
INNER JOIN civicrm_group_contact_cache gc ON gc.contact_id = c.id
LEFT JOIN X_$job_id ON X_$job_id.contact_id = c.id
WHERE gc.group_id = {$groupDAO->id}
AND c.do_not_email = 0
AND c.is_opt_out = 0
AND c.is_deceased = 0
- AND (e.is_bulkmail = 1 OR e.is_primary = 1)
- AND e.on_hold = 0
+ AND $location_filter
+ AND civicrm_email.on_hold = 0
AND X_$job_id.contact_id IS null
-ORDER BY e.is_bulkmail
+$order_by
";
if ($mode == 'sms') {
$smartGroupInclude = "
AND $contact.do_not_email = 0
AND $contact.is_opt_out = 0
AND $contact.is_deceased = 0
- AND ($email.is_bulkmail = 1 OR $email.is_primary = 1)
+ AND $location_filter
AND $email.on_hold = 0
AND $mg.mailing_id = {$mailing_id}
AND X_$job_id.contact_id IS null
- ORDER BY $email.is_bulkmail";
+ $order_by";
if ($mode == "sms") {
$query = "REPLACE INTO I_$job_id (phone_id, contact_id)
SELECT DISTINCT $phone.id as phone_id,
/**
* Generate an event queue for a test job
*
- * @params array $params contains form values
- *
- * @param $testParams
+ * @param array $testParams contains form values
*
* @return void
* @access public
}
/**
- * static wrapper for getting verp and urls
+ * Static wrapper for getting verp and urls
*
* @param int $job_id ID of the Job associated with this message
* @param int $event_queue_id ID of the EventQueue
}
/**
- * get verp, urls and headers
+ * Get verp, urls and headers
*
* @param int $job_id ID of the Job associated with this message
* @param int $event_queue_id ID of the EventQueue
*
* @param null $replyToEmail
*
- * @return object The mail object
+ * @return Mail_mime The mail object
* @access public
*/
public function &compose($job_id, $event_queue_id, $hash, $contactId,
}
/**
- * function to add the mailings
+ * Add the mailings
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
*
* @params array $params Form values
*
- * @param $params
+ * @param array $params
* @param array $ids
*
* @return object $mailing The new mailing object
}
/**
- * get hash value of the mailing
+ * Get hash value of the mailing
*
*/
public static function getMailingHash($id) {
}
/**
- * @param $id
+ * @param int $id
*
* @throws Exception
*/
}
/**
- * returns all the mailings that this user can access. This is dependent on
+ * Returns all the mailings that this user can access. This is dependent on
* all the groups that the user has access to.
* However since most civi installs dont use ACL's we special case the condition
* where the user has access to ALL groups, and hence ALL mailings and return a
* @param string $sort The sql string that describes the sort order
*
* @param null $additionalClause
- * @param null $additionalParams
+ * @param array $additionalParams
*
* @return array The rows
* @access public
}
/**
- * Function to show detail Mailing report
+ * Show detail Mailing report
*
* @param int $id
*
}
/**
- * Function to build the compose mail form
+ * Build the compose mail form
*
- * @param $form
+ * @param CRM_Core_Form $form
*
* @return void
* @access public
//sorted in ascending order tokens by ignoring word case
$form->assign('tokens', CRM_Utils_Token::formatTokensForDisplay($tokens));
- $form->_templates = CRM_Core_BAO_MessageTemplate::getMessageTemplates(FALSE);
- if (!empty($form->_templates)) {
- $form->assign('templates', TRUE);
- $form->add('select', 'template', ts('Use Template'),
- array(
- '' => ts('- select -')) + $form->_templates, FALSE,
- array('onChange' => "selectValue( this.value );")
- );
- $form->add('checkbox', 'updateTemplate', ts('Update Template'), NULL);
- }
-
- $form->add('checkbox', 'saveTemplate', ts('Save As New Template'), NULL, FALSE,
- array('onclick' => "showSaveDetails(this);")
- );
- $form->add('text', 'saveTemplateName', ts('Template Title'));
-
+ $templates = array();
- //insert message Text by selecting "Select Template option"
- $form->add('textarea',
- 'text_message',
- ts('Plain-text format'),
- array(
- 'cols' => '80', 'rows' => '8',
- 'onkeyup' => "return verify(this)",
- )
- );
+ $textFields = array('text_message' => ts('HTML Format'), 'sms_text_message' => ts('SMS Message'));
+ $modePrefixes = array('Mail' => NULL, 'SMS' => 'SMS');
if ($className != 'CRM_SMS_Form_Upload' && $className != 'CRM_Contact_Form_Task_SMS' &&
$className != 'CRM_Contact_Form_Task_SMS'
) {
$form->addWysiwyg('html_message',
- ts('HTML format'),
+ ts('HTML Format'),
array(
'cols' => '80', 'rows' => '8',
'onkeyup' => "return verify(this)",
)
);
+
+ if ($className != 'CRM_Admin_Form_ScheduleReminders') {
+ unset($modePrefixes['SMS']);
+ }
+ }
+ else {
+ unset($textFields['text_message']);
+ unset($modePrefixes['Mail']);
+ }
+
+ //insert message Text by selecting "Select Template option"
+ foreach ($textFields as $id => $label) {
+ $prefix = NULL;
+ if ($id == 'sms_text_message') {
+ $prefix = "SMS";
+ $form->assign('max_sms_length', CRM_SMS_Provider::MAX_SMS_CHAR);
+ }
+ $form->add('textarea', $id, $label,
+ array(
+ 'cols' => '80', 'rows' => '8',
+ 'onkeyup' => "return verify(this, '{$prefix}')",
+ )
+ );
+ }
+
+ foreach ($modePrefixes as $prefix) {
+ if ($prefix == 'SMS') {
+ $templates[$prefix] = CRM_Core_BAO_MessageTemplate::getMessageTemplates(FALSE, TRUE);
+ }
+ else {
+ $templates[$prefix] = CRM_Core_BAO_MessageTemplate::getMessageTemplates(FALSE);
+ }
+
+ if (!empty($templates[$prefix])) {
+ $form->assign('templates', TRUE);
+
+ $form->add('select', "{$prefix}template", ts('Use Template'),
+ array('' => ts('- select -')) + $templates[$prefix], FALSE,
+ array('onChange' => "selectValue( this.value, '{$prefix}');")
+ );
+ }
+ $form->add('checkbox', "{$prefix}updateTemplate", ts('Update Template'), NULL);
+
+ $form->add('checkbox', "{$prefix}saveTemplate", ts('Save As New Template'), NULL, FALSE,
+ array('onclick' => "showSaveDetails(this, '{$prefix}');")
+ );
+ $form->add('text', "{$prefix}saveTemplateName", ts('Template Title'));
}
}
/**
- * Function to build the compose PDF letter form
+ * Build the compose PDF letter form
*
- * @param $form
+ * @param CRM_Core_Form $form
*
* @return void
* @access public
$form->add('select', 'template', ts('Select Template'),
array(
'' => ts('- select -')) + $form->_templates, FALSE,
- array('onChange' => "selectValue( this.value );")
+ array('onChange' => "selectValue( this.value,'' );")
);
$form->add('checkbox', 'updateTemplate', ts('Update Template'), NULL);
}
}
/**
- * @param $jobID
+ * @param int $jobID
*
* @return mixed
*/
*/
static function processQueue($mode = NULL) {
$config = &CRM_Core_Config::singleton();
- // CRM_Core_Error::debug_log_message("Beginning processQueue run: {$config->mailerJobsMax}, {$config->mailerJobSize}");
if ($mode == NULL && CRM_Core_BAO_MailSettings::defaultDomain() == "EXAMPLE.ORG") {
throw new CRM_Core_Exception(ts('The <a href="%1">default mailbox</a> has not been configured. You will find <a href="%2">more info in the online user and administrator guide</a>', array(1 => CRM_Utils_System::url('civicrm/admin/mailSettings', 'reset=1'), 2 => "http://book.civicrm.org/user/advanced-configuration/email-system-configuration/")));
$cronLock->release();
}
- // CRM_Core_Error::debug_log_message('Ending processQueue run');
return TRUE;
}
/**
- * @param $mailingID
+ * @param int $mailingID
*/
private static function addMultipleEmails($mailingID) {
$sql = "
}
/**
- * @param $mid
+ * @param int $mid
*
* @return null|string
*/
}
/**
- * Function to retrieve contact mailing
+ * Retrieve contact mailing
*
* @param array $params associated array
*
}
/**
- * Function to retrieve contact mailing count
+ * Retrieve contact mailing count
*
* @param array $params associated array
*
projects / civicrm-core.git / blobdiff