Share via


CalendarSharing.ForwardAsICal Method

Outlook Developer Reference

Forwards calendar information from the parent Folder of the CalendarSharing object as the payload of a MailItem.

Version Information
 Version Added:  Outlook 2007

Syntax

expression.ForwardAsICal(MailFormat)

expression   An expression that returns a CalendarSharing object.

Parameters

Name Required/Optional Data Type Description
MailFormat Required OlCalendarMailFormat Determines the format of the calendar information in the body of the MailItem created by this method.

Return Value
A MailItem object that represents the new mail item to which the calendar information is attached.

Remarks

The ForwardAsICal method provides a single method by which you can use payload sharing to share a calendar with other users. The method:

  • Creates a MailItem object and provides a presentation of calendar information in the body of the mail item.
  • Creates an iCalendar (.ics) file containing the calendar information and attaches the file to the MailItem.

See Also