1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00
Files
peeringdb-peeringdb/peeringdb_server/mail.py
Matt Griswold c21130eed9 Docs 202109 (#1067)
* module docstrings

* db schema graph

* dev docs first pass

* dev docs pass 2

* add generated notification to top of generated docs files

* linting

* regen docs

Co-authored-by: Stefan Pratter <stefan@20c.com>
Co-authored-by: Sunshine Buchholz <sunshine@20c.com>
2021-10-15 03:25:38 -05:00

102 lines
3.2 KiB
Python

"""
Utility functions for emailing users and admin staff.
"""
from django.conf import settings
from django.core.mail.message import EmailMultiAlternatives
from django.template import loader
from django.utils.html import strip_tags
from django.utils.translation import override
from django.utils.translation import ugettext_lazy as _
def mail_admins_with_from(
subj, msg, from_addr, fail_silently=False, connection=None, html_message=None
):
"""
Mail admins but allow specifying of from address.
"""
if not settings.ADMINS:
return
# set plain text message
strip_tags(msg)
mail = EmailMultiAlternatives(
f"{settings.EMAIL_SUBJECT_PREFIX}{subj}",
msg,
from_addr,
[a[1] for a in settings.ADMINS],
connection=connection,
)
# attach html message
mail.attach_alternative(msg.replace("\n", "<br />\n"), "text/html")
mail.send(fail_silently=fail_silently)
def mail_users_entity_merge(users_source, users_target, entity_source, entity_target):
"""
Notify the users specified in users_source that their entity (entity_source) has
been merged with another entity (entity_target).
Notify the users specified in users_target that an entity has ben merged into their
entity (entity_target).
Arguments:
- users_source <list>: list of User objects
- users_target <list>: list of User objects
- entity_source <HandleRef>: handleref object, entity that was merged
- entity_target <HandleRef>: handleref object, entity that was merged into
"""
msg = loader.get_template("email/notify-org-admin-merge.txt").render(
{
"entity_type_name": entity_source._meta.verbose_name.capitalize(),
"entity_source": entity_source,
"entity_target": entity_target,
"entity_target_url": "{}/{}/{}".format(
settings.BASE_URL, entity_target.ref_tag, entity_target.id
),
"support_email": settings.DEFAULT_FROM_EMAIL,
}
)
for user in set([u for u in users_source] + [u for u in users_target]):
# FIXME: why not have the `override` call in email_user in the first place?
with override(user.locale):
user.email_user(
_("{} Merge Notification: {} -> {}").format(
entity_source._meta.verbose_name.capitalize(),
entity_source.name,
entity_target.name,
),
msg,
)
def mail_username_retrieve(email, secret):
"""
Send an email to the specified email address containing
the url for username retrieval.
Arguments:
- email <str>
- secret <str>: username retrieval secret in the user's session
"""
msg = loader.get_template("email/username-retrieve.txt").render(
{
"email": email,
"secret": secret,
"username_retrieve_url": "{}/username-retrieve/complete?secret={}".format(
settings.BASE_URL, secret
),
}
)
subject = "PeeringDB username retrieval"
mail = EmailMultiAlternatives(subject, msg, settings.DEFAULT_FROM_EMAIL, [email])
mail.send(fail_silently=False)