邮件:转发

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

使用 JSON 或 MIME 格式转发消息。

使用 JSON 格式时,可以:

  • 指定参数的注释或 正文 属性 message 。 指定这两者将返回 HTTP 400 错误请求错误。
  • 指定 参数或 toRecipients 参数的 messagetoRecipients 属性。 同时指定或指定两者均不指定将返回 HTTP 400 错误请求错误。

使用 MIME 格式时:

  • 提供适用的 Internet 邮件头MIME 内容,所有内容在请求正文中都通过 base64 格式进行编码。
  • 向 MIME 内容添加任何附件和 S/MIME 属性。

此方法将邮件保存在“已发送邮件”文件夹中。

或者, 创建草稿以转发邮件,并在以后 发送

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Mail.Send 不可用。
委派(个人 Microsoft 帐户) Mail.Send 不可用。
应用程序 Mail.Send 不可用。

HTTP 请求

POST /me/messages/{id}/forward
POST /users/{id | userPrincipalName}/messages/{id}/forward
POST /me/mailFolders/{id}/messages/{id}/forward
POST /users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/forward

请求标头

名称 类型 说明
Authorization string 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type string 实体正文中的数据性质。 必填。
对 JSON 对象使用 application/json,对 MIME 内容使用 text/plain

请求正文

使用 JSON 格式时,提供具有以下参数的 JSON 对象。

参数 类型 说明
注释 String 要包含的注释。 可以为空字符串。
toRecipients recipient collection 收件人列表
消息 邮件 在答复消息中更新的任何可写属性。

当指定 MIME 格式的正文时,请提供 MIME 内容与适用的 Internet 邮件头(“收件人”、“抄送”、“密件抄送”、“主题”)所有内容在请求正文中编码为 base64 格式。

响应

如果成功,此方法返回 202 Accepted 响应代码。 它不会在响应正文中返回任何内容。

如果请求正文包含错误的 MIME 内容,此方法将返回 400 Bad request 和以下错误消息:“无效的 base64 字符串 MIME 内容”。

示例

示例 1:使用 JSON 格式转发消息

以下示例将 isDeliveryReceiptRequested 属性设置为 true,添加注释并转发消息。

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/me/messages/AAMkADA1MTAAAH5JaLAAA=/forward
Content-Type: application/json

{
  "message":{
    "isDeliveryReceiptRequested": true,
    "toRecipients":[
      {
        "emailAddress": {
          "address":"danas@contoso.com",
          "name":"Dana Swope"
        }
      }
     ]
  },
  "comment": "Dana, just want to make sure you get this."
}
响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted

示例 2:使用 MIME 格式转发邮件

POST https://graph.microsoft.com/beta/me/messages/AAMkADA1MTAAAH5JaLAAA=/forward
Content-Type: text/plain

Q29udGVudC1UeXBlOiBhcHBsaWNhdGlvbi9wa2NzNy1taW1lOw0KCW5hbWU9c21pbWUucDdtOw0KCXNtaW1lLXR5cGU9ZW52ZWxvcGVkLWRhdGENCk1pbWUtVmVyc2lvbjogMS4wIChNYWMgT1MgWCBNYWlsIDEzLjAgXCgzNjAxLjAuMTBcKSkNClN1YmplY3Q6IFJlOiBUZXN0aW5nIFMvTUlNRQ0KQ29udGVudC1EaXNwb3Np...

响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted

如果请求正文包含错误的 MIME 内容,此方法返回以下错误消息。

HTTP/1.1 400 Bad Request
Content-type: application/json

{
    "error": {
        "code": "ErrorMimeContentInvalidBase64String",
        "message": "Invalid base64 string for MIME content."
    }
}