DeliverPromoteEmailRequest Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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.

Namespace:   Microsoft.Crm.Sdk.Messages
Assembly:  Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.DeliverPromoteEmailRequest

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class DeliverPromoteEmailRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class DeliverPromoteEmailRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod DeliverPromoteEmailRequest()

Initializes a new instance of the DeliverPromoteEmailRequest class.

Properties

Name Description
System_CAPS_pubproperty Attachments

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

System_CAPS_pubproperty Bcc

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

System_CAPS_pubproperty Body

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

System_CAPS_pubproperty Cc

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

System_CAPS_pubproperty EmailId

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

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty ExtraProperties

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

System_CAPS_pubproperty From

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

System_CAPS_pubproperty Importance

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

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty MessageId

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

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty ReceivedOn

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

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Subject

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

System_CAPS_pubproperty SubmittedBy

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

System_CAPS_pubproperty To

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

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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

Examples

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.



// Create the request.
DeliverPromoteEmailRequest 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.
DeliverPromoteEmailResponse deliverEmailResponse = (DeliverPromoteEmailResponse)_serviceProxy.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)_serviceProxy.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.");
}


' Create the request.
Dim deliverEmailRequest As DeliverPromoteEmailRequest = New DeliverPromoteEmailRequest With {.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 = Date.Now}

' We won't attach a file to the email, but the Attachments property is required.
deliverEmailRequest.Attachments = New EntityCollection(New ActivityMimeAttachment(){})
deliverEmailRequest.Attachments.EntityName = ActivityMimeAttachment.EntityLogicalName

' Execute the request.
Dim deliverEmailResponse As DeliverPromoteEmailResponse = CType(_serviceProxy.Execute(deliverEmailRequest),  _
                                                                DeliverPromoteEmailResponse)

' Verify the success.

' Define an anonymous type to define the possible values for
' email status
Dim EmailStatus = New With {Key .Draft = 1, Key .Completed = 2, Key .Sent = 3, Key .Received = 3, Key .Canceled = 5, _
                            Key .PendingSend = 6, Key .Sending = 7, Key .Failed = 8}

' Query for the delivered email, and verify the status code is "Sent".
Dim deliveredMailColumns As New ColumnSet("statuscode")
Dim deliveredEmail As Email = CType(_serviceProxy.Retrieve(Email.EntityLogicalName, deliverEmailResponse.EmailId, _
                                                           deliveredMailColumns), Email)

_emailId = deliveredEmail.ActivityId.Value

If deliveredEmail.StatusCode.Value = EmailStatus.Sent Then
    Console.WriteLine("Successfully created and delivered the e-mail message.")
End If

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

DeliverPromoteEmailResponse
Microsoft.Crm.Sdk.Messages Namespace
Email activity entities
Email entity messages and methods
Sample: Promote an email message to Microsoft Dynamics 365

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright