如何让iCalendar事件显示在Outlook邮件正文并修复附件兼容问题

我尝试通过邮件发送iCalendar事件，希望它能显示在Outlook的邮件正文中。使用PHP、Postmark和Spatie iCalendar generator实现，当前代码如下：

public function testCreateIcsFile()
{
    $eventName = 'Testing Create Event';
    $organizerName = 'John Smith';
    $organizerEmail = 'johnsmith@email.net';
    $address = '123 Main St, Springfield, IL 62701';
    $addressName = 'My House';
    $uniqueIdentifier = 'test-1234';
    $description = 'This is a test event description';
    $createdAt = new \DateTime('2024-07-08 14:30:00', new \DateTimeZone('America/New_York'));
    $startsAt = new \DateTime('2024-07-08 15:00:00', new \DateTimeZone('America/New_York'));
    $endsAt = new \DateTime('2024-07-08 17:00:00', new \DateTimeZone('America/New_York'));
    $attendeeEmail = 'jblow@email.net';
    $attendeeName = 'Joe Blow';
    $participationStatus = ParticipationStatus::needs_action();
    $requiresResponse = true;
    $timezone = Timezone::create('America/New_York');
    
    $event = Event::create()
        ->name($eventName)
        ->organizer($organizerEmail, $organizerName)
        ->address($address)
        ->addressName($addressName)
        ->uniqueIdentifier($uniqueIdentifier)
        ->description($description)
        ->createdAt($createdAt)
        ->startsAt($startsAt)
        ->endsAt($endsAt)
        ->attendee($attendeeEmail, $attendeeName, $participationStatus, $requiresResponse);

    $cal = Calendar::create('Testing Calendar Library')
        ->timezone($timezone)
        ->event($event);

    $ics = $cal->get();
    $ec = new Email();
    $html = $ec->generateEmailHtml([
        'template' => 'calendar_invite',
        'recipientName' => $attendeeName,
        'eventName' => $eventName,
        'organizerName' => $organizerName,
        'organizerEmail' => $organizerEmail,
        'address' => $address,
        'addressName' => $addressName,
        'description' => $description,
        'startsAt' => $startsAt->format('Y-m-d H:i:s'),
        'endsAt' => $endsAt->format('Y-m-d H:i:s'),
        'requiresResponse' => $requiresResponse,
    ]);

    $res = $ec->sendEmail([
        'from' => '234@email.net',
        'to' => '123@email.net',
        'subject' => 'Another ICS test',
        'html' => $html,
        'attachments' => [
            [
                'filename' => 'test.ics',
                'name' => 'test.ics',
                'content' => $ics,
                'contenttype' => 'text/calendar; charset=utf-8; method=REQUEST',
                'mimetype' => 'text/calendar; charset=utf-8; method=REQUEST',
                'Disposition' => 'inline',
                'content-disposition' => 'attachment; filename="invite.ics"',
                'content-transfer-encoding' => 'base64'
            ]
        ]
    ]);

    print_r($res);
}

当前遇到的问题：

• 邮件仅显示模板生成的正文文本，日历事件未内嵌在Outlook正文中
• 附件提示“not supported calendar message”

1. 解决附件“not supported calendar message”错误 #

问题根源在于附件参数配置冲突、编码错误：

• 冗余参数（同时设置Disposition和content-disposition）导致解析混乱
• content-transfer-encoding设为base64但未对ICS内容编码
• MIME类型参数键名不统一（Postmark使用content_type而非contenttype）

修改后的附件配置：

'attachments' => [
    [
        'name' => 'invite.ics',
        'content' => base64_encode($ics), // 必须对ICS内容做base64编码
        'content_type' => 'text/calendar; charset=utf-8; method=REQUEST',
        'content_disposition' => 'attachment' // 统一使用attachment，配合method=REQUEST让Outlook识别为会议邀请
    ]
]

2. 让日历事件内嵌显示在Outlook正文 #

推荐使用Postmark内置的CalendarEvent参数，这是兼容性最好的方式，Postmark会自动生成正确的内嵌会议卡片：

$res = $ec->sendEmail([
    'from' => '234@email.net',
    'to' => '123@email.net',
    'subject' => 'Another ICS test',
    'html' => $html,
    'CalendarEvent' => [
        'EventID' => $uniqueIdentifier,
        'EventType' => 'Request',
        'Title' => $eventName,
        'StartDateTime' => $startsAt->format('c'), // 使用ISO 8601格式时间
        'EndDateTime' => $endsAt->format('c'),
        'Location' => "{$addressName} ({$address})",
        'Description' => $description,
        'Organizer' => [
            'Name' => $organizerName,
            'Email' => $organizerEmail
        ],
        'Attendees' => [
            [
                'Name' => $attendeeName,
                'Email' => $attendeeEmail,
                'Status' => 'NeedsAction',
                'Required' => $requiresResponse
            ]
        ],
        'TimeZone' => 'America/New_York'
    ]
]);

使用该方式后，Outlook会直接在邮件正文顶部显示会议卡片，包含接受/拒绝/暂定按钮，同时自动添加ICS附件。

如果必须手动内嵌，可在HTML模板中添加隐藏的data URI对象（兼容性稍差）：

<!-- 在calendar_invite模板中添加 -->
<object 
    data="data:text/calendar;charset=utf-8;method=REQUEST,<?php echo urlencode($ics); ?>" 
    type="text/calendar" 
    style="display:none;"
></object>

3. 额外注意事项 #

• uniqueIdentifier需全局唯一，建议使用UUID避免重复事件
• 所有DateTime对象保持时区一致，避免时间显示错误
• 确保发送邮箱配置了正确的SPF/DKIM记录，防止邮件被标记为垃圾邮件，导致日历功能失效

内容的提问来源于stack exchange，提问作者PortyR