CRM_Contact_Form_Task_EmailCommon

class CRM_Contact_Form_Task_EmailCommon

This class provides the common functionality for sending email to one or a group of contact ids. This class is reused by all the search components in CiviCRM (since they all have send email as a task)

Constants

MAX_EMAILS_KILL_SWITCH

Properties

$_contactDetails
$_allContactDetails
$_toContactEmails

Methods

static array
domainEmails() deprecated

No description

static 
preProcessFromAddress(CRM_Core_Form $form, bool $bounce = TRUE)

Pre Process Form Addresses to be used in Quickform

static 
buildQuickForm(CRM_Core_Form $form)

Build the form object.

static bool|array
formRule(array $fields, array $dontCare, array $self)

Form rule.

static 
postProcess(CRM_Core_Form $form)

Process the form after the input has been submitted and validated.

static 
submit(CRM_Core_Form $form, array $formValues)

Submit the form values.

static 
saveMessageTemplate(array $formValues)

Save the template if update selected.

static 
bounceIfSimpleMailLimitExceeded(int $count)

Bounce if there are more emails than permitted.

Details

at line 50
static array domainEmails() deprecated

deprecated Generate an array of Domain email addresses.

Return Value

array $domainEmails;

at line 60
static preProcessFromAddress(CRM_Core_Form $form, bool $bounce = TRUE)

Pre Process Form Addresses to be used in Quickform

Parameters

CRM_Core_Form $form
bool $bounce determine if we want to throw a status bounce.

at line 116
static buildQuickForm(CRM_Core_Form $form)

Build the form object.

Parameters

CRM_Core_Form $form

at line 357
static bool|array formRule(array $fields, array $dontCare, array $self)

Form rule.

Parameters

array $fields The input form values.
array $dontCare
array $self Additional values form 'this'.

Return Value

bool|array true if no errors, else array of errors

at line 380
static postProcess(CRM_Core_Form $form)

Process the form after the input has been submitted and validated.

Parameters

CRM_Core_Form $form

at line 396
static submit(CRM_Core_Form $form, array $formValues)

Submit the form values.

This is also accessible for testing.

Parameters

CRM_Core_Form $form
array $formValues

at line 575
static protected saveMessageTemplate(array $formValues)

Save the template if update selected.

Parameters

array $formValues

at line 603
static bounceIfSimpleMailLimitExceeded(int $count)

Bounce if there are more emails than permitted.

Parameters

int $count The number of emails the user is attempting to send