Reminder

Todo

Docstrings (module)

Models

class indico.modules.events.reminders.models.reminders.EventReminder(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Model

Email reminders for events

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

all_recipients

Returns all recipients of the notifications.

This includes both explicit recipients and, if enabled, participants of the event.

created_dt

The date/time when the reminder was created

creator

The user who created the reminder

creator_id

The ID of the user who created the reminder

event

The Event this reminder is associated with

event_id

The ID of the event

event_start_delta

How long before the event start the reminder should be sent This is needed to update the scheduled_dt when changing the start time of the event.

id

The ID of the reminder

include_summary

If the notification should include a summary of the event’s schedule.

is_overdue
is_relative

Returns if the reminder is relative to the event time

is_sent

If the reminder has been sent

locator
message

Custom message to include in the email

recipients

The recipients of the notification

reply_to_address

The address to use as Reply-To in the notification email.

scheduled_dt

The date/time when the reminder should be sent

send()

Sends the reminder to its recipients.

send_to_participants

If the notification should also be sent to all event participants

Utilities

indico.modules.events.reminders.util.make_reminder_email(event, with_agenda, note)

Returns the template module for the reminder email.

Parameters:
  • event – The event
  • with_agenda – If the event’s agenda should be included
  • note – A custom message to include in the email