Clase de SendEmailFromTemplateRequest

Artigo
12/03/2014

Se aplica a: CRM 2015 on-prem, CRM Online

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

Espacio de nombres: Microsoft.Crm.Sdk.Messages
Ensamblado: Microsoft.Crm.Sdk.Proxy (en Microsoft.Crm.Sdk.Proxy.dll)

Sintaxis

'Declaración
<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

Ejemplo

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

Comentarios

Message Availability

Para que este mensaje funcione, el autor de la llamada debe estar conectado al servidor.

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.

Jerarquía heredada

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

Seguridad de hilo

Los miembros estáticos públicos (Shared en Visual Basic) de este tipo son seguros para el hilo. No se garantiza que los miembros de instancia sean seguros para el hilo.

Plataformas

Plataformas de desarrollo

Windows Vista, Windows Server 2003 y

Plataformas de destino

Windows Vista,Windows XP

Change History

Vea también

Referencia

Miembros de SendEmailFromTemplateRequest
Espacio de nombres de Microsoft.Crm.Sdk.Messages
SendEmailFromTemplateResponse

Otros recursos

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

Compartir por