Browse Source

🌈 pre-commit auto cleanup

pull/297/head
Denis Mudarisov 4 years ago
parent
commit
f6a88403be
No known key found for this signature in database GPG Key ID: B9AD74DAFB7B53DA
  1. 2
      .isort.cfg
  2. 35
      email_headers/README.md
  3. 10
      email_headers/__init__.py
  4. 13
      email_headers/__manifest__.py
  5. 3
      email_headers/data/ir_config_parameter_data.xml
  6. 9
      email_headers/migrations/12.0.1.2.0/post-migration.py
  7. 427
      email_headers/models/mail.py
  8. 295
      email_headers/tests/test_email.py
  9. 4
      email_headers/views/ir_mail_server_views.xml

2
.isort.cfg

@ -9,4 +9,4 @@ line_length=88
known_odoo=odoo
known_odoo_addons=odoo.addons
sections=FUTURE,STDLIB,THIRDPARTY,ODOO,ODOO_ADDONS,FIRSTPARTY,LOCALFOLDER
known_third_party=requests,werkzeug
known_third_party=Crypto,mock,requests,werkzeug

35
email_headers/README.md

@ -1,33 +1,32 @@
Email Headers
=============
# Email Headers
This module is used to improve email deliverability and make sure that replies
find their way to the correct thread in Odoo.
This module is used to improve email deliverability and make sure that replies find
their way to the correct thread in Odoo.
Options:
- Force the `From` and `Reply-To` addresses of outgoing email
- Generate a thread-specific `Reply-To` address for outgoing emails so that
losing the headers used to identify the correct thread won't be a problem
any more.
- Generate a thread-specific `Reply-To` address for outgoing emails so that losing the
headers used to identify the correct thread won't be a problem any more.
## Gotcha
To make the automatic bounce message work when using thread-specific `Reply-To`
addresses, you should define the actual catchall alias in a system parameter
called `mail.catchall.alias.custom` and change the `mail.catchall.alias` to
something completely random that will never be used, or alternatively remove it.
addresses, you should define the actual catchall alias in a system parameter called
`mail.catchall.alias.custom` and change the `mail.catchall.alias` to something
completely random that will never be used, or alternatively remove it.
The reason is this: when Odoo is looking for a route for an incoming email that
has lost its headers, it won't check whether the email was sent to
`catchall@whatever.com` but instead it will see if the local part of that address
contains the word `catchall`. And this isn't a good thing when the address is
something like `catchall+123abc@whatever.com`. That's why we had to skip the
default catchall evaluation and redo it in a later phase.
The reason is this: when Odoo is looking for a route for an incoming email that has lost
its headers, it won't check whether the email was sent to `catchall@whatever.com` but
instead it will see if the local part of that address contains the word `catchall`. And
this isn't a good thing when the address is something like
`catchall+123abc@whatever.com`. That's why we had to skip the default catchall
evaluation and redo it in a later phase.
## Database-specific Settings
| Setting | Purpose | Default value |
|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------- |
| email_headers.strip_mail_message_ids | Office 365 emails may add whitespaces before the Message-Id's. This feature removes them. | "True" |
| email_headers.prioritize_replyto_over_headers | When "True", Odoo will prioritize the (unique) Reply-To address of an incoming email and only then look at the `References` and `In-Reply-To` headers. | "True" |
| mail.catchall.alias | The default catchall alias. See "Gotcha" for more information. | "catchall" |
@ -36,12 +35,14 @@ default catchall evaluation and redo it in a later phase.
## Debugging
### Decode and decrypt a message id
```python
from odoo.addons.email_headers.models.mail import decode_msg_id
decode_msg_id(<encrypted and base32/64 encoded message database id>, self.env)
```
### Encrypt and encode a message id
```python
from odoo.addons.email_headers.models.mail import encode_msg_id
encode_msg_id(<message database id>, self.env)

10
email_headers/__init__.py

@ -24,9 +24,9 @@ from odoo import SUPERUSER_ID, api
def set_catchall_alias(cr, registry):
env = api.Environment(cr, SUPERUSER_ID, {})
icp = env['ir.config_parameter']
custom_alias = icp.get_param('mail.catchall.alias.custom')
icp = env["ir.config_parameter"]
custom_alias = icp.get_param("mail.catchall.alias.custom")
if not custom_alias:
original_alias = icp.get_param('mail.catchall.alias', 'catchall')
icp.set_param('mail.catchall.alias.custom', original_alias)
icp.set_param('mail.catchall.alias', 'Use mail.catchall.alias.custom')
original_alias = icp.get_param("mail.catchall.alias", "catchall")
icp.set_param("mail.catchall.alias.custom", original_alias)
icp.set_param("mail.catchall.alias", "Use mail.catchall.alias.custom")

13
email_headers/__manifest__.py

@ -27,21 +27,14 @@
Adds fields on outgoing email server that allows you to better control the
outgoing email headers and Reply-To addresses.
""",
"data": [
"data/ir_config_parameter_data.xml",
"views/ir_mail_server_views.xml",
],
"data": ["data/ir_config_parameter_data.xml", "views/ir_mail_server_views.xml",],
"author": "Avoin.Systems",
"website": "https://avoin.systems",
"category": "Email",
"depends": ["mail"],
"external_dependencies": {
"python": [
"Crypto.Cipher.AES", # pip3 install pycryptodome
],
"bin": [
],
"python": ["Crypto.Cipher.AES",], # pip3 install pycryptodome
"bin": [],
},
"installable": True,
"post_init_hook": "set_catchall_alias",

3
email_headers/data/ir_config_parameter_data.xml

@ -1,11 +1,9 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo noupdate="1">
<record id="prioritize_replyto_over_headers" model="ir.config_parameter">
<field name="key">email_headers.prioritize_replyto_over_headers</field>
<field name="value">True</field>
</record>
<!-- The original field was called just strip_message_ids, but since
it's manually set in some production databases, it's risky to
define here. It might break a database upgrade. -->
@ -13,5 +11,4 @@
<field name="key">email_headers.strip_mail_message_ids</field>
<field name="value">True</field>
</record>
</odoo>

9
email_headers/migrations/12.0.1.2.0/post-migration.py

@ -1,10 +1,9 @@
from odoo import api, SUPERUSER_ID
def migrate(cr, version):
if not version:
return
cr.execute("UPDATE ir_mail_server "
cr.execute(
"UPDATE ir_mail_server "
"SET reply_to_method = 'alias' "
"WHERE reply_to_alias IS TRUE")
"WHERE reply_to_alias IS TRUE"
)

427
email_headers/models/mail.py

@ -17,57 +17,57 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
import base64
import binascii
import logging
import random
import re
import string
from email.message import Message
from email.utils import formataddr, parseaddr
from odoo import models, fields, api, tools
from odoo.addons.base.models.ir_mail_server import encode_rfc2822_address_header
from email.utils import parseaddr, formataddr
import logging
import random
from Crypto.Cipher import AES
from odoo import api, fields, models, tools
from odoo.tools import frozendict
from Crypto.Cipher import AES
import base64
from odoo.addons.base.models.ir_mail_server import encode_rfc2822_address_header
_logger = logging.getLogger(__name__)
MESSAGE_PREFIX = 'msg-'
MESSAGE_PREFIX = "msg-"
def random_string(length):
return ''.join(
random.choice(string.ascii_lowercase + string.digits)
for _ in range(length)
return "".join(
random.choice(string.ascii_lowercase + string.digits) for _ in range(length)
)
def get_key(env):
return env['ir.config_parameter']\
.get_param('database.secret', 'noneedtobestrong')[:16]
return env["ir.config_parameter"].get_param("database.secret", "noneedtobestrong")[
:16
]
def get_cipher(env):
return AES.new(get_key(env).encode('utf-8'),
mode=AES.MODE_CBC,
iv=b'veryverysecret81')
return AES.new(
get_key(env).encode("utf-8"), mode=AES.MODE_CBC, iv=b"veryverysecret81"
)
def encode_msg_id(id, env):
id_padded = "%016d" % id
encrypted = get_cipher(env).encrypt(id_padded.encode('utf-8'))
return base64.b32encode(encrypted).decode('utf-8')
encrypted = get_cipher(env).encrypt(id_padded.encode("utf-8"))
return base64.b32encode(encrypted).decode("utf-8")
# Remove in Odoo 14
def encode_msg_id_legacy(id, env):
id_padded = "%016d" % id
encrypted = get_cipher(env).encrypt(id_padded.encode('utf-8'))
return base64.urlsafe_b64encode(encrypted).decode('utf-8')
encrypted = get_cipher(env).encrypt(id_padded.encode("utf-8"))
return base64.urlsafe_b64encode(encrypted).decode("utf-8")
def decode_msg_id(encoded_encrypted_id, env):
@ -75,26 +75,28 @@ def decode_msg_id(encoded_encrypted_id, env):
try:
# Some email clients don't respect the original Reply-To address case
# and might make them lowercase. Make the encoded ID uppercase.
encrypted = base64.b32decode(encoded_encrypted_id.encode('utf-8')
.upper())
encrypted = base64.b32decode(encoded_encrypted_id.encode("utf-8").upper())
except binascii.Error:
# Fall back to base64, which was used by the previous versions.
# This can be removed in Odoo 14.
try:
encrypted = base64.urlsafe_b64decode(encoded_encrypted_id
.encode('utf-8'))
encrypted = base64.urlsafe_b64decode(encoded_encrypted_id.encode("utf-8"))
except binascii.Error:
_logger.error("Unable to decode the message ID. The input value "
_logger.error(
"Unable to decode the message ID. The input value "
"is invalid and cannot be decoded. "
"Encoded value: {}".format(encoded_encrypted_id))
"Encoded value: {}".format(encoded_encrypted_id)
)
raise
try:
id_str = get_cipher(env).decrypt(encrypted).decode('utf-8')
id_str = get_cipher(env).decrypt(encrypted).decode("utf-8")
except UnicodeDecodeError:
_logger.error("Unable to decrypt the message ID. The input value "
_logger.error(
"Unable to decrypt the message ID. The input value "
"probably wasn't encrypted with the same key. Encoded "
"value: {}".format(encoded_encrypted_id))
"value: {}".format(encoded_encrypted_id)
)
raise
return int(id_str)
@ -104,13 +106,9 @@ class MailServer(models.Model):
_inherit = "ir.mail_server"
reply_to_method = fields.Selection(
[
('default', 'Odoo Default'),
('alias', 'Alias'),
('msg_id', 'Message ID'),
],
'Reply-To Method',
default='default',
[("default", "Odoo Default"), ("alias", "Alias"), ("msg_id", "Message ID"),],
"Reply-To Method",
default="default",
help="Odoo Default: Don't add any unique identifiers into the\n"
"Reply-To address.\n"
"\n"
@ -134,64 +132,49 @@ class MailServer(models.Model):
"address to that Odoo will be able to directly connect the\n"
"reply to the original message. Note that in this mode the\n"
"Reply-To address has a priority over References and\n"
"In-Reply-To headers."
"In-Reply-To headers.",
)
force_email_reply_to = fields.Char(
'Force Reply-To Address',
)
force_email_reply_to = fields.Char("Force Reply-To Address",)
force_email_reply_to_name = fields.Char(
'Force Reply-To Name',
)
force_email_reply_to_name = fields.Char("Force Reply-To Name",)
force_email_reply_to_domain = fields.Char(
'Force Reply-To Domain',
)
force_email_reply_to_domain = fields.Char("Force Reply-To Domain",)
force_email_from = fields.Char(
'Force From Address',
)
force_email_from = fields.Char("Force From Address",)
force_email_sender = fields.Char(
'Force Sender Address',
)
force_email_sender = fields.Char("Force Sender Address",)
prioritize_reply_to_over_msgid = fields.Boolean(
'Prioritize Reply-To Over Email Headers',
"Prioritize Reply-To Over Email Headers",
default=True,
help="If this field is selected, the unique Reply-To address "
"generated by the Message ID method will be prioritized "
"over the email headers (default Odoo behavior) in incoming "
"emails. This is recommended when the Reply-To method is set to "
"Message ID."
"Message ID.",
)
headers_example = fields.Text(
'Example Headers',
compute='_compute_headers_example',
store=False,
"Example Headers", compute="_compute_headers_example", store=False,
)
# TODO Implement field input validators
def _get_reply_to_address(self, alias, original_from_name):
self.ensure_one()
force_email_from = encode_rfc2822_address_header(
self.force_email_from
)
force_email_from = encode_rfc2822_address_header(self.force_email_from)
# Split the From address
from_address = force_email_from.split('@')
from_address = force_email_from.split("@")
reply_to_addr = '{alias}@{domain}'.format(
reply_to_addr = "{alias}@{domain}".format(
alias=alias if alias else from_address[0],
domain=self.force_email_reply_to_domain or from_address[1]
domain=self.force_email_reply_to_domain or from_address[1],
)
if self.force_email_reply_to_name:
reply_to = formataddr((self.force_email_reply_to_name,
reply_to_addr))
reply_to = formataddr((self.force_email_reply_to_name, reply_to_addr))
elif original_from_name:
reply_to = formataddr((original_from_name, reply_to_addr))
else:
@ -199,131 +182,154 @@ class MailServer(models.Model):
return encode_rfc2822_address_header(reply_to)
@api.depends('force_email_sender', 'force_email_reply_to',
'force_email_reply_to_domain', 'force_email_from',
'force_email_reply_to_name', 'reply_to_method')
@api.depends(
"force_email_sender",
"force_email_reply_to",
"force_email_reply_to_domain",
"force_email_from",
"force_email_reply_to_name",
"reply_to_method",
)
def _compute_headers_example(self):
for server in self:
example = []
if server.force_email_sender:
example.append('Sender: {}'.format(server.force_email_sender))
example.append("Sender: {}".format(server.force_email_sender))
if server.force_email_reply_to:
example.append('Reply-To: {}'.format(server.force_email_reply_to))
elif server.force_email_from \
and server.reply_to_method != 'default':
reply_to_pair = server.force_email_from.split('@')
if server.reply_to_method == 'alias':
token = '{}+1d278g1082bca'
elif server.reply_to_method == 'msg_id':
token = '{}+' + MESSAGE_PREFIX + 'p2IxKkfEKugl16juheTT0g=='
example.append("Reply-To: {}".format(server.force_email_reply_to))
elif server.force_email_from and server.reply_to_method != "default":
reply_to_pair = server.force_email_from.split("@")
if server.reply_to_method == "alias":
token = "{}+1d278g1082bca"
elif server.reply_to_method == "msg_id":
token = "{}+" + MESSAGE_PREFIX + "p2IxKkfEKugl16juheTT0g=="
else:
token = 'INVALID'
_logger.error('Invalid reply_to_method found: '
+ server.reply_to_method)
token = "INVALID"
_logger.error(
"Invalid reply_to_method found: " + server.reply_to_method
)
# noinspection PyProtectedMember
reply_to = server._get_reply_to_address(
token.format(reply_to_pair[0]),
'Original From Person'
token.format(reply_to_pair[0]), "Original From Person"
)
example.append('Reply-To: {}'.format(reply_to))
example.append("Reply-To: {}".format(reply_to))
else:
example.append('Reply-To: Odoo default')
example.append("Reply-To: Odoo default")
if server.force_email_from:
example.append('From: {}'.format(formataddr(
('Original From Person', server.force_email_from)
)))
example.append(
"From: {}".format(
formataddr(("Original From Person", server.force_email_from))
)
)
else:
example.append('From: Odoo default')
example.append("From: Odoo default")
server.headers_example = "\n".join(example)
@api.model
def send_email(self, message, mail_server_id=None, smtp_server=None,
smtp_port=None, smtp_user=None, smtp_password=None,
smtp_encryption=None, smtp_debug=False, smtp_session=None):
def send_email(
self,
message,
mail_server_id=None,
smtp_server=None,
smtp_port=None,
smtp_user=None,
smtp_password=None,
smtp_encryption=None,
smtp_debug=False,
smtp_session=None,
):
# Get SMTP Server Details from Mail Server
mail_server = None
if mail_server_id:
mail_server = self.sudo().browse(mail_server_id)
elif not smtp_server:
mail_server = self.sudo().search([], order='sequence', limit=1)
mail_server = self.sudo().search([], order="sequence", limit=1)
# Note that Odoo already has the ability to use a fixed From address
# by settings "email_from" in the Odoo settings. This is however a
# secondary option and here email_from always overrides that.
if mail_server.force_email_from:
original_from_name = parseaddr(message['From'])[0]
original_from_name = parseaddr(message["From"])[0]
force_email_from = encode_rfc2822_address_header(
mail_server.force_email_from
)
del message['From']
message['From'] = formataddr((
original_from_name,
force_email_from
))
del message["From"]
message["From"] = formataddr((original_from_name, force_email_from))
if mail_server.reply_to_method == 'alias':
if mail_server.reply_to_method == "alias":
# Find or create an email alias
alias = self.find_or_create_alias(force_email_from.split('@'))
alias = self.find_or_create_alias(force_email_from.split("@"))
# noinspection PyProtectedMember
reply_to = mail_server._get_reply_to_address(
alias,
original_from_name,
)
del message['Reply-To']
message['Reply-To'] = reply_to
reply_to = mail_server._get_reply_to_address(alias, original_from_name,)
del message["Reply-To"]
message["Reply-To"] = reply_to
elif mail_server.reply_to_method == 'msg_id':
odoo_msg_id = message.get('Message-Id')
elif mail_server.reply_to_method == "msg_id":
odoo_msg_id = message.get("Message-Id")
if odoo_msg_id:
# The message_id isn't unique. Prefer the one that has a
# model set and only pick the first record. Odoo does
# almost the same thing in mail.thread.message_route().
odoo_msg = self.sudo().env['mail.message']\
.search([('message_id', '=', odoo_msg_id)],
order='model', limit=1)
odoo_msg = (
self.sudo()
.env["mail.message"]
.search(
[("message_id", "=", odoo_msg_id)], order="model", limit=1
)
)
encrypted_id = encode_msg_id(odoo_msg.id, self.env)
# noinspection PyProtectedMember
reply_to = mail_server._get_reply_to_address(
'{}+{}{}'.format(force_email_from.split('@')[0],
MESSAGE_PREFIX, encrypted_id),
"{}+{}{}".format(
force_email_from.split("@")[0], MESSAGE_PREFIX, encrypted_id
),
original_from_name,
)
_logger.info(
'Generated a new reply-to address "{}" for '
'Message-Id "{}".'
.format(reply_to, odoo_msg_id)
'Message-Id "{}".'.format(reply_to, odoo_msg_id)
)
del message['Reply-To']
message['Reply-To'] = reply_to
del message["Reply-To"]
message["Reply-To"] = reply_to
else:
_logger.warning(
"Couldn't get Message-Id from the message {}. The "
"reply might not find its way to the correct thread."
.format(message.as_string())
"reply might not find its way to the correct thread.".format(
message.as_string()
)
)
if mail_server.force_email_reply_to:
del message['Reply-To']
message['Reply-To'] = encode_rfc2822_address_header(
mail_server.force_email_reply_to)
del message["Reply-To"]
message["Reply-To"] = encode_rfc2822_address_header(
mail_server.force_email_reply_to
)
if mail_server.force_email_sender:
del message['Sender']
message['Sender'] = encode_rfc2822_address_header(
mail_server.force_email_sender)
del message["Sender"]
message["Sender"] = encode_rfc2822_address_header(
mail_server.force_email_sender
)
return super(MailServer, self).send_email(
message, mail_server_id, smtp_server, smtp_port, smtp_user,
smtp_password, smtp_encryption, smtp_debug, smtp_session
message,
mail_server_id,
smtp_server,
smtp_port,
smtp_user,
smtp_password,
smtp_encryption,
smtp_debug,
smtp_session,
)
def find_or_create_alias(self, from_address):
@ -334,34 +340,45 @@ class MailServer(models.Model):
return False
if record_model_name not in self.env:
_logger.error('Unable to find or create an alias for outgoing '
'email: invalid_model name {}.'
.format(record_model_name))
_logger.error(
"Unable to find or create an alias for outgoing "
"email: invalid_model name {}.".format(record_model_name)
)
return False
# Find an alias
alias_model_id = self.env['ir.model'] \
.search([('model', '=', record_model_name)]).id
alias_model_id = (
self.env["ir.model"].search([("model", "=", record_model_name)]).id
)
# noinspection PyPep8Naming
Alias = self.env['mail.alias']
existing_aliases = Alias.search([
('alias_model_id', '=', alias_model_id),
('alias_name', 'like', '{from_address}+'.format(from_address=from_address[0])),
('alias_force_thread_id', '=', record_id),
('alias_contact', '=', 'everyone'), # TODO: check from record
])
Alias = self.env["mail.alias"]
existing_aliases = Alias.search(
[
("alias_model_id", "=", alias_model_id),
(
"alias_name",
"like",
"{from_address}+".format(from_address=from_address[0]),
),
("alias_force_thread_id", "=", record_id),
("alias_contact", "=", "everyone"), # TODO: check from record
]
)
if existing_aliases:
return existing_aliases[0].alias_name
# Create a new alias
alias = Alias.create({
'alias_model_id': alias_model_id,
'alias_name': '{from_address}+{random_string}'.format(from_address=from_address[0],
random_string=random_string(8)),
'alias_force_thread_id': record_id,
'alias_contact': 'everyone',
})
alias = Alias.create(
{
"alias_model_id": alias_model_id,
"alias_name": "{from_address}+{random_string}".format(
from_address=from_address[0], random_string=random_string(8)
),
"alias_force_thread_id": record_id,
"alias_contact": "everyone",
}
)
return alias.alias_name
@ -370,12 +387,12 @@ class MailServer(models.Model):
# Don't ever use active_id or active_model from the context here.
# It might not be the one that you expect. Go ahead and try, open
# a sales order, go to the related purchase order and send the PO.
record_id = ctx.get('default_res_id')
record_model_name = ctx.get('default_model')
record_id = ctx.get("default_res_id")
record_model_name = ctx.get("default_model")
# If incoming_routes isn't enough, we can use ctx['incoming_to'] to
# find a alias directly without active_id and active_model_name.
routes = ctx.get('incoming_routes', [])
routes = ctx.get("incoming_routes", [])
if (not record_id or not record_model_name) and routes and len(routes) > 0:
route = routes[0]
record_model_name = route[0]
@ -405,7 +422,7 @@ class MailServer(models.Model):
class MailThread(models.AbstractModel):
_inherit = 'mail.thread'
_inherit = "mail.thread"
"""
The process for incoming emails goes something like this:
@ -418,43 +435,43 @@ class MailThread(models.AbstractModel):
@api.model
def message_parse(self, message, save_original=False):
email_to = tools.decode_message_header(message, 'To')
email_to_localpart = (tools.email_split(email_to) or [''])[0] \
.split('@', 1)[0]
email_to = tools.decode_message_header(message, "To")
email_to_localpart = (tools.email_split(email_to) or [""])[0].split("@", 1)[0]
config_params = self.env['ir.config_parameter'].sudo()
config_params = self.env["ir.config_parameter"].sudo()
# Check if the To part contains the prefix and a base32/64 encoded string
# Remove the "24," part when migrating to Odoo 14.
prefix_in_to = email_to_localpart and re.search(
r'.*' + MESSAGE_PREFIX + '(?P<odoo_id>.{24,32}$)',
email_to_localpart
r".*" + MESSAGE_PREFIX + "(?P<odoo_id>.{24,32}$)", email_to_localpart
)
prioritize_replyto_over_headers = config_params\
.get_param("email_headers.prioritize_replyto_over_headers", "True")
prioritize_replyto_over_headers = True \
if prioritize_replyto_over_headers != "False" else False
prioritize_replyto_over_headers = config_params.get_param(
"email_headers.prioritize_replyto_over_headers", "True"
)
prioritize_replyto_over_headers = (
True if prioritize_replyto_over_headers != "False" else False
)
# If the msg prefix part is found in the To part, find the parent
# message and inject the Message-Id to the In-Reply-To part and
# remove References because it by default takes priority over
# In-Reply-To. We want the unique Reply-To address have the priority.
if prefix_in_to and prioritize_replyto_over_headers:
message_id_encrypted = prefix_in_to.group('odoo_id')
message_id_encrypted = prefix_in_to.group("odoo_id")
try:
message_id = decode_msg_id(message_id_encrypted, self.env)
parent_id = self.env['mail.message'].browse(message_id)
parent_id = self.env["mail.message"].browse(message_id)
if parent_id:
# See unit test test_reply_to_method_msg_id_priority
del message['References']
del message['In-Reply-To']
message['In-Reply-To'] = parent_id.message_id
del message["References"]
del message["In-Reply-To"]
message["In-Reply-To"] = parent_id.message_id
else:
_logger.warning(
'Received an invalid mail.message database id in incoming '
'email sent to {}. The email type (comment, note) might '
'be wrong.'.format(email_to)
"Received an invalid mail.message database id in incoming "
"email sent to {}. The email type (comment, note) might "
"be wrong.".format(email_to)
)
except UnicodeDecodeError:
_logger.warning(
@ -464,11 +481,12 @@ class MailThread(models.AbstractModel):
res = super(MailThread, self).message_parse(message, save_original)
strip_message_id = config_params\
.get_param("email_headers.strip_mail_message_ids", "True")
strip_message_id = config_params.get_param(
"email_headers.strip_mail_message_ids", "True"
)
strip_message_id = True if strip_message_id != "False" else False
if not strip_message_id == 'True':
if not strip_message_id == "True":
return res
# When Odoo compares message_id to the one stored in the database when determining
@ -488,37 +506,38 @@ class MailThread(models.AbstractModel):
# And then the search is done for an exact match, which will fail.
#
# Odoo doesn't, so we must strip the message_ids before they are stored in the database
mail_message_id = res.get('message_id', '')
mail_message_id = res.get("message_id", "")
if mail_message_id:
mail_message_id = mail_message_id.strip()
res['message_id'] = mail_message_id
res["message_id"] = mail_message_id
return res
@api.model
def message_route_process(self, message, message_dict, routes):
ctx = self.env.context.copy()
ctx['incoming_routes'] = routes
ctx['incoming_to'] = message_dict.get('to')
ctx["incoming_routes"] = routes
ctx["incoming_to"] = message_dict.get("to")
self.env.context = frozendict(ctx)
return super(MailThread, self)\
.message_route_process(message, message_dict, routes)
return super(MailThread, self).message_route_process(
message, message_dict, routes
)
@api.model
def message_route(self, message, message_dict, model=None,
thread_id=None, custom_values=None):
def message_route(
self, message, message_dict, model=None, thread_id=None, custom_values=None
):
# NOTE! If you're going to backport this module to Odoo 11 or Odoo 10,
# you will have to create the mail_bounce_catchall email template
# because it was introduced only in Odoo 12.
if not isinstance(message, Message):
raise TypeError('message must be an '
'email.message.Message at this point')
raise TypeError("message must be an " "email.message.Message at this point")
try:
route = super(MailThread, self)\
.message_route(message, message_dict, model,
thread_id, custom_values)
route = super(MailThread, self).message_route(
message, message_dict, model, thread_id, custom_values
)
except ValueError:
# If the headers that connect the incoming message to a thread in
@ -530,31 +549,37 @@ class MailThread(models.AbstractModel):
# Odoo to send a bounce message to the sender who sent the email to
# the correct thread-specific address.
catchall_alias = self.env['ir.config_parameter']\
.sudo().get_param("mail.catchall.alias.custom")
catchall_alias = (
self.env["ir.config_parameter"]
.sudo()
.get_param("mail.catchall.alias.custom")
)
email_to = tools.decode_message_header(message, 'To')
email_to_localpart = (tools.email_split(email_to) or [''])[0]\
.split('@', 1)[0].lower()
email_to = tools.decode_message_header(message, "To")
email_to_localpart = (
(tools.email_split(email_to) or [""])[0].split("@", 1)[0].lower()
)
message_id = message.get('Message-Id')
email_from = tools.decode_message_header(message, 'From')
message_id = message.get("Message-Id")
email_from = tools.decode_message_header(message, "From")
# check it does not directly contact catchall
if catchall_alias and catchall_alias in email_to_localpart:
_logger.info(
'Routing mail from %s to %s with Message-Id %s: '
'direct write to catchall, bounce', email_from,
email_to, message_id)
body = self.env.ref('mail.mail_bounce_catchall').render({
'message': message,
}, engine='ir.qweb')
"Routing mail from %s to %s with Message-Id %s: "
"direct write to catchall, bounce",
email_from,
email_to,
message_id,
)
body = self.env.ref("mail.mail_bounce_catchall").render(
{"message": message,}, engine="ir.qweb"
)
self._routing_create_bounce_email(
email_from, body, message,
reply_to=self.env.user.company_id.email)
email_from, body, message, reply_to=self.env.user.company_id.email
)
return []
else:
raise
return route

295
email_headers/tests/test_email.py

@ -1,55 +1,68 @@
import odoo
from odoo.tests import TransactionCase
from email.message import EmailMessage
from ..models.mail import encode_msg_id
from ..models.mail import encode_msg_id_legacy
from ..models.mail import MESSAGE_PREFIX
import mock
import odoo
from odoo import SUPERUSER_ID
from odoo.tests import TransactionCase
from odoo.addons.base.models.ir_mail_server import IrMailServer
from ..models.mail import random_string
from ..models.mail import (
MESSAGE_PREFIX,
encode_msg_id,
encode_msg_id_legacy,
random_string,
)
@odoo.tests.tagged('post_install', '-at_install')
class TestEmail(TransactionCase):
@odoo.tests.tagged("post_install", "-at_install")
class TestEmail(TransactionCase):
def setUp(self):
super(TestEmail, self).setUp()
self.partner = self.env['res.partner'].create({'name': 'Test Dude'})
self.partner2 = self.env['res.partner'].create({'name': 'Dudette'})
self.demo_user = self.env.ref('base.user_demo')
self.subtype_comment = self.env.ref('mail.mt_comment')
self.subtype_note = self.env.ref('mail.mt_note')
self.partner = self.env["res.partner"].create({"name": "Test Dude"})
self.partner2 = self.env["res.partner"].create({"name": "Dudette"})
self.demo_user = self.env.ref("base.user_demo")
self.subtype_comment = self.env.ref("mail.mt_comment")
self.subtype_note = self.env.ref("mail.mt_note")
self.MailMessage = self.env['mail.message']
self.ConfigParam = self.env['ir.config_parameter']
self.MailMessage = self.env["mail.message"]
self.ConfigParam = self.env["ir.config_parameter"]
# Create server configuration
self.outgoing_server = self.env['ir.mail_server'].create({
'name': 'Outgoing SMTP Server for Unit Tests',
'sequence': 1,
'smtp_host': 'localhost',
'smtp_port': '9999',
'smtp_encryption': 'none',
'smtp_user': 'doesnt',
'smtp_pass': 'exist',
'reply_to_method': 'msg_id',
'force_email_reply_to_domain': 'example.com',
'force_email_from': 'odoo@example.com',
})
self.outgoing_server = self.env["ir.mail_server"].create(
{
"name": "Outgoing SMTP Server for Unit Tests",
"sequence": 1,
"smtp_host": "localhost",
"smtp_port": "9999",
"smtp_encryption": "none",
"smtp_user": "doesnt",
"smtp_pass": "exist",
"reply_to_method": "msg_id",
"force_email_reply_to_domain": "example.com",
"force_email_from": "odoo@example.com",
}
)
@staticmethod
def create_email_message():
message = EmailMessage()
message['Content-Type'] = 'multipart/mixed; boundary="===============2590914155756834027=="'
message['MIME-Version'] = '1.0'
message['Message-Id'] = '<CAD-eYi=a264_3DcrYSDU5yc_fwYoHonZ3H+{}@mail.gmail.com>'.format(random_string(6))
message['Subject'] = '1'
message['From'] = 'Miku Laitinen <miku@avoin.systems>'
message['Reply-To'] = 'YourCompany Eurooppa <sales@avoin.onmicrosoft.com>'
message['To'] = '"Erik N. French" <ErikNFrench@armyspy.com>'
message['Date'] = 'Mon, 06 May 2019 14:16:38 -0000'
message[
"Content-Type"
] = 'multipart/mixed; boundary="===============2590914155756834027=="'
message["MIME-Version"] = "1.0"
message[
"Message-Id"
] = "<CAD-eYi=a264_3DcrYSDU5yc_fwYoHonZ3H+{}@mail.gmail.com>".format(
random_string(6)
)
message["Subject"] = "1"
message["From"] = "Miku Laitinen <miku@avoin.systems>"
message["Reply-To"] = "YourCompany Eurooppa <sales@avoin.onmicrosoft.com>"
message["To"] = '"Erik N. French" <ErikNFrench@armyspy.com>'
message["Date"] = "Mon, 06 May 2019 14:16:38 -0000"
return message
def test_reply_to_method_msg_id(self):
@ -59,9 +72,7 @@ class TestEmail(TransactionCase):
# Send a message to the followers of the partner
thread_msg = self.partner.with_user(self.demo_user).message_post(
body='dummy message.',
message_type='comment',
subtype='mail.mt_comment'
body="dummy message.", message_type="comment", subtype="mail.mt_comment"
)
# Make sure the message headers look right.. or not
@ -72,47 +83,73 @@ class TestEmail(TransactionCase):
# Try to read an incoming email
message = self.create_email_message()
del message['To']
message['To'] = '"Erik N. French" <ErikNFrench+{}{}@armyspy.com>'.format(MESSAGE_PREFIX, encoded_msg_id)
del message["To"]
message["To"] = '"Erik N. French" <ErikNFrench+{}{}@armyspy.com>'.format(
MESSAGE_PREFIX, encoded_msg_id
)
thread_id = self.env['mail.thread'].message_process(model=False, message=message.as_string())
self.assertEqual(thread_msg.res_id, thread_id,
"The incoming email wasn't connected to the correct thread")
thread_id = self.env["mail.thread"].message_process(
model=False, message=message.as_string()
)
self.assertEqual(
thread_msg.res_id,
thread_id,
"The incoming email wasn't connected to the correct thread",
)
# Make sure the message is a comment
incoming_msg1 = self.MailMessage.search([('message_id', '=', message['Message-Id'])])
incoming_msg1 = self.MailMessage.search(
[("message_id", "=", message["Message-Id"])]
)
self.assertEqual(
incoming_msg1.message_type,
'email',
"The incoming message was created as a type {} instead of a email.".format(incoming_msg1.message_type)
"email",
"The incoming message was created as a type {} instead of a email.".format(
incoming_msg1.message_type
),
)
self.assertEqual(
incoming_msg1.subtype_id,
self.subtype_comment,
"The incoming message was created as a subtype {} instead of a comment.".format(incoming_msg1.subtype_id)
"The incoming message was created as a subtype {} instead of a comment.".format(
incoming_msg1.subtype_id
),
)
# Try to read another incoming email
message = self.create_email_message()
del message['To']
message['To'] = '"Erik N. French" <ErikNFrench+{}HURDURLUR@armyspy.com>'.format(MESSAGE_PREFIX)
message['In-Reply-To'] = thread_msg.message_id
del message["To"]
message["To"] = '"Erik N. French" <ErikNFrench+{}HURDURLUR@armyspy.com>'.format(
MESSAGE_PREFIX
)
message["In-Reply-To"] = thread_msg.message_id
thread_id = self.env['mail.thread'].message_process(model=False, message=message.as_string())
self.assertEqual(thread_msg.res_id, thread_id,
"The incoming email wasn't connected to the correct thread")
thread_id = self.env["mail.thread"].message_process(
model=False, message=message.as_string()
)
self.assertEqual(
thread_msg.res_id,
thread_id,
"The incoming email wasn't connected to the correct thread",
)
# Make sure the message is a comment
incoming_msg2 = self.MailMessage.search([('message_id', '=', message['Message-Id'])])
incoming_msg2 = self.MailMessage.search(
[("message_id", "=", message["Message-Id"])]
)
self.assertEqual(
incoming_msg2.message_type,
'email',
"The incoming message was created as a type {} instead of a email.".format(incoming_msg2.message_type)
"email",
"The incoming message was created as a type {} instead of a email.".format(
incoming_msg2.message_type
),
)
self.assertEqual(
incoming_msg2.subtype_id,
self.subtype_comment,
"The incoming message was created as a subtype {} instead of a comment.".format(incoming_msg2.subtype_id)
"The incoming message was created as a subtype {} instead of a comment.".format(
incoming_msg2.subtype_id
),
)
def test_reply_to_method_msg_id_priority(self):
@ -128,9 +165,7 @@ class TestEmail(TransactionCase):
# Send a message to the followers of the partner
thread_msg = self.partner.with_user(self.demo_user).message_post(
body='dummy message X.',
message_type='comment',
subtype='mail.mt_comment'
body="dummy message X.", message_type="comment", subtype="mail.mt_comment"
)
# Get the encoded message address
@ -138,23 +173,28 @@ class TestEmail(TransactionCase):
# Send another message to the followers of the partner
thread_msg2 = self.partner2.with_user(self.demo_user).message_post(
body='dummy message X.',
message_type='comment',
subtype='mail.mt_comment'
body="dummy message X.", message_type="comment", subtype="mail.mt_comment"
)
# Try to read an incoming email
message = self.create_email_message()
del message['To']
del message['References']
message['To'] = '"Erik N. French" <ErikNFrench+{}{}@armyspy.com>'.format(MESSAGE_PREFIX, encoded_msg_id)
del message["To"]
del message["References"]
message["To"] = '"Erik N. French" <ErikNFrench+{}{}@armyspy.com>'.format(
MESSAGE_PREFIX, encoded_msg_id
)
# Inject the wrong References
message['References'] = thread_msg2.message_id
message["References"] = thread_msg2.message_id
thread_id = self.env['mail.thread'].message_process(model=False, message=message.as_string())
self.assertEqual(thread_msg.res_id, thread_id,
"The incoming email wasn't connected to the correct thread")
thread_id = self.env["mail.thread"].message_process(
model=False, message=message.as_string()
)
self.assertEqual(
thread_msg.res_id,
thread_id,
"The incoming email wasn't connected to the correct thread",
)
def test_reply_to_method_msg_id_notification(self):
@ -163,9 +203,7 @@ class TestEmail(TransactionCase):
# Send a message to the followers of the partner
thread_msg = self.partner2.with_user(self.demo_user).message_post(
body='dummy message 2.',
message_type='comment',
subtype='mail.mt_note'
body="dummy message 2.", message_type="comment", subtype="mail.mt_note"
)
# Get the encoded message address
@ -173,24 +211,37 @@ class TestEmail(TransactionCase):
# Try to read an incoming email
message = self.create_email_message()
del message['To']
message['To'] = '"Erik N. French" <ErikNFrench+{}{}@armyspy.com>'.format(MESSAGE_PREFIX, encoded_msg_id)
del message["To"]
message["To"] = '"Erik N. French" <ErikNFrench+{}{}@armyspy.com>'.format(
MESSAGE_PREFIX, encoded_msg_id
)
thread_id = self.env['mail.thread'].message_process(model=False, message=message.as_string())
self.assertEqual(thread_msg.res_id, thread_id,
"The incoming email wasn't connected to the correct thread")
thread_id = self.env["mail.thread"].message_process(
model=False, message=message.as_string()
)
self.assertEqual(
thread_msg.res_id,
thread_id,
"The incoming email wasn't connected to the correct thread",
)
# Make sure the message is a note
incoming_msg1 = self.MailMessage.search([('message_id', '=', message['Message-Id'])])
incoming_msg1 = self.MailMessage.search(
[("message_id", "=", message["Message-Id"])]
)
self.assertEqual(
incoming_msg1.message_type,
'email',
"The incoming message was created as a type {} instead of a email.".format(incoming_msg1.message_type)
"email",
"The incoming message was created as a type {} instead of a email.".format(
incoming_msg1.message_type
),
)
self.assertEqual(
incoming_msg1.subtype_id,
self.subtype_note,
"The incoming message was created as a subtype {} instead of a note.".format(incoming_msg1.subtype_id)
"The incoming message was created as a subtype {} instead of a note.".format(
incoming_msg1.subtype_id
),
)
def test_reply_to_method_msg_id_legacy(self):
@ -201,9 +252,7 @@ class TestEmail(TransactionCase):
# Send a message to the followers of the partner
thread_msg = self.partner2.with_user(self.demo_user).message_post(
body='dummy message 2.',
message_type='comment',
subtype='mail.mt_note'
body="dummy message 2.", message_type="comment", subtype="mail.mt_note"
)
# Get the encoded message address
@ -211,12 +260,19 @@ class TestEmail(TransactionCase):
# Try to read an incoming email
message = self.create_email_message()
del message['To']
message['To'] = '"Erik N. French" <ErikNFrench+{}{}@armyspy.com>'.format(MESSAGE_PREFIX, encoded_msg_id)
del message["To"]
message["To"] = '"Erik N. French" <ErikNFrench+{}{}@armyspy.com>'.format(
MESSAGE_PREFIX, encoded_msg_id
)
thread_id = self.env['mail.thread'].message_process(model=False, message=message.as_string())
self.assertEqual(thread_msg.res_id, thread_id,
"The incoming email wasn't connected to the correct thread")
thread_id = self.env["mail.thread"].message_process(
model=False, message=message.as_string()
)
self.assertEqual(
thread_msg.res_id,
thread_id,
"The incoming email wasn't connected to the correct thread",
)
def test_reply_to_method_msg_id_lowercase(self):
# Make administrator follow the partner
@ -224,9 +280,7 @@ class TestEmail(TransactionCase):
# Send a message to the followers of the partner
thread_msg = self.partner2.with_user(self.demo_user).message_post(
body='dummy message 2.',
message_type='comment',
subtype='mail.mt_note'
body="dummy message 2.", message_type="comment", subtype="mail.mt_note"
)
# Get the encoded message address
@ -234,23 +288,30 @@ class TestEmail(TransactionCase):
# Try to read an incoming email
message = self.create_email_message()
del message['To']
message['To'] = '"Erik N. French" <ErikNFrench+{}{}@armyspy.com>'.format(MESSAGE_PREFIX, encoded_msg_id)
del message["To"]
message["To"] = '"Erik N. French" <ErikNFrench+{}{}@armyspy.com>'.format(
MESSAGE_PREFIX, encoded_msg_id
)
thread_id = self.env['mail.thread'].message_process(model=False, message=message.as_string())
self.assertEqual(thread_msg.res_id, thread_id,
"The incoming email wasn't connected to the correct thread")
thread_id = self.env["mail.thread"].message_process(
model=False, message=message.as_string()
)
self.assertEqual(
thread_msg.res_id,
thread_id,
"The incoming email wasn't connected to the correct thread",
)
def test_outgoing_msg_id(self):
# Make administrator follow the partner
self.partner2.message_subscribe([SUPERUSER_ID])
with mock.patch.object(IrMailServer, 'send_email') as send_email:
with mock.patch.object(IrMailServer, "send_email") as send_email:
# Send a message to the followers of the partner
thread_msg = self.partner2.with_user(self.demo_user).message_post(
body='dummy message 3.',
message_type='comment',
subtype='mail.mt_comment'
body="dummy message 3.",
message_type="comment",
subtype="mail.mt_comment",
)
# Get the encoded message address
@ -258,27 +319,33 @@ class TestEmail(TransactionCase):
self.assertTrue(
send_email.called,
"IrMailServer.send_email wasn't called when sending outgoing email"
"IrMailServer.send_email wasn't called when sending outgoing email",
)
message = send_email.call_args[0][0]
reply_to_address = '{}{}@{}'.format(
reply_to_address = "{}{}@{}".format(
MESSAGE_PREFIX,
encoded_msg_id,
self.outgoing_server.force_email_reply_to_domain
self.outgoing_server.force_email_reply_to_domain,
)
# Make sure the subaddress is correct in the Reply-To field
self.assertIn(reply_to_address,
message['Reply-To'],
"Reply-To address didn't contain the correct subaddress")
self.assertIn(
reply_to_address,
message["Reply-To"],
"Reply-To address didn't contain the correct subaddress",
)
# Make sure the author name is in the Reply-To field
self.assertIn(thread_msg.author_id.name,
message['Reply-To'],
"Reply-To address didn't contain the author name")
self.assertIn(
thread_msg.author_id.name,
message["Reply-To"],
"Reply-To address didn't contain the author name",
)
self.assertIn(self.outgoing_server.force_email_from,
message['From'],
"From address didn't contain the configure From-address")
self.assertIn(
self.outgoing_server.force_email_from,
message["From"],
"From address didn't contain the configure From-address",
)

4
email_headers/views/ir_mail_server_views.xml

@ -1,13 +1,11 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo>
<!-- FORM: ir.mail.server -->
<record id="ir_mail_server_form_email_headers" model="ir.ui.view">
<field name="name">ir.mail_server.form.email.headers</field>
<field name="model">ir.mail_server</field>
<field name="inherit_id" ref="base.ir_mail_server_form" />
<field name="arch" type="xml">
<xpath expr="//group[last()]" position="after">
<group name="advanced" string="Smart Headers">
<field name="force_email_sender" />
@ -19,8 +17,6 @@
<field name="headers_example" />
</group>
</xpath>
</field>
</record>
</odoo>
Loading…
Cancel
Save