HI WELCOME TO SIRIS

Create iCal ics Files in C# ASP.NET MVC – Several Methods

Leave a Comment
Creating an iCal (ics file) is really simple. In this post I will show you how to create one using iCal.NET library and one using plain ol StringBuilder.
First of all, this is the basic format for an iCal
  1. BEGIN:VCALENDAR
  2. PRODID:-//LEEDS MUSIC SCENE//EN
  3. VERSION:2.0
  4. METHOD:PUBLISH
  5. BEGIN:VEVENT
  6. SUMMARY:BAND @ VENUE
  7. PRIORITY:0
  8. CATEGORIES:GIG
  9. CLASS:PUBLIC
  10. DTSTART:STARTTIME
  11. DTEND:ENDTIME
  12. URL:LINK TO LMS GIG PAGE
  13. DESCRIPTION:FULL BAND LIST
  14. LOCATION:VENUE
  15. END:VEVENT
  16. END:VCALENDAR
Source: This PasteBin
The calendar begins with the keyword BEGIN:VCALENDAR and ends with END:VCALENDAR. In between the calendar you can add as many events as you want beginning each event with BEGIN:VEVENT and ending with END:VEVENT.
There is a catch when adding multiple events to a calendar, and that is the type of METHOD you use. With METHOD:PUBLISH, you can add multiple events and upoin opening the iCal with MS Outlook it will create a new calendar, separate from your main Exchange calendar. METHOD:REQUEST creates a calendar invite, so you can only include one event and upon openning with MS Outlook it will ask you to accept the event and add it to your main Exchange calendar. With this method you have to include the orginizer (ORGANIZER;CN=Your Name:mailto:email@company.com)

Using iCal.NET

Download iCal.NET via nuget package then import the libraries to your class.
In the code below I create an email message and at the end I attach the iCal to the email message.
Everything else in the code below is pretty self-explanatory. You create a new calendar, loop thru a list of events, serialize the calendar, convert to bytes, put into a memory stream and finally attach it to the email message.
  1. using Ical.Net;
  2. using Ical.Net.DataTypes;
  3. using Ical.Net.Serialization.iCalendar.Serializers;
  4. using Ical.Net.Serialization;
  5. ...
  6. MailMessage message = new MailMessage();
  7. message.To.Add("johndoe@user.com");
  8. message.From = new MailAddress("info@company.com", "Company, Inc");
  9. message.Subject = "subject";
  10. message.Body = "emailbody";
  11. message.IsBodyHtml = true;
  12. ...
  13. var calendar = new Ical.Net.Calendar();
  15. foreach (var res in reg.Reservations) {
  16. calendar.Events.Add(new Event {
  17. Class = "PUBLIC",
  18. Summary = res.Summary,
  19. Created = new CalDateTime(DateTime.Now),
  20. Description = res.Details,
  21. Start = new CalDateTime(Convert.ToDateTime(res.BeginDate)),
  22. End = new CalDateTime(Convert.ToDateTime(res.EndDate)),
  23. Sequence = 0,
  24. Uid = Guid.NewGuid().ToString(),
  25. Location = res.Location,
  26. });
  27. }
  29. var serializer = new CalendarSerializer(new SerializationContext());
  30. var serializedCalendar = serializer.SerializeToString(calendar);
  31. var bytesCalendar = Encoding.UTF8.GetBytes(serializedCalendar);
  32. MemoryStream ms = new MemoryStream(bytesCalendar);
  33. System.Net.Mail.Attachment attachment = new System.Net.Mail.Attachment(ms, "event.ics", "text/calendar");
  35. message.Attachments.Add(attachment);
  36. ...
The output of the serializedCalendar calendar is similar to my sample string calendar at the top of the page.

Using StringBuilder

I like this approach better as you have more flexibility and not be bound by a library that may or may not have all of the iCal attributes implemented. Now, don’t get me wrong iCal.NET is a great library, but I prefer to write the string myself.
Just as the above method, here I create a mail message, then with the StringBuilder I begin the calendar, loop thru my list of events creating calendar events, then ending the calendar and finally attaching my calendar to the email message. Pretty simple.
If you notice, I have DESCRIPTION attribute commented out, this only accepts plain text and X-ALT-DESC;FMTTYPE=text/html accepts HTML. Note that I have only tested on MS Outlook, not sure if X-ALT-DESC will work with other applications.
  1. ...
  2. MailMessage message = new MailMessage();
  3. message.To.Add("johndoe@user.com");
  4. message.From = new MailAddress("info@company.com", "Company, Inc");
  5. message.Subject = "subject";
  6. message.Body = "emailbody";
  7. message.IsBodyHtml = true;
  8. ...
  9. StringBuilder sb = new StringBuilder();
  10. string DateFormat = "yyyyMMddTHHmmssZ";
  11. string now = DateTime.Now.ToUniversalTime().ToString(DateFormat);
  13. sb.AppendLine("BEGIN:VCALENDAR");
  14. sb.AppendLine("PRODID:-//Compnay Inc//Product Application//EN");
  15. sb.AppendLine("VERSION:2.0");
  16. sb.AppendLine("METHOD:PUBLISH");
  18. foreach (var res in reg.Reservations) {
  19. DateTime dtStart = Convert.ToDateTime(res.BeginDate);
  20. DateTime dtEnd = Convert.ToDateTime(res.EndDate);
  22. sb.AppendLine("BEGIN:VEVENT");
  23. sb.AppendLine("DTSTART:" + dtStart.ToUniversalTime().ToString(DateFormat));
  24. sb.AppendLine("DTEND:" + dtEnd.ToUniversalTime().ToString(DateFormat));
  25. sb.AppendLine("DTSTAMP:" + now);
  26. sb.AppendLine("UID:" + Guid.NewGuid());
  27. sb.AppendLine("CREATED:" + now);
  28. sb.AppendLine("X-ALT-DESC;FMTTYPE=text/html:" + res.DetailsHTML);
  29. //sb.AppendLine("DESCRIPTION:" + res.Details);
  30. sb.AppendLine("LAST-MODIFIED:" + now);
  31. sb.AppendLine("LOCATION:" + res.Location);
  32. sb.AppendLine("SEQUENCE:0");
  33. sb.AppendLine("STATUS:CONFIRMED");
  34. sb.AppendLine("SUMMARY:" + res.Summary);
  35. sb.AppendLine("TRANSP:OPAQUE");
  36. sb.AppendLine("END:VEVENT");
  37. }
  39. sb.AppendLine("END:VCALENDAR");
  41. var calendarBytes = Encoding.UTF8.GetBytes(sb.ToString());
  42. MemoryStream ms = new MemoryStream(calendarBytes);
  43. System.Net.Mail.Attachment attachment = new System.Net.Mail.Attachment(ms, "event.ics", "text/calendar");
  45. message.Attachments.Add(attachment);
  46. ...

Bonus

If you are planning to create calendars from multiple classses, it would be beneficial to create a class or method to help you with this. Below is the current approach that I am taking.
One thing to note is that here, unlike in my above examples, I am using METHOD:REQUEST and creating multiple calendars invites for multiple events so that when the end user opens the calendar invite it will get added to their main Exchange calendar, also creating an alarm for each invite.
Create an iCalendar class that will hold the calendar properties.
iCalendar.cs
  1. namespace Program
  2. {
  3. public class iCalendar
  4. {
  5. public DateTime EventStartDateTime { get; set; }
  6. public DateTime EventEndDateTime { get; set; }
  7. public DateTime EventTimeStamp { get; set; }
  8. public DateTime EventCreatedDateTime { get; set; }
  9. public DateTime EventLastModifiedTimeStamp { get; set; }
  10. public string UID { get; set; }
  11. public string EventDescription { get; set; }
  12. public string EventLocation { get; set; }
  13. public string EventSummary { get; set; }
  14. public string AlarmTrigger { get; set; }
  15. public string AlarmRepeat { get; set; }
  16. public string AlarmDuration { get; set; }
  17. public string AlarmDescription { get; set; }
  19. public iCalendar() {
  20. EventTimeStamp = DateTime.Now;
  21. EventCreatedDateTime = EventTimeStamp;
  22. EventLastModifiedTimeStamp = EventTimeStamp;
  23. }
  24. }
  25. }
Create a method or class
This class or method will give you a list of strings containing the calendar invites.
In my case I chose to create a public method in a separate class that holds “common tasks” shared accross my application, this method will receive a list of calendar objects (remember the iCalendarclass I created above??) and return a list calendar strings.
  1. public static List<string> iCals(List<iCalendar> iCals) {
  2. List<string> calendars = new List<string>();
  4. foreach(iCalendar iCal in iCals) {
  5. StringBuilder sb = new StringBuilder();
  7. //Calendar
  8. sb.AppendLine("BEGIN:VCALENDAR");
  9. sb.AppendLine("PRODID:-//Compnay Inc//Product Application//EN");
  10. sb.AppendLine("VERSION:2.0");
  11. sb.AppendLine("METHOD:REQUEST");
  13. //Event
  14. sb.AppendLine("BEGIN:VEVENT");
  15. sb.AppendLine("DTSTART:" + toUniversalTime(iCal.EventStartDateTime));
  16. sb.AppendLine("DTEND:" + toUniversalTime(iCal.EventEndDateTime));
  17. sb.AppendLine("DTSTAMP:" + toUniversalTime(iCal.EventTimeStamp));
  18. sb.AppendLine("ORGANIZER;CN=John Doe:mailto:johndoe@company.com");
  19. sb.AppendLine("UID:" + iCal.UID);
  20. //sb.AppendLine("ATTENDEE;CUTYPE=INDIVIDUAL;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;RSVP=TRUE;CN=marydoe@company.com;X-NUM-GUESTS=0:mailto:marydoe@company.com");
  21. sb.AppendLine("CREATED:" + toUniversalTime(iCal.EventCreatedDateTime));
  22. sb.AppendLine("X-ALT-DESC;FMTTYPE=text/html:" + iCal.EventDescription);
  23. sb.AppendLine("LAST-MODIFIED:" + toUniversalTime(iCal.EventLastModifiedTimeStamp));
  24. sb.AppendLine("LOCATION:" + iCal.EventLocation);
  25. sb.AppendLine("SEQUENCE:0");
  26. sb.AppendLine("STATUS:CONFIRMED");
  27. sb.AppendLine("SUMMARY:" + iCal.EventSummary);
  28. sb.AppendLine("TRANSP:OPAQUE");
  30. //Alarm
  31. sb.AppendLine("BEGIN:VALARM");
  32. sb.AppendLine("TRIGGER:" + String.Format("-PT{0}M", iCal.AlarmTrigger));
  33. sb.AppendLine("REPEAT:" + iCal.AlarmRepeat);
  34. sb.AppendLine("DURATION:" + String.Format("PT{0}M", iCal.AlarmDuration));
  35. sb.AppendLine("ACTION:DISPLAY");
  36. sb.AppendLine("DESCRIPTION:" + iCal.AlarmDescription);
  37. sb.AppendLine("END:VALARM");
  39. sb.AppendLine("END:VEVENT");
  40. sb.AppendLine("END:VCALENDAR");
  42. calendars.Add(sb.ToString());
  43. }
  45. return calendars;
  46. }
  48. public static string toUniversalTime(DateTime dt) {
  49. string DateFormat = "yyyyMMddTHHmmssZ";
  51. return dt.ToUniversalTime().ToString(DateFormat);
  52. }
Finally call everything and create the calendars
Loop thru the list of events creating a separate calendar invite and attaching them to the email message.
  1. ...
  2. MailMessage message = new MailMessage();
  3. message.To.Add("johndoe@user.com");
  4. message.From = new MailAddress("info@company.com", "Company, Inc");
  5. message.Subject = "subject";
  6. message.Body = "emailbody";
  7. message.IsBodyHtml = true;
  8. ...
  9. List<iCalendar> iCals = new List<iCalendar>();
  11. foreach (var res in reg.Reservations) {
  12. iCals.Add(new iCalendar {
  13. EventStartDateTime = Convert.ToDateTime(res.BeginDate),
  14. EventEndDateTime = Convert.ToDateTime(res.EndDate),
  15. UID = Guid.NewGuid().ToString(),
  16. EventDescription = res.DetailsHTML,
  17. EventLocation = res.Location,
  18. EventSummary = res.Summary,
  19. AlarmTrigger = "30",
  20. AlarmRepeat = "2",
  21. AlarmDuration = "15",
  22. AlarmDescription = res.Details
  23. });
  24. }
  26. List<string> calendars = Common.iCals(iCals);
  28. int i = 1;
  29. foreach (string iCal in calendars) {
  30. var calendarBytes = Encoding.UTF8.GetBytes(iCal);
  31. MemoryStream ms = new MemoryStream(calendarBytes);
  33. System.Net.Mail.Attachment attachment = new System.Net.Mail.Attachment(ms, String.Format("invite{0}.ics", i), "text/calendar");
  34. message.Attachments.Add(attachment);
  36. i++;
  37. }
  38. ...

Downloading the iCal

If you are not attaching the iCal to an email, instead you are making it available as a download, below is the partial code
  1. public ActionResult DownloadiCal(...)
  2. {
  3. //Create the calendar
  4. ...
  6. byte[] calendarBytes = System.Text.Encoding.UTF8.GetBytes(iCal); //iCal is the calendar string
  8. return File(calendarBytes, "text/calendar", "event.ics");
  9. }
Share if you liked this little tutorial!
https://www.kanzaki.com/docs/ical/

0 comments:

Post a Comment

Note: only a member of this blog may post a comment.