DeliverPromoteEmailRequest Class

 

Updated: November 29, 2016

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)

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

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class DeliverPromoteEmailRequest : OrganizationRequest

NameDescription
System_CAPS_pubmethodDeliverPromoteEmailRequest()

Initializes a new instance of the DeliverPromoteEmailRequest class.

NameDescription
System_CAPS_pubpropertyAttachments

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

System_CAPS_pubpropertyBcc

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

System_CAPS_pubpropertyBody

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

System_CAPS_pubpropertyCc

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

System_CAPS_pubpropertyEmailId

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

System_CAPS_pubpropertyExtensionData

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

System_CAPS_pubpropertyExtraProperties

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

System_CAPS_pubpropertyFrom

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

System_CAPS_pubpropertyImportance

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

System_CAPS_pubpropertyItem[String]

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

System_CAPS_pubpropertyMessageId

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

System_CAPS_pubpropertyParameters

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

System_CAPS_pubpropertyReceivedOn

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

System_CAPS_pubpropertyRequestId

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

System_CAPS_pubpropertyRequestName

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

System_CAPS_pubpropertySubject

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

System_CAPS_pubpropertySubmittedBy

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

System_CAPS_pubpropertyTo

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

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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.");
}

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

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

Show: