Send-MgUserMail

Invoke action sendMail

Syntax

Send-MgUserMail
    -UserId <String>
    [-AdditionalProperties <Hashtable>]
    [-Message <IMicrosoftGraphMessage>]
    [-SaveToSentItems]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Send-MgUserMail
    -UserId <String>
    -BodyParameter <IPathsFh5OjtUsersUserIdMicrosoftGraphSendmailPostRequestbodyContentApplicationJsonSchema1>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Send-MgUserMail
    -InputObject <IUsersActionsIdentity>
    [-AdditionalProperties <Hashtable>]
    [-Message <IMicrosoftGraphMessage>]
    [-SaveToSentItems]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Send-MgUserMail
    -InputObject <IUsersActionsIdentity>
    -BodyParameter <IPathsFh5OjtUsersUserIdMicrosoftGraphSendmailPostRequestbodyContentApplicationJsonSchema1>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Invoke action sendMail

Parameters

-AdditionalProperties

Additional Parameters

Type:Hashtable
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-BodyParameter

. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:IPathsFh5OjtUsersUserIdMicrosoftGraphSendmailPostRequestbodyContentApplicationJsonSchema1
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
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
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
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SaveToSentItems

.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UserId

key: id of user

Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Graph.PowerShell.Models.IPathsFh5OjtUsersUserIdMicrosoftGraphSendmailPostRequestbodyContentApplicationJsonSchema1

Microsoft.Graph.PowerShell.Models.IUsersActionsIdentity

Outputs

System.Boolean

Notes

ALIASES

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 : .

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [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>]: Read-only.
    • [Attachments <IMicrosoftGraphAttachment[]>]: The fileAttachment and itemAttachment attachments for the message.
      • [Id <String>]: 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 display name of the attachment. This does not need to be the actual 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 an entity instance.
        • [Name <String>]: The display name of an entity instance.
    • [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. If the message contains instances of mention, this property would contain a concatenation of these mentions as well.
    • [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>]: 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, '2019-04-16T09:00:00'.
        • [TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for 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.
    • [Mentions <IMicrosoftGraphMention[]>]: A collection of mentions in the message, ordered by the createdDateTime from the newest to the oldest. By default, a GET /messages does not return this property unless you apply $expand on the property.
      • [Id <String>]: Read-only.
      • [Application <String>]: The name of the application where the mention is created. Optional. Not used and defaulted as null for message.
      • [ClientReference <String>]: A unique identifier that represents a parent of the resource instance. Optional. Not used and defaulted as null for message.
      • [CreatedBy <IMicrosoftGraphEmailAddress>]: emailAddress
      • [CreatedDateTime <DateTime?>]: The date and time that the mention is created on the client.
      • [DeepLink <String>]: A deep web link to the context of the mention in the resource instance. Optional. Not used and defaulted as null for message.
      • [MentionText <String>]: Optional. Not used and defaulted as null for message. To get the mentions in a message, see the bodyPreview property of the message instead.
      • [Mentioned <IMicrosoftGraphEmailAddress>]: emailAddress
      • [ServerCreatedDateTime <DateTime?>]: The date and time that the mention is created on the server. Optional. Not used and defaulted as null for message.
    • [MentionsPreview <IMicrosoftGraphMentionsPreview>]: mentionsPreview
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [IsMentioned <Boolean?>]: True if the signed-in user is mentioned in the parent resource instance. Read-only. Supports filter.
    • [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty[]>]: The collection of multi-value extended properties defined for the message. Nullable.
      • [Id <String>]: 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>]: 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
    • [UnsubscribeData <String[]>]:
    • [UnsubscribeEnabled <Boolean?>]:
    • [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, then the browser will show the message in the Outlook on the web review pane.The message will open in the browser if you are logged in to your mailbox via Outlook on the web. You will be prompted to login if you are not already logged in with the browser.This URL cannot be accessed from within an iFrame.
  • [SaveToSentItems <Boolean?>]:

INPUTOBJECT : Identity Parameter

  • [AccessReviewInstanceId <String>]: key: id of accessReviewInstance
  • [AppLogCollectionRequestId <String>]: key: id of appLogCollectionRequest
  • [AuthenticationMethodId <String>]: key: id of authenticationMethod
  • [CalendarId <String>]: key: id of calendar
  • [DeviceEnrollmentConfigurationId <String>]: key: id of deviceEnrollmentConfiguration
  • [DeviceLogCollectionResponseId <String>]: key: id of deviceLogCollectionResponse
  • [EventId <String>]: key: id of event
  • [EventId1 <String>]: key: id of event
  • [MailFolderId <String>]: key: id of mailFolder
  • [MailFolderId1 <String>]: key: id of mailFolder
  • [ManagedDeviceId <String>]: key: id of managedDevice
  • [MessageId <String>]: key: id of message
  • [MobileAppTroubleshootingEventId <String>]: key: id of mobileAppTroubleshootingEvent
  • [NotebookId <String>]: key: id of notebook
  • [OnenotePageId <String>]: key: id of onenotePage
  • [OnenoteSectionId <String>]: key: id of onenoteSection
  • [OutlookTaskFolderId <String>]: key: id of outlookTaskFolder
  • [OutlookTaskGroupId <String>]: key: id of outlookTaskGroup
  • [OutlookTaskId <String>]: key: id of outlookTask
  • [SharedInsightId <String>]: key: id of sharedInsight
  • [TrendingId <String>]: key: id of trending
  • [UsedInsightId <String>]: key: id of usedInsight
  • [UserId <String>]: key: id of user

MESSAGE : 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>]: Read-only.
  • [Attachments <IMicrosoftGraphAttachment[]>]: The fileAttachment and itemAttachment attachments for the message.
    • [Id <String>]: 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 display name of the attachment. This does not need to be the actual 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 an entity instance.
      • [Name <String>]: The display name of an entity instance.
  • [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. If the message contains instances of mention, this property would contain a concatenation of these mentions as well.
  • [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>]: 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, '2019-04-16T09:00:00'.
      • [TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for 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.
  • [Mentions <IMicrosoftGraphMention[]>]: A collection of mentions in the message, ordered by the createdDateTime from the newest to the oldest. By default, a GET /messages does not return this property unless you apply $expand on the property.
    • [Id <String>]: Read-only.
    • [Application <String>]: The name of the application where the mention is created. Optional. Not used and defaulted as null for message.
    • [ClientReference <String>]: A unique identifier that represents a parent of the resource instance. Optional. Not used and defaulted as null for message.
    • [CreatedBy <IMicrosoftGraphEmailAddress>]: emailAddress
    • [CreatedDateTime <DateTime?>]: The date and time that the mention is created on the client.
    • [DeepLink <String>]: A deep web link to the context of the mention in the resource instance. Optional. Not used and defaulted as null for message.
    • [MentionText <String>]: Optional. Not used and defaulted as null for message. To get the mentions in a message, see the bodyPreview property of the message instead.
    • [Mentioned <IMicrosoftGraphEmailAddress>]: emailAddress
    • [ServerCreatedDateTime <DateTime?>]: The date and time that the mention is created on the server. Optional. Not used and defaulted as null for message.
  • [MentionsPreview <IMicrosoftGraphMentionsPreview>]: mentionsPreview
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [IsMentioned <Boolean?>]: True if the signed-in user is mentioned in the parent resource instance. Read-only. Supports filter.
  • [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty[]>]: The collection of multi-value extended properties defined for the message. Nullable.
    • [Id <String>]: 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>]: 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
  • [UnsubscribeData <String[]>]:
  • [UnsubscribeEnabled <Boolean?>]:
  • [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, then the browser will show the message in the Outlook on the web review pane.The message will open in the browser if you are logged in to your mailbox via Outlook on the web. You will be prompted to login if you are not already logged in with the browser.This URL cannot be accessed from within an iFrame.