_CalendarSharing.ForwardAsICal Method

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

Namespace:  Microsoft.Office.Interop.Outlook
Assembly:  Microsoft.Office.Interop.Outlook (in Microsoft.Office.Interop.Outlook.dll)

Syntax

'Declaration
<DispIdAttribute()> _
Function ForwardAsICal ( _
    MailFormat As OlCalendarMailFormat _
) As MailItem
'Usage
Dim instance As _CalendarSharing
Dim MailFormat As OlCalendarMailFormat
Dim returnValue As MailItem

returnValue = instance.ForwardAsICal(MailFormat)

[DispIdAttribute()]
MailItem ForwardAsICal(
    OlCalendarMailFormat MailFormat
)

Parameters

• MailFormat
  Type: Microsoft.Office.Interop.Outlook.OlCalendarMailFormat

  Determines the format of the calendar information in the body of the MailItem created by this method.

Return Value

Type: Microsoft.Office.Interop.Outlook.MailItem
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

Reference

_CalendarSharing Interface

_CalendarSharing Members

Microsoft.Office.Interop.Outlook Namespace

Other Resources

How to: Share Free/Busy Schedule Within a Specified Period in a Calendar

How to: Share Calendar Information Through E-Mail