EmailTemplatesMixin#

class squirro_client.topic.EmailTemplatesMixin#

Bases: object

Methods Summary

edit_email_template(template_name, data)

Edit an email template.

get_email_template(template_name)

Get an email template.

list_email_templates()

List all email templates.

send_sample_email(template_name, email, data)

Sends a sample email.

Methods Documentation

edit_email_template(template_name, data)#

Edit an email template.

Parameters

  • template_name – str, the name of the template

  • data – dict, the json body

get_email_template(template_name)#

Get an email template.

Parameters

template_name – str, the name of the template

Returns

dict

list_email_templates()#

List all email templates.

Returns

List of email template names.

send_sample_email(template_name, email, data)#

Sends a sample email.

Parameters

  • template_name – str, the name of the template

  • email – str, email address

  • data – dict, with the keys content, content_plain, subject providing email templates