GetReminders 操作

项目
03/29/2023

查找有关 GetReminders EWS 操作的信息。

GetReminders Exchange Web Services (EWS) 操作检索日历和任务项的提醒。

Exchange Server 2013 中引入了此操作。

使用 GetReminders 操作

GetReminders 操作获取用户邮箱中当前和未来日历和任务项的提醒，具体取决于请求中传递的元素值。该操作可以检索所有当前和将来的日历项目以及具有提醒集的任务。专用日历项包含在响应中。没有提醒的任务不包括在答复中，也不包括带有提醒或跟进标志的电子邮件。

若要检索所有当前提醒，建议将 ReminderType 设置为 All ，并将 EndTime 设置为当前时间。

如果请求中包含 BeginTime 和 EndTime 元素，则响应包括针对在 BeginTime 和 EndTime 之间发生的任何日历和任务项的提醒。

下表描述了包括 BeginTime 和 EndTime 元素时 ReminderType 元素的行为。

ReminderType 元素值	说明
全部	在 BeginTime 和 EndTime 之间发生的提醒。
Current	所有返回的提醒，以及早于请求的时间窗口（如果事件仍在进行）的提醒，以及所有约会，不考虑年龄。
老	全部返回的提醒数减去尚未完成的事件数，减去所有约会。 BeginTime 和 EndTime 元素必须设置为使用 Old 值。

GetReminders 操作 SOAP 标头

GetReminders 操作可以使用下表中列出的 SOAP 标头。

标头名称	元素	说明
模拟	ExchangeImpersonation	标识客户端应用程序正在模拟的用户。此标头适用于请求。
MailboxCulture	MailboxCulture	标识要用于访问邮箱的区域性，如 RFC 3066“标识语言标记”中所述。此标头适用于请求。
RequestVersion	RequestServerVersion	标识操作请求的架构版本。此标头适用于请求。
ServerVersion	ServerVersionInfo	标识响应请求的服务器版本。此标头适用于响应。

GetReminders 操作请求示例

下面的 GetReminders 操作请求示例演示如何检索 BeginTime 和 EndTime 之间发生的前五个日历项。

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages" 
               xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" 
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <t:RequestServerVersion Version="Exchange2013" />
  </soap:Header>
  <soap:Body>
    <m:GetReminders>
      <m:EndTime>2014-04-16T21:00:00Z</m:EndTime>
      <m:ReminderType>All</m:ReminderType>
    </m:GetReminders>
  </soap:Body>
</soap:Envelope>

示例请求 SOAP 正文包含以下元素：

SOAP 正文还可以包含以下元素：

成功的 GetReminders 操作响应

以下示例显示了 对 GetReminders 操作请求的成功响应。响应包含“团队会议”日历项提醒和“发送会议笔记任务”任务的提醒。

注意

标识符已缩短，以保持可读性。

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <ServerVersionInfo MajorVersion="15"
                       MinorVersion="0"
                       MajorBuildNumber="918"
                       MinorBuildNumber="7"
                       Version="V2_10"
                       xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
                       xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
                       xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
  </s:Header>
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <GetRemindersResponse ResponseClass="Success"
                          xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
      <ResponseCode>NoError</ResponseCode>
      <Reminders>
        <Reminder xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
          <Subject>Team meeting</Subject>
          <Location />
          <ReminderTime>2014-04-15T21:00:00Z</ReminderTime>
          <StartDate>2014-04-15T21:00:00Z</StartDate>
          <EndDate>2014-04-15T21:30:00Z</EndDate>
          <ItemId Id="vQAAAA=="
                  ChangeKey="DwAAABYAAAB4to43JyybTYwHLBM1k8MxAAACRoV4" />
          <RecurringMasterItemId Id="K7u5AAA=" ChangeKey="DwAAABYAAAB4to43JyybTYwHLBM1k8MxAAACRoV0" />
          <ReminderGroup>Calendar</ReminderGroup>
          <UID>6CF2FA62</UID>
        </Reminder>
        <Reminder xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
          <Subject>Task to send meeting notes</Subject>
          <Location />
          <ReminderTime>2014-04-16T14:00:00Z</ReminderTime>
          <StartDate>0001-01-02T00:00:00Z</StartDate>
          <EndDate>0001-01-02T00:00:00Z</EndDate>
          <ItemId Id="vAAAAA=="
                  ChangeKey="EwAAABQAAACOs0HEMq1WTKpI7sNu5qXNAAAIDg==" />
          <ReminderGroup>Task</ReminderGroup>
          <UID>vAAAAA==</UID>
        </Reminder>
      </Reminders>
    </GetRemindersResponse>
  </s:Body>
</s:Envelope>

响应 SOAP 正文包含以下元素：

GetReminders 操作错误响应示例

以下示例显示了 对 GetReminders 操作请求的错误响应。这是对请求的响应，其中结束日期早于开始日期。

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <ServerVersionInfo MajorVersion="15"
                       MinorVersion="0"
                       MajorBuildNumber="918"
                       MinorBuildNumber="7"
                       Version="V2_10"
                       xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
                       xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
                       xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
  </s:Header>
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <GetRemindersResponse ResponseClass="Error"
                          xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
      <MessageText>EndDate is earlier than StartDate</MessageText>
      <ResponseCode>ErrorInvalidOperation</ResponseCode>
      <DescriptiveLinkKey>0</DescriptiveLinkKey>
    </GetRemindersResponse>
  </s:Body>
</s:Envelope>

错误响应 SOAP 正文包含以下元素：

有关 EWS 通用且特定于此操作的其他错误代码，请参阅 ResponseCode。

另请参阅

PerformReminderAction

通过