How to Compare Previous and Current Email Opt-Out Status in Before/After Save Hooks

👨‍💻 Development Help
1

I’m trying to detect if the email opt-out status has changed on a Lead (or Contact) record inside a logic hook.

I know that do_not_call is part of the main table (leads, contacts, etc.), so I can compare it using:

if ($bean->fetched_row['do_not_call'] != $bean->do_not_call)

But since email_opt_out is a related value from the email_addresses table, it’s not available in $bean->fetched_row.
Also, using $bean->email_opt_out and $bean->email1 in after_save hook only gives the previous state and email, not the current (strange behavior).

How can I reliably compare the previous and current email opt-out values in a logic hook (before_save or after_save)?

I’m using SuiteCRM 8.6.2.

@rsp

1 Like
2

I have no idea. Checkout the doc: Logic Hooks :: SuiteCRM Documentation

Sample Code:


function email_opt_out_check($bean, $event, $arguments)
{

    if ($bean->load_relationship('email_addresses')) {
  
        $emails = $bean->email_addresses->getBeans(); 
        
        if (!empty($emails)) {
            $email = reset($emails); 
            
            $previous_email_opt_out = isset($bean->fetched_row['email_opt_out']) ? $bean->fetched_row['email_opt_out'] : null;
            $current_email_opt_out = $email->email_opt_out;
            
            if ($previous_email_opt_out != $current_email_opt_out) {
                $GLOBALS['log']->info("Email Opt-Out status changed: " . ($current_email_opt_out ? 'Opted Out' : 'Opted In'));
            }
        }
    }
}
3

This will never work because “email_opt_out” is not stored in the same table as the main record (like accounts or leads). It’s part of the email address relationship, which is managed through related tables like email_addresses and email_addr_bean_rel.

4

In that case, I think it is way complex. :frowning_face: I hope someone will provide help with logic.

5

@Krishna just a couple of thoughts. First, you’d definately want a before save. After save it’s already changed.

Your strategy of comparing the fetched row to the bean, seems logical. Is the email opt out available in the bean, or does it get changed after the bean is saved?

6

@pstevens ,
Yes, I’m able to access the fetched_row in the after_save hook, and I’m seeing both the previous and new values correctly for most fields.

However, for email-related fields like email1 or email_opt_out, it behaves differently — likely because those are handled via the email_addresses table, not directly on the bean like standard fields.

What’s strange is that in the after_save hook, $bean->email1 still shows the previous email (ABC@text.com), not the updated one. Here’s a sample for clarity:

Sample after_save Logic Hook:

class LogicHookHandler
{
    public function handleLeadSync($bean, $event, $arguments)
    {
        global $log;

        $log->fatal("LogicHook (original): {$bean->email1}"); // Output: ABC@text.com (Previous)

        $fresh = BeanFactory::getBean('Leads')->retrieve($bean->id);
        $log->fatal("LogicHook (retrieved): {$fresh->email1}"); // Output: XYZ@text.com (Current)
    }
}
7

I wonder if you could fire your hook on the email address bean rather than the contact bean. Never tried that, but that might get you what you’re looking for and avoid the whole problem of when the contact saves.