refactoring & Test case for send email to dnd contact

[dadarya0]

Q	A
Bug fix? (use the a.b branch)	No
New feature/enhancement? (use the a.x branch)	Yes
Deprecations?	[ ]
BC breaks? (use the c.x branch)	[ ]
Automated tests included?	Yes
Related user documentation PR URL	mautic/mautic-documentation#...
Related developer documentation PR URL	mautic/developer-documentation#...
Issue(s) addressed	Fixes #...

Description:

Refactoring & Test case for send email to dnd contact which was implemented in https://github.com/mautic/mautic/pull/11787/files

Steps to test this PR:

1. Open this PR on Gitpod or pull down for testing locally (see docs on testing PRs here)
2. Send an individual email, an email via API /emails/ID/contact/CONTACT_ID/send, transactional email by form and by campaign.
3. Check the headers of the emails. There is no 'List-Unsubscribe'.
4. Send a marketing email by form and by campaign.
5. Check the headers of the emails. There is 'ListUnsubscribe'.

[codecov]

Codecov Report

Merging #12654 (39ef1f4) into 5.x (c86f0ee) will increase coverage by 0.00%.
The diff coverage is 83.33%.

@@            Coverage Diff            @@
##                5.x   #12654   +/-   ##
=========================================
  Coverage     58.45%   58.45%           
  Complexity    33597    33597           
=========================================
  Files          2183     2183           
  Lines        101716   101716           
=========================================
+ Hits          59454    59455    +1     
+ Misses        42262    42261    -1     

Files Changed	Coverage Δ
.../EmailBundle/Controller/Api/EmailApiController.php	83.33% <ø> (ø)
...ailBundle/EventListener/MessageQueueSubscriber.php	11.42% <ø> (ø)
...pp/bundles/EmailBundle/Form/Type/EmailSendType.php	80.55% <0.00%> (ø)
...s/EmailBundle/EventListener/CampaignSubscriber.php	66.36% <100.00%> (ø)
app/bundles/EmailBundle/Helper/MailHelper.php	64.25% <100.00%> (ø)
app/bundles/EmailBundle/Model/EmailModel.php	49.59% <100.00%> (ø)

... and 1 file with indirect coverage changes

[roboparker]

Thank you @dadarya0

A few nitpicks with the tests.

1. Instead of having a test with a foreach to test all the emails, we should use a data provider.
2. Please don't add phpstan ignore lines unless its the only reasonable solution. I am guessing its to hide a type error? If so use assert

[roboparker]

Thank you @dadarya0

[RCheesley]

Sending an email to the contact is blocked by #12495 and sending via form actions and API is blocked by #12663 in case others are testing this.

[volha-pivavarchyk]

Works well as before

• an individual email - no 'List-Unsubscribe',
• an email via API - no 'List-Unsubscribe',
• a transactional email by campaign - no 'List-Unsubscribe',
• a marketing email by campaign - 'List-Unsubscribe'.

Code looks good 👍, thanks.

Maybe a couple of nuances.
If you agree, all hard-coded "transactional" types can be replaced with a constant, e.g. $mailer->setEmailType('transactional') > $mailer->setEmailType(MailHelper::EMAIL_TYPE_TRANSACTIONAL).
If you agree, you can add the MailHelper::EMAIL_TYPE_MARKETING constant to make the way similar.

[RCheesley]

@dadarya0 please take a look at the suggestions from @volha-pivavarchyk in the code review above?

[dadarya0]

@dadarya0 please take a look at the suggestions from @volha-pivavarchyk in the code review above?

Suggestions Implemented in 39ef1f4

[dadarya0]

Works well as before

• an individual email - no 'List-Unsubscribe',
• an email via API - no 'List-Unsubscribe',
• a transactional email by campaign - no 'List-Unsubscribe',
• a marketing email by campaign - 'List-Unsubscribe'.

Code looks good 👍, thanks.

Maybe a couple of nuances. If you agree, all hard-coded "transactional" types can be replaced with a constant, e.g. $mailer->setEmailType('transactional') > $mailer->setEmailType(MailHelper::EMAIL_TYPE_TRANSACTIONAL). If you agree, you can add the MailHelper::EMAIL_TYPE_MARKETING constant to make the way similar.

Suggestions Implemented in 39ef1f4