DeliverPromoteEmailRequest DeliverPromoteEmailRequest DeliverPromoteEmailRequest DeliverPromoteEmailRequest Class

Definition

Contains the data that is needed to create an email activity record from the specified email message (Track in CRM).

For the Web API use the DeliverPromoteEmail Action.

public ref class DeliverPromoteEmailRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class DeliverPromoteEmailRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type DeliverPromoteEmailRequest = class
    inherit OrganizationRequest
Public NotInheritable Class DeliverPromoteEmailRequest
Inherits OrganizationRequest
Inheritance
DeliverPromoteEmailRequestDeliverPromoteEmailRequestDeliverPromoteEmailRequestDeliverPromoteEmailRequest
Attributes

Examples


// Create the request.
      var deliverEmailRequest = new DeliverPromoteEmailRequest
      {
          Subject = "SDK Sample Email",
          To = emailContact.EMailAddress1,
          From = emailSender.InternalEMailAddress,
          Bcc = String.Empty,
          Cc = String.Empty,
          Importance = "high",
          Body = "This message will create an email activity.",
          MessageId = Guid.NewGuid().ToString(),
          SubmittedBy = "",
          ReceivedOn = DateTime.Now
      };     

// We won't attach a file to the email, but the Attachments property is required.
      deliverEmailRequest.Attachments = new EntityCollection(new ActivityMimeAttachment[0]);
      deliverEmailRequest.Attachments.EntityName = ActivityMimeAttachment.EntityLogicalName;                    

// Execute the request.
      var deliverEmailResponse = (DeliverPromoteEmailResponse)svc.Execute(deliverEmailRequest);

// Verify the success.
// Define an anonymous type to define the possible values for
// email status
      var EmailStatus = new
      {
          Draft = 1,
          Completed = 2,
          Sent = 3,
          Received = 3,
          Canceled = 5,
          PendingSend = 6,
          Sending = 7,
          Failed = 8,
      };

// Query for the delivered email, and verify the status code is "Sent".
      ColumnSet deliveredMailColumns = new ColumnSet("statuscode");
      Email deliveredEmail = (Email)svc.Retrieve(Email.EntityLogicalName, deliverEmailResponse.EmailId, deliveredMailColumns);
      _emailId = deliveredEmail.ActivityId.Value;
      
   if (deliveredEmail.StatusCode.Value == EmailStatus.Sent)
      {
          Console.WriteLine("Successfully created and delivered the e-mail message.");
      }

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

Activities#DeliverPromoteEmail1 ActivitiesVB#DeliverPromoteEmail1

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of DeliverPromoteEmailResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the activity entity. For a complete list of the privileges required, see DeliverPromoteEmail message privileges.

Notes for Callers

This method is used by Microsoft Dynamics 365 for Outlook.

Constructors

DeliverPromoteEmailRequest() DeliverPromoteEmailRequest() DeliverPromoteEmailRequest() DeliverPromoteEmailRequest()

Initializes a new instance of the DeliverPromoteEmailRequest class.

Properties

Attachments Attachments Attachments Attachments

Gets or sets a collection of activity mime attachment (email attachment) records to attach to the email message. Required.

Bcc Bcc Bcc Bcc

Gets or sets the addresses of the blind carbon copy (Bcc) recipients for the email message. Required.

Body Body Body Body

Gets or sets the message body for the email. Required.

Cc Cc Cc Cc

Gets or sets the addresses of the carbon copy (Cc) recipients for the email message. Required.

EmailId EmailId EmailId EmailId

Gets or sets the ID of the email from which to create the email. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
ExtraProperties ExtraProperties ExtraProperties ExtraProperties

Gets or sets the extra properties for the email. Optional.

From From From From

Gets or sets the from address for the email message. Required.

Importance Importance Importance Importance

Gets or sets the level of importance for the email message. Required.

Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
MessageId MessageId MessageId MessageId

Gets or sets the ID of the email message stored in the email header. Required.

Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
ReceivedOn ReceivedOn ReceivedOn ReceivedOn

Gets or sets the time the message was received on. Required.

RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
Subject Subject Subject Subject

Gets or sets the subject line for the email message. Optional.

SubmittedBy SubmittedBy SubmittedBy SubmittedBy

Gets or sets the email address of the account that is creating the email activity instance. Required.

To To To To

Gets or sets the addresses of the recipients of the email message. Required.

Applies to

See also