You are browsing the documentation for version 4.2 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Security Support ends in January 2024. Read version 5.0 (the latest LTS version) of the Oro documentation to get the updated information.
See our Release Process documentation for more information on the currently supported and upcoming releases.
Public and Private Emails
This feature is available starting from OroCommerce v4.2.11. To check which application version you are running, see the system information.
During synchronization of email boxes, there are a set of emails that belongs to the business entities, such as to the Contact or Lead, and not belongs to them, for example, the correspondence between two users.
There are two types of emails in the system. The first type includes emails with addresses tied to business entities, such as contacts, leads. The second type includes the rest, such as correspondence between two users in the system.
Public and private emails were introduced to process access to these two different types of emails.
A public email is an email where at least one of the addresses used by recipients or senders is public. In other cases, the email is considered private.
public email address is an address that belongs to public email owners, not private owners. If a public and a private owner use the same email address, then this email address will be considered private.
The default list of public email owner entities:
The default list of private email owner entities:
ACL Restrictions of Public and Private Emails
To separate limit access to the public and private emails, use the following permissions for the User Emails entity:
Viewto limit access to public emails.
View Privateto limit access to private emails.
By default, all roles except the Administrator role have the
NONE access level to the
View Private permission. This means that only
an administrator can view private emails by default.
Private emails are not be displayed on the activity lists regardless of the access level set for the
View Private permission.
Add Entity as Public Email Address Owner
To make an entity a public owner:
- Make sure that the entity is an email owner
- Mark the desired entity as public in the
public_email_ownerssection of the email bundle config.
For more information on how to make an entity an email owner, see the Email Address Owners topic.
The following example shows how to make a User entity a Public Owner:
oro_email: public_email_owners: - Oro\Bundle\UserBundle\Entity\User
Next, update the existing emails data with the new configuration using the
oro:email:update-visibilities console command:
php bin/console oro:email:update-visibilities
This command sends a Message Queue message to update visibility for emails.