message: forward

• 5/4/2019
• 2 minutes to read
• Contributors
  • 
  • 
  • 
  • 
  • 
  • all

Forward a message, add a comment or modify any updateable properties
all in one forward call. The message is saved in the Sent Items folder.

Alternatively, you can first create a draft forward message to include a comment or update any message properties, and then send the draft message.

Note

• You can specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.
• You must specify either the toRecipients parameter or the toRecipients property of the message parameter. Specifying both or specifying neither will return an HTTP 400 Bad Request error.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

HTTP request

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

Request headers

Request body

In the request body, provide a JSON object with the following parameters.

Response

If successful, this method returns 202 Accepted response code. It does not return anything in the response body.

Example

The following example sets the isDeliveryReceiptRequested property to true, adds a comment and forwards the message.

Request

Here is an example of the request.

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

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

Response

Here is an example of the response.

HTTP/1.1 202 Accepted

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var message = new Message
{
	IsDeliveryReceiptRequested = true,
	ToRecipients = new List<Recipient>()
	{
		new Recipient
		{
			EmailAddress = new EmailAddress
			{
				Address = "danas@contoso.onmicrosoft.com",
				Name = "Dana Swope"
			}
		}
	}
};

var comment = "Dana, just want to make sure you get this.";

await graphClient.Me.Messages["AAMkADA1MTAAAH5JaLAAA="]
	.Forward(message,comment,toRecipients)
	.Request()
	.PostAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

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

let res = await client.api('/me/messages/AAMkADA1MTAAAH5JaLAAA=/forward')
	.version('beta')
	.post(forward);

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.