About
The iCalendar module controls how calendar invites are generated and customized when users click the Add to Calendar button for scheduled sessions. It allows admins to define the content of downloadable iCal files and enables the option to send calendar invites by email.
Using this module, you can:
- customize the title and description of calendar events.
- enable the Send by email option, which works with the EmailTemplates module.
Configure
Go to your Configuration Management console and click the ICalendar module. You can also navigate directly using a link: https://{your_site_url}/admin/config/tab/iCalendar
The ICalendar page displays.
Enable the 'Send by email' option
Before you begin, make sure to:
- Set up an email template in the emailtemplates module
- Choose an email service in the EmailService module
The Send by email feature is only available on Theming-based pages.
Configure the following:
emailSessionIcal - Set to 'enabled' to allow sending calendar invites by email.
sessioniCalEmailTemplate - Choose the email template you created in the emailtemplates module. This controls the calendar invite's subject, body, and event details.
'Add to Calendar' button on a session page with 'Send by email' option enabledCustomize iCal content
The iCalDownload section lets you define what appears when users download a calendar file from the Add to Calendar button on a session page and session cards.
You can use tokens to insert dynamic session information. If you leave fields blank, default values will be used.
Available tokens:
- {SESSIONNAME} – Inserts the session's name.
- {SESSIONDESCRIPTION} – Inserts the session's description.
- {SESSIONURL} – Inserts the session's URL.
- {SESSIONMAGICLINK} – Provides direct access via Magic Link for logged-in users (if the emaillogin module is enabled). If users are not logged in, it will default to the session's URL
Configure the following:
iCalTitle - Enter plain text only (no formatting or HTML). Supports only {SESSIONNAME}.
iCalDescription - Enter plain text only (no formatting or HTML). Supports all available tokens ({SESSIONNAME}, {SESSIONDESCRIPTION}, {SESSIONURL}, {SESSIONMAGICLINK}).
Click Save to apply your changes.
