Modifier le weekmail

Le site est capable de générer des mails automatiques composé de l’agrégation d’articles composé par les administrateurs de clubs. Le contenu est inséré dans un template standardisé et contrôlé directement dans le code. Il arrive régulièrement que l’équipe communication souhaite modifier ce template. Que ce soit les couleurs, l’agencement ou encore la bannière ou le footer, voici tout ce qu’il y a à savoir sur le fonctionnement du weekmail en commençant par la classe qui le contrôle.

class com.models.Weekmail(*args, **kwargs)

The weekmail class

Variables

• title – Title of the weekmail

• intro – Introduction of the weekmail

• joke – Joke of the week

• protip – Tip of the week

• conclusion – Conclusion of the weekmail

• sent – Track if the weekmail has been sent

exception DoesNotExist

exception MultipleObjectsReturned

get_banner()

Return an absolute link to the banner.

get_footer()

Return an absolute link to the footer.

render_html()

Renders an HTML version of the mail with images and fancy CSS.

render_text()

Renders a pure text version of the mail for readers without HTML support.

send()

Send the weekmail to all users with the receive weekmail option opt-in. Also send the weekmail to the mailing list in settings.SITH_COM_EMAIL.

Modifier la bannière et le footer

Comme on peut l’observer plus haut, ces éléments sont contrôlés par les méthodes get_banner et get_footer de la classe Weekmail. Les modifier est donc très simple, il suffit de modifier le contenu de la fonction et de rajouter les nouvelles images dans les statics.

Les images sont à ajouter dans dans core/static/com/img et sont à nommer selon le type (banner ou footer), le semestre (Automne ou Printemps) et l’année.

Exemple : weekmail_bannerA18.jpg pour la bannière de l’automne 2018.

# Sélectionner le fichier de bannière pour le weekmail de l'automne 2018

def get_banner(self):
    return "http://" + settings.SITH_URL + static("com/img/weekmail_bannerA18.jpg")

Note

Penser à prendre les images au format jpg et que les images soient le plus léger possible, c’est bien mieux pour l’utilisateur final.

Note

Pensez à laisser les anciennes images dans le dossier pour que les anciens weekmails ne soient pas affectés par les changements.

Modifier le template

Comme on peut le voir dans la documentation de la classe, il existe deux templates différents. Un des templates est en texte pur et sert pour le rendu dégradé des lecteurs de mails ne supportant pas le HTML et un autre fait un rendu en HTML.

Ces deux templates sont respectivement accessibles aux emplacements suivants :

• com/templates/com/weekmail_renderer_html.jinja

• com/templates/com/weekmail_renderer_text.jinja

Note

Pour le rendu HTML, pensez à utiliser le CSS et le javascript le plus simple possible pour que le rendu se fasse correctement dans les clients mails qui sont souvent capricieux.

Note

Le CSS est inclus statiquement pour que toute modification ultérieure de celui-ci n’affecte pas les versions précédemment envoyées.

Avertissement

Si vous souhaitez ajouter du contenu, n’oubliez pas de bien inclure ce contenu dans les deux templates.