Export (0) Print
Expand All

New-MailMessage

Topic Last Modified: 2011-03-19

Use the New-MailMessage cmdlet to create an e-mail message for the specified user mailbox and place the e-mail message in the Drafts folder of the user's mailbox.


New-MailMessage [-Body <String>] -Mailbox <MailboxIdParameter> [-BodyFormat <PlainText | Html | Rtf>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Subject <String>] [-WhatIf [<SwitchParameter>]]

Parameter Required Type Description

Mailbox

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Mailbox parameter specifies a unique identifier for the destination mailbox where the e-mail message is being created. You can use any of the following values for this parameter:

  • Alias
  • Display name
  • Domain\Account
  • SMTP address
  • Distinguished name (DN)
  • Object GUID
  • User principal name (UPN)
  • LegacyExchangeDN

Body

Optional

System.String

The Body parameter specifies the content of the body section of the new e-mail message.

BodyFormat

Optional

Microsoft.Exchange.Data.Providers.MailBodyFormat

The BodyFormat parameter specifies the format of the message body. The values can be PlainText, Rtf (rich text format), or Html. By default if the BodyFormat parameter isn't specified when the Body parameter is used, the message body is rendered in plain text.

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 retrieves data from Active Directory.

Subject

Optional

System.String

The Subject parameter specifies the content of the subject field of the new e-mail 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.

If the cmdlet is run without specifying the Subject or Body parameters, an empty e-mail 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 reporting" entry in the Client Access Permissions topic.

Error Description

 

This example creates an e-mail message in the Drafts folder of Tony's mailbox, 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.

New-MailMessage -Subject "Delivery Report" -Body "Click here to view this report" -Mailbox tony

This example creates an empty e-mail message in the Drafts folder of Tony's mailbox because no subject or message body is specified.

New-MailMessage -Mailbox tony@contoso.com

This example creates an e-mail message in the Drafts folder of Tony's mailbox with the subject and body specified by the Subject and Body parameters. The message body is rendered in HTML format.

New-MailMessage -Subject "Delivery Information" -Body "Click here to see details" -Mailbox tony -BodyFormat Html
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft