Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-09-18
Use the New-MailMessage cmdlet to create an email message for the specified user mailbox and place the email message in the Drafts folder of the user's mailbox.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
New-MailMessage [-Body <String>] [-BodyFormat
<PlainText | Html | Rtf>] [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-Subject <String>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example creates an email message in the Drafts folder with the subject and body specified by the Subject and Body parameters. The message body is rendered in plain text because no format for the message body is specified.
Copy Code | |
---|---|
New-MailMessage -Subject "Delivery Report" -Body "Click here to view this report" |
EXAMPLE 2
This example creates an empty email message in the Drafts folder because no subject or message body is specified.
Copy Code | |
---|---|
New-MailMessage |
EXAMPLE 3
This example creates an email message in the Drafts folder with the subject and body specified by the Subject and Body parameters. The message body is rendered in HTML format.
Copy Code | |
---|---|
New-MailMessage -Subject "Delivery Information" -Body "Click here to see details" -BodyFormat Html |
Detailed Description
If the cmdlet is run without specifying the Subject or Body parameters, an empty email message is placed in the user's Drafts folder.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "User mailboxes" entry in the Recipients Permissions topic.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Body |
Optional |
System.String |
The Body parameter specifies the content of the body section of the new email message. |
BodyFormat |
Optional |
Microsoft.Exchange.Data.Providers.MailBodyFormat |
The BodyFormat parameter specifies the format of the
message body. The values can be |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
Subject |
Optional |
System.String |
The Subject parameter specifies the content of the subject field of the new email message. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.