1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00
Files
peeringdb-peeringdb/docs/dev/modules/mail.py.md
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

1.2 KiB

Generated from mail.py on 2021-10-15 07:56:57.376975

peeringdb_server.mail

Utility functions for emailing users and admin staff.

Functions


mail_admins_with_from

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.


mail_username_retrieve

def mail_username_retrieve(email, secret)

Send an email to the specified email address containing the url for username retrieval.

Arguments: - email - secret : username retrieval secret in the user's session


mail_users_entity_merge

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 of User objects - users_target : list of User objects - entity_source : handleref object, entity that was merged - entity_target : handleref object, entity that was merged into