Invoke-MgForwardUserMessage
Forward a message using either JSON or MIME format. When using JSON format, you can:- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.- 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. When using MIME format:- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to forward a message, and send it later.
Note
To view the beta release of this cmdlet, view Invoke-MgBetaForwardUserMessage
Syntax
Invoke-MgForwardUserMessage
-MessageId <String>
-UserId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Comment <String>]
[-Message <IMicrosoftGraphMessage>]
[-ToRecipients <IMicrosoftGraphRecipient[]>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-MgForwardUserMessage
-MessageId <String>
-UserId <String>
-BodyParameter <IPaths3Ta6EnUsersUserIdMessagesMessageIdMicrosoftGraphForwardPostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-MgForwardUserMessage
-InputObject <IUsersActionsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Comment <String>]
[-Message <IMicrosoftGraphMessage>]
[-ToRecipients <IMicrosoftGraphRecipient[]>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-MgForwardUserMessage
-InputObject <IUsersActionsIdentity>
-BodyParameter <IPaths3Ta6EnUsersUserIdMessagesMessageIdMicrosoftGraphForwardPostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Forward a message using either JSON or MIME format. When using JSON format, you can:- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.- 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. When using MIME format:- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to forward a message, and send it later.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Mail.Send | Not available. |
| Delegated (personal Microsoft account) | Mail.Send | Not available. |
| Application | Mail.Send | Not available. |
Examples
Example 1: Code snippet
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 $paramsThis example shows how to use the Invoke-MgForwardUserMessage Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IPaths3Ta6EnUsersUserIdMessagesMessageIdMicrosoftGraphForwardPostRequestbodyContentApplicationJsonSchema |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Comment
.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IUsersActionsIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Message
message To construct, see NOTES section for MESSAGE properties and create a hash table.
| Type: | IMicrosoftGraphMessage |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MessageId
The unique identifier of message
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Returns true when the command succeeds
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ToRecipients
. To construct, see NOTES section for TORECIPIENTS properties and create a hash table.
| Type: | IMicrosoftGraphRecipient[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserId
The unique identifier of user
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IPaths3Ta6EnUsersUserIdMessagesMessageIdMicrosoftGraphForwardPostRequestbodyContentApplicationJsonSchema
Microsoft.Graph.PowerShell.Models.IUsersActionsIdentity
System.Collections.IDictionary
Outputs
System.Boolean
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
BODYPARAMETER <IPaths3Ta6EnUsersUserIdMessagesMessageIdMicrosoftGraphForwardPostRequestbodyContentApplicationJsonSchema>: .
[(Any) <Object>]: This indicates any property can be added to this object.[Comment <String>]:[Message <IMicrosoftGraphMessage>]: message[(Any) <Object>]: This indicates any property can be added to this object.[Categories <String-[]>]: The categories associated with the item[ChangeKey <String>]: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[LastModifiedDateTime <DateTime?>]: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Id <String>]: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphAttachment-[]>]: The fileAttachment and itemAttachment attachments for the message.[Id <String>]: The unique identifier for an entity. Read-only.[ContentType <String>]: The MIME type.[IsInline <Boolean?>]: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Name <String>]: The attachment's file name.[Size <Int32?>]: The length of the attachment in bytes.
[BccRecipients <IMicrosoftGraphRecipient-[]>]: The Bcc: recipients for the message.[EmailAddress <IMicrosoftGraphEmailAddress>]: emailAddress[(Any) <Object>]: This indicates any property can be added to this object.[Address <String>]: The email address of the person or entity.[Name <String>]: The display name of the person or entity.
[Body <IMicrosoftGraphItemBody>]: itemBody[(Any) <Object>]: This indicates any property can be added to this object.[Content <String>]: The content of the item.[ContentType <String>]: bodyType
[BodyPreview <String>]: The first 255 characters of the message body. It is in text format.[CcRecipients <IMicrosoftGraphRecipient-[]>]: The Cc: recipients for the message.[ConversationId <String>]: The ID of the conversation the email belongs to.[ConversationIndex <Byte-[]>]: Indicates the position of the message within the conversation.[Extensions <IMicrosoftGraphExtension-[]>]: The collection of open extensions defined for the message. Nullable.[Id <String>]: The unique identifier for an entity. Read-only.
[Flag <IMicrosoftGraphFollowupFlag>]: followupFlag[(Any) <Object>]: This indicates any property can be added to this object.[CompletedDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[(Any) <Object>]: This indicates any property can be added to this object.[DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).[TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
[DueDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[FlagStatus <String>]: followupFlagStatus[StartDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
[From <IMicrosoftGraphRecipient>]: recipient[HasAttachments <Boolean?>]: Indicates whether the message has attachments. This property doesn't include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as
.[Importance <String>]: importance[InferenceClassification <String>]: inferenceClassificationType[InternetMessageHeaders <IMicrosoftGraphInternetMessageHeader-[]>]: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.[Name <String>]: Represents the key in a key-value pair.[Value <String>]: The value in a key-value pair.
[InternetMessageId <String>]: The message ID in the format specified by RFC2822.[IsDeliveryReceiptRequested <Boolean?>]: Indicates whether a read receipt is requested for the message.[IsDraft <Boolean?>]: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.[IsRead <Boolean?>]: Indicates whether the message has been read.[IsReadReceiptRequested <Boolean?>]: Indicates whether a read receipt is requested for the message.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-[]>]: The collection of multi-value extended properties defined for the message. Nullable.[Id <String>]: The unique identifier for an entity. Read-only.[Value <String-[]>]: A collection of property values.
[ParentFolderId <String>]: The unique identifier for the message's parent mailFolder.[ReceivedDateTime <DateTime?>]: The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[ReplyTo <IMicrosoftGraphRecipient-[]>]: The email addresses to use when replying.[Sender <IMicrosoftGraphRecipient>]: recipient[SentDateTime <DateTime?>]: The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-[]>]: The collection of single-value extended properties defined for the message. Nullable.[Id <String>]: The unique identifier for an entity. Read-only.[Value <String>]: A property value.
[Subject <String>]: The subject of the message.[ToRecipients <IMicrosoftGraphRecipient-[]>]: The To: recipients for the message.[UniqueBody <IMicrosoftGraphItemBody>]: itemBody[WebLink <String>]: The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.
[ToRecipients <IMicrosoftGraphRecipient-[]>]:
INPUTOBJECT <IUsersActionsIdentity>: Identity Parameter
[AuthenticationMethodId <String>]: The unique identifier of authenticationMethod[CalendarId <String>]: The unique identifier of calendar[ChatId <String>]: The unique identifier of chat[ChatMessageId <String>]: The unique identifier of chatMessage[ChatMessageId1 <String>]: The unique identifier of chatMessage[ContentTypeId <String>]: The unique identifier of contentType[DeviceLogCollectionResponseId <String>]: The unique identifier of deviceLogCollectionResponse[DocumentSetVersionId <String>]: The unique identifier of documentSetVersion[DriveId <String>]: The unique identifier of drive[DriveItemId <String>]: The unique identifier of driveItem[DriveItemVersionId <String>]: The unique identifier of driveItemVersion[EventId <String>]: The unique identifier of event[EventId1 <String>]: The unique identifier of event[ListItemId <String>]: The unique identifier of listItem[ListItemVersionId <String>]: The unique identifier of listItemVersion[MailFolderId <String>]: The unique identifier of mailFolder[MailFolderId1 <String>]: The unique identifier of mailFolder[ManagedDeviceId <String>]: The unique identifier of managedDevice[MessageId <String>]: The unique identifier of message[NotebookId <String>]: The unique identifier of notebook[OnenotePageId <String>]: The unique identifier of onenotePage[OnenoteSectionId <String>]: The unique identifier of onenoteSection[OnlineMeetingId <String>]: The unique identifier of onlineMeeting[PermissionId <String>]: The unique identifier of permission[PhoneAuthenticationMethodId <String>]: The unique identifier of phoneAuthenticationMethod[SubscriptionId <String>]: The unique identifier of subscription[TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation[TodoTaskId <String>]: The unique identifier of todoTask[TodoTaskListId <String>]: The unique identifier of todoTaskList[UserId <String>]: The unique identifier of user
MESSAGE <IMicrosoftGraphMessage>: message
[(Any) <Object>]: This indicates any property can be added to this object.[Categories <String-[]>]: The categories associated with the item[ChangeKey <String>]: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[LastModifiedDateTime <DateTime?>]: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Id <String>]: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphAttachment-[]>]: The fileAttachment and itemAttachment attachments for the message.[Id <String>]: The unique identifier for an entity. Read-only.[ContentType <String>]: The MIME type.[IsInline <Boolean?>]: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Name <String>]: The attachment's file name.[Size <Int32?>]: The length of the attachment in bytes.
[BccRecipients <IMicrosoftGraphRecipient-[]>]: The Bcc: recipients for the message.[EmailAddress <IMicrosoftGraphEmailAddress>]: emailAddress[(Any) <Object>]: This indicates any property can be added to this object.[Address <String>]: The email address of the person or entity.[Name <String>]: The display name of the person or entity.
[Body <IMicrosoftGraphItemBody>]: itemBody[(Any) <Object>]: This indicates any property can be added to this object.[Content <String>]: The content of the item.[ContentType <String>]: bodyType
[BodyPreview <String>]: The first 255 characters of the message body. It is in text format.[CcRecipients <IMicrosoftGraphRecipient-[]>]: The Cc: recipients for the message.[ConversationId <String>]: The ID of the conversation the email belongs to.[ConversationIndex <Byte-[]>]: Indicates the position of the message within the conversation.[Extensions <IMicrosoftGraphExtension-[]>]: The collection of open extensions defined for the message. Nullable.[Id <String>]: The unique identifier for an entity. Read-only.
[Flag <IMicrosoftGraphFollowupFlag>]: followupFlag[(Any) <Object>]: This indicates any property can be added to this object.[CompletedDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[(Any) <Object>]: This indicates any property can be added to this object.[DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).[TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
[DueDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[FlagStatus <String>]: followupFlagStatus[StartDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone
[From <IMicrosoftGraphRecipient>]: recipient[HasAttachments <Boolean?>]: Indicates whether the message has attachments. This property doesn't include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as.[Importance <String>]: importance[InferenceClassification <String>]: inferenceClassificationType[InternetMessageHeaders <IMicrosoftGraphInternetMessageHeader-[]>]: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.[Name <String>]: Represents the key in a key-value pair.[Value <String>]: The value in a key-value pair.
[InternetMessageId <String>]: The message ID in the format specified by RFC2822.[IsDeliveryReceiptRequested <Boolean?>]: Indicates whether a read receipt is requested for the message.[IsDraft <Boolean?>]: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.[IsRead <Boolean?>]: Indicates whether the message has been read.[IsReadReceiptRequested <Boolean?>]: Indicates whether a read receipt is requested for the message.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-[]>]: The collection of multi-value extended properties defined for the message. Nullable.[Id <String>]: The unique identifier for an entity. Read-only.[Value <String-[]>]: A collection of property values.
[ParentFolderId <String>]: The unique identifier for the message's parent mailFolder.[ReceivedDateTime <DateTime?>]: The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[ReplyTo <IMicrosoftGraphRecipient-[]>]: The email addresses to use when replying.[Sender <IMicrosoftGraphRecipient>]: recipient[SentDateTime <DateTime?>]: The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-[]>]: The collection of single-value extended properties defined for the message. Nullable.[Id <String>]: The unique identifier for an entity. Read-only.[Value <String>]: A property value.
[Subject <String>]: The subject of the message.[ToRecipients <IMicrosoftGraphRecipient-[]>]: The To: recipients for the message.[UniqueBody <IMicrosoftGraphItemBody>]: itemBody[WebLink <String>]: The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.
TORECIPIENTS <IMicrosoftGraphRecipient- []>: .
[EmailAddress <IMicrosoftGraphEmailAddress>]: emailAddress[(Any) <Object>]: This indicates any property can be added to this object.[Address <String>]: The email address of the person or entity.[Name <String>]: The display name of the person or entity.
RELATED LINKS
https://learn.microsoft.com/graph/api/message-forward?view=graph-rest-1.0