SendEmailFromTemplateRequest Class

Artykuł
11/28/2016

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

Contains the data that is needed to send an email message using a template.

For the Web API use the SendEmailFromTemplate 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.SendEmailFromTemplateRequest

Syntax

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

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class SendEmailFromTemplateRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	SendEmailFromTemplateRequest()	Initializes a new instance of theSendEmailFromTemplateRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RegardingId	Gets or sets the ID of the record with which the email message is associated.
	RegardingType	Gets or sets the type of the record with which the email message is associated.
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	Target	Gets or sets the email record to send.
	TemplateId	Gets or sets the ID of the email template to use for the email.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of SendEmailFromTemplateResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Email entity and access rights on the records specified in the Target, RegardingId and TemplateId properties. For a complete list of the privileges required, see SendEmailFromTemplate message privileges.

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 'From:' activity party for the email
ActivityParty fromParty = new ActivityParty
{
    PartyId = new EntityReference(SystemUser.EntityLogicalName, _userId)
};

// Create the 'To:' activity party for the email
ActivityParty toParty = new ActivityParty
{
    PartyId = new EntityReference(Contact.EntityLogicalName, _contactId)
};

Console.WriteLine("Created activity parties.");

// Create an e-mail message.
Email email = new Email
{
    To = new ActivityParty[] { toParty },
    From = new ActivityParty[] { fromParty },
    Subject = "SDK Sample e-mail",
    Description = "SDK Sample for SendEmailFromTemplate Message.",
    DirectionCode = true
};

//Create a query expression to get one of Email Template of type "contact"

QueryExpression queryBuildInTemplates = new QueryExpression{
    EntityName = "template",
    ColumnSet = new ColumnSet("templateid", "templatetypecode"),
    Criteria = new FilterExpression()
};
queryBuildInTemplates.Criteria.AddCondition("templatetypecode",
    ConditionOperator.Equal, "contact");
EntityCollection templateEntityCollection = _serviceProxy.RetrieveMultiple(queryBuildInTemplates);

if (templateEntityCollection.Entities.Count > 0) 
{
    _templateId = (Guid)templateEntityCollection.Entities[0].Attributes["templateid"];
}
else
{
    throw new ArgumentException("Standard Email Templates are missing");
}             

// Create the request
SendEmailFromTemplateRequest emailUsingTemplateReq = new SendEmailFromTemplateRequest
{
    Target = email,

    // Use a built-in Email Template of type "contact".
    TemplateId = _templateId,

    // The regarding Id is required, and must be of the same type as the Email Template.
    RegardingId = _contactId,
    RegardingType = Contact.EntityLogicalName
};

SendEmailFromTemplateResponse emailUsingTemplateResp = (SendEmailFromTemplateResponse)_serviceProxy.Execute(emailUsingTemplateReq);

// Verify that the e-mail has been created
_emailId = emailUsingTemplateResp.Id;
if (!_emailId.Equals(Guid.Empty))
{
    Console.WriteLine("Successfully sent an e-mail message using the template.");
}



' Create the 'From:' activity party for the email
Dim fromParty As ActivityParty = New ActivityParty With {.PartyId = New EntityReference(SystemUser.EntityLogicalName, _userId)}

' Create the 'To:' activity party for the email
Dim toParty As ActivityParty = New ActivityParty With {.PartyId = New EntityReference(Contact.EntityLogicalName, _contactId)}

Console.WriteLine("Created activity parties.")

' Create an e-mail message.
Dim email As Email = New Email With {.To = New ActivityParty() {toParty}, .From = New ActivityParty() {fromParty}, _
                .Subject = "SDK Sample e-mail", .Description = "SDK Sample for SendEmailFromTemplate Message.", _
                .DirectionCode = True}

' Create the request
Dim emailUsingTemplateReq As SendEmailFromTemplateRequest = New SendEmailFromTemplateRequest With {.Target = email, _
                .TemplateId = New Guid("07B94C1D-C85F-492F-B120-F0A743C540E6"), .RegardingId = _contactId, _
                .RegardingType = Contact.EntityLogicalName}
' Use a built-in Email Template of type "contact".
' The regarding Id is required, and must be of the same type as the Email Template.

Dim emailUsingTemplateResp As SendEmailFromTemplateResponse = CType(_serviceProxy.Execute(emailUsingTemplateReq),  _
                SendEmailFromTemplateResponse)

' Verify that the e-mail has been created
_emailId = emailUsingTemplateResp.Id
If Not _emailId.Equals(Guid.Empty) Then
    Console.WriteLine("Successfully sent an e-mail message using the template.")
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.

Udostępnij za pośrednictwem