MailMergeTemplate entity messages and methods

 

Applies To: Dynamics CRM 2013

This entity represents a template for a mail merge document. The schema name for this entity is MailMergeTemplate. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AssignRequest	Assigns a mail merge template to another user or team.
AssociateRequest	Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see MailMergeTemplate entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
CreateRequest	Creates a mail merge template. You can also call the IOrganizationService.Create method.
DeleteRequest	Deletes a mail merge template. You can also call the IOrganizationService.Delete method.
DisassociateRequest	Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService. Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see MailMergeTemplate entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
GrantAccessRequest	Shares a mail merge template with another security principal (user or team).
InitializeFromRequest	Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.
ModifyAccessRequest	Changes the access rights for a mail merge template previously shared with another security principal (user or team).
RetrievePrincipalAccessRequest	Retrieves the access that the specified security principal (user or team) has to a mail merge template.
RetrieveSharedPrincipalsAndAccessRequest	Retrieves the security principals (users or teams) that have access to a mail merge template, along with their access rights to the mail merge template.
RevokeAccessRequest	Removes all access to a mail merge template for the specified security principal (user or team).
RetrieveDuplicatesRequest	Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.
RetrieveRequest	Retrieves a mail merge template. You can also call the IOrganizationService.Retrieve method.
RetrieveMultipleRequest	Retrieves a collection of mail merge templates. You can also call the IOrganizationService.RetrieveMultiple method.
SetStateRequest	Sets the state of a mail merge template. The possible states are defined in the MailMergeTemplate.Statecode attribute. If you are using early bound types, use the MailMergeTemplateState enumeration. For a list of possible states, see MailMergeTemplate entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
UpdateRequest	Updates a mail merge template. You can also call the IOrganizationService.Update method.

See Also

Activity entities
Template entities
ContractTemplate entity messages and methods
KbArticleTemplate entity messages and methods
Template (email template) entity messages and methods
MailMergeTemplate entity privileges