SendEmailFromTemplateRequest 类

应用到: CRM 2015 on-prem, CRM Online

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

命名空间: Microsoft.Crm.Sdk.Messages
程序集: Microsoft.Crm.Sdk.Proxy (在 Microsoft.Crm.Sdk.Proxy.dll 中)

语法

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

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class SendEmailFromTemplateRequest : 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 '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.");
}

备注

Message Availability

若要使此消息正常工作，调用方必须连接到服务器。

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

继承层次结构

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

线程安全性

此类型的所有公共静态（Visual Basic 中的 Shared）成员都是线程安全成员。不保证任何实例成员是线程安全成员。

平台

开发平台

Windows Vista、Windows Server 2003 和

目标平台

Windows Vista,Windows XP

Change History

另请参阅

参考

SendEmailFromTemplateRequest 成员
Microsoft.Crm.Sdk.Messages 命名空间
SendEmailFromTemplateResponse

其他资源

E-mail Activity Entities
Email (E-mail) Entity Messages and Methods
Sample: Send an E-mail Using a Template

Send comments about this topic to Microsoft.
© 2014 Microsoft Corporation. All rights reserved.