邮件：转发

命名空间：microsoft.graph

使用 JSON 或 MIME 格式转发邮件。

使用 JSON 格式时，可以：

• 指定参数的 comment 或 message body 属性。 指定这两者将返回 HTTP 400 错误请求错误。
• 指定参数 toRecipients 的参数或 toRecipients message 属性。 指定两者或同时指定两者都将返回 HTTP 400 错误请求错误。

使用 MIME 格式时：

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

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

或者， 创建转发邮件的草稿， 稍后 发送。

权限

要调用此 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	Bearer {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 格式转发邮件

下面是一个如何调用此 API 的示例。

请求

下面是一个请求示例。

HTTP

POST https://graph.microsoft.com/v1.0/me/messages/{id}/forward
Content-type: application/json

{
  "comment": "comment-value",
  "toRecipients": [
    {
      "emailAddress": {
        "name": "name-value",
        "address": "address-value"
      }
    }
  ]
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var comment = "comment-value";

var toRecipients = new List<Recipient>()
{
    new Recipient
    {
        EmailAddress = new EmailAddress
        {
            Name = "name-value",
            Address = "address-value"
        }
    }
};

await graphClient.Me.Messages["{message-id}"]
    .Forward(toRecipients,null,comment)
    .Request()
    .PostAsync();

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 SDK 文档。

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const forward = {
  comment: 'comment-value',
  toRecipients: [
    {
      emailAddress: {
        name: 'name-value',
        address: 'address-value'
      }
    }
  ]
};

await client.api('/me/messages/{id}/forward')
    .post(forward);

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 SDK 文档。

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me/messages/{id}/forward"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

NSMutableDictionary *payloadDictionary = [[NSMutableDictionary alloc] init];

NSString *comment = @"comment-value";
payloadDictionary[@"comment"] = comment;

NSMutableArray *toRecipientsList = [[NSMutableArray alloc] init];
MSGraphRecipient *toRecipients = [[MSGraphRecipient alloc] init];
MSGraphEmailAddress *emailAddress = [[MSGraphEmailAddress alloc] init];
[emailAddress setName:@"name-value"];
[emailAddress setAddress:@"address-value"];
[toRecipients setEmailAddress:emailAddress];
[toRecipientsList addObject: toRecipients];
payloadDictionary[@"toRecipients"] = toRecipientsList;

NSData *data = [NSJSONSerialization dataWithJSONObject:payloadDictionary options:kNilOptions error:&error];
[urlRequest setHTTPBody:data];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 SDK 文档。

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

String comment = "comment-value";

LinkedList<Recipient> toRecipientsList = new LinkedList<Recipient>();
Recipient toRecipients = new Recipient();
EmailAddress emailAddress = new EmailAddress();
emailAddress.name = "name-value";
emailAddress.address = "address-value";
toRecipients.emailAddress = emailAddress;

toRecipientsList.add(toRecipients);

graphClient.me().messages("{id}")
    .forward(MessageForwardParameterSet
        .newBuilder()
        .withToRecipients(toRecipientsList)
        .withMessage(null)
        .withComment(comment)
        .build())
    .buildRequest()
    .post();

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 SDK 文档。

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.New()
comment := "comment-value"
requestBody.SetComment(&comment)
requestBody.SetToRecipients( []Recipient {
    msgraphsdk.NewRecipient(),
emailAddress := msgraphsdk.NewEmailAddress()
    SetEmailAddress(emailAddress)
name := "name-value"
    emailAddress.SetName(&name)
address := "address-value"
    emailAddress.SetAddress(&address)
}
messageId := "message-id"
graphClient.Me().MessagesById(&messageId).Forward(message-id).Post(requestBody)

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 SDK 文档。

PowerShell

Import-Module Microsoft.Graph.Users.Actions

$params = @{
    Comment = "comment-value"
    ToRecipients = @(
        @{
            EmailAddress = @{
                Name = "name-value"
                Address = "address-value"
            }
        }
    )
}

# A UPN can also be used as -UserId.
Invoke-MgForwardUserMessage -UserId $userId -MessageId $messageId -BodyParameter $params

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 SDK 文档。

响应

下面是一个响应示例。

HTTP/1.1 202 Accepted

示例 2：使用 MIME 内容转发邮件

请求

POST https://graph.microsoft.com/v1.0/me/messages/AAMkADA1MTAAAAqldOAAA=/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."
    }
}