Export (0) Print
Expand All

DeliverPromoteEmailRequest Class

Dynamics CRM 2013

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

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

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

'Declaration
<DataContractAttribute(Namespace:="http://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class DeliverPromoteEmailRequest
	Inherits OrganizationRequest

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

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

Notes for Callers

This method is used by Microsoft Dynamics CRM for Microsoft Office Outlook.


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

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

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft