Check if copy method is copy before sending comment email

[JeroenVanLeusden]

Description (*)

As seen in the comments email copies should only be sent as separated emails if their copy method is copy.

Related Pull Requests

None I could find.

Fixed Issues (if relevant)

None I could find.

Manual testing scenarios (*)

1. Enable sales_email/order_comment/enabled

2. Add email address to sales_email/order_comment/copy_to

3. Set sales_email/order_comment/copy_method to bcc (default value).

4. Place order.

5. Add order comment in order overview (adminhtml area) and uncheck notify customer.

6. Email copy should not be send because notify customer is disabled and copy set to bcc.

Questions or comments

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds are green)

Resolved issues:

1. resolves [Issue] Check if copy method is copy before sending comment email #29915: Check if copy method is copy before sending comment email

[m2-assistant]

Hi @JeroenVanLeusden. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

• @magento run all tests - run or re-run all required tests against the PR changes
• @magento run <test-build(s)> - run or re-run specific test build(s)
  For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE,
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

[sidolov]

@magento create issue

[sidolov]

@JeroenVanLeusden could you please cover changes with automated test?

[engcom-Charlie]

Hi @JeroenVanLeusden, please cover your changes by automated test. Otherwise, we can't proceed with your PR.
Thank you.

[JeroenVanLeusden]

@sidolov Will do. However shouldn't we remove the entire ifelse statement and only send a copy/bcc if the customer itself actually receives an email?

[sidolov]

@JeroenVanLeusden do you mean to send an email when $notify === true only?

[JeroenVanLeusden]

@sidolov Correct

[sidolov]

If we are going to be consistent with the comment

// Email copies are sent as separated emails if their copy method is 'copy' or a customer should not be notified

and I believe it's a right way to preserve backward compatible behavior, we should remove the esle statement and just add one more if expression like:

if (!$notify || $this->identityContainer->getCopyMethod() === 'copy') {
    $sender->sendCopyTo();
}

[JeroenVanLeusden]

Fine by me. Will update this when i find some spare time.

[engcom-Charlie]

Hi @JeroenVanLeusden, will you continue with this PR?
Thank you.

[JeroenVanLeusden]

It's still on my todo list, hopefully will have some time end of this week.

[JeroenVanLeusden]

@magento run all tests

[engcom-Charlie]

@magento run all tests

[magento-engcom-team]

Hi @gabrieldagama, thank you for the review.
ENGCOM-8348 has been created to process this Pull Request
✳️ @gabrieldagama, could you please add one of the following labels to the Pull Request?

Label	Description
Auto-Tests: Covered	All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered	Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required	Changes in Pull Request does not require coverage by auto-tests

[engcom-Alfa]

✔️ QA Passed

Case 1

Manual testing scenario:

1. Go to Admin -> Stores -> Configuration -> Sales -> Sales Email -> Order Comments and set Enabled to Yes
2. Add email address to Send Order Comment Email Copy To
3. Set Send Order Comments Email Copy Method to Bcc
4. Place order.
5. Add order comment in order overview (adminhtml area) and uncheck notify customer.

Before: ✖️ a copy of the email was sent (but shouldn't have been sent because the customer notification was turned off and the copy was set to a hidden copy.)

After: ✔️ email copy wasn't sent

Case 2

Manual testing scenario:

1. Go to Admin -> Stores -> Configuration -> Sales -> Sales Email -> Order Comments and set Enabled to Yes
2. Add email address to Send Order Comment Email Copy To
3. Set Send Order Comments Email Copy Method to Bcc
4. Place order.
5. Add order comment in order overview (adminhtml area) and check notify customer.

After: ✔️ email copy was sent

[m2-assistant]

Hi @JeroenVanLeusden, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.