Documentation

Calendar Invites

The send API lets you create calendar invites in with your email, but we are not just talking .ics files. With our calendar invites, your users can RSVP for an event you create. This means the event gets added to their calendars, and you in turn, get to know the status of your attendees. This is especially useful if you are running an event management system, are scheduling calls or whatever use case you might have. Here's how to do it with SMTP Express.

Sending a calendar invite

1// npm install smtpexpress
2import { createClient } from "smtpexpress"
3const smtpexpressClient = createClient({...});
4
5smtpexpressClient.sendApi.sendMail({
6  ...
7  calendarEvent: {
8    title: "My event name",
9    startDate: "2024-01-18T23:00:00.000Z",
10    endDate: "2024-01-19T23:00:00.000Z"
11  },
12});

Calendar event parameters

calendarEvent

string

title *

string

The name of the event as it should be displayed on the user's calendar

startDate *

Date | String

The start date and time of the event. Only supports time in ISO Format

endDate *

Object

The end date and time of the event. Only supports time in ISO Format

organizer

String

Email address of the organizer of the event. Defaults to sender email address

location

String

Tell your users where the event is happening. Remote or physical event? Let them know where

url

String

An optional url for the event. Could be a zoom link or a map link for physical events!

description

String

An optional description for the event. Tell your users what the event is all about