EMDocuments Class

Alterian Email Manager 6.2.3 SDK Help File
A service class to expose methods to interact with EM Documents and EM Folders.
Inheritance Hierarchy
SystemObject
  DMLibraryEMDocuments

Namespace:  DMLibrary
Assembly:  DMLibrary (in DMLibrary.dll) Version: 1.0.6340.17420

Syntax
public class EMDocuments

The EMDocuments type exposes the following members.

Constructors
NameDescription
Public methodEMDocuments
Initializes a new instance of the EMDocuments class
Top
Methods
NameDescription
Public methodStatic memberAddCampaignMetadataToCampaignSave
Adds a task to a transactional Campaign Save that will update the Metadata of the Campaign.
Public methodStatic memberAddCreativeContentToCampaignSave
Add a task to a transactional Campaign Save to update or add HTML or Text Content to a Creative.
Public methodStatic memberAddCreativeMetadataToCampaignSave
Add a task to a transactional Campaign Save that will update the metadata of a Creative.
Public methodStatic memberAddDeletedCreativeToCampaignSave
Adds a task to a transactional Campaign Save that will remove a Creative from a Campaign.
Public methodStatic memberAddNewCreativeToCampaignSave
Adds a task to a transactional Campaign Save that will add a new Creative to the Campaign.
Public methodStatic memberAssertCreativeModifyAccess
Asserts if user has modification rights for the campaign
Public methodStatic memberBeginCampaignSave
Initiate a new transactional Campaign Save.
Public methodStatic memberCanDeleteCreative
Determines if the creative specified can be deleted (based on if it is referenced by other creative in the campaign or not)
Public methodStatic memberCanSaveCampaign
Returns a flag indicating if a campaign can be saved
Public methodStatic memberCommitCampaignSave
Commit all changes to a transactional Campaign Save.
Public methodStatic memberCopyCampaign
Make a copy of an existing Email Campaign.
Public methodStatic memberCreateCreativeInCampaign(DMToken, String, String, EMDocumentType, Int32, Boolean, Boolean, EMContent, EMContent, Boolean)
Creates a new Creative in a Campaign.
Public methodStatic memberCreateCreativeInCampaign(DMToken, String, String, EMDocumentType, Int32, Boolean, Boolean, EMContent, EMContent, Boolean, SqlConnection, SqlTransaction, String, String, String)
Create a new Creative in a Campaign, supplying the Connection and Transaction context.
Public methodStatic memberCreateEmailCampaign
Creates an EM Email Campaign Document and its underlying DM Creative.
Public methodStatic memberCreateFolder
Create a new folder.
Public methodStatic memberDeleteEmailCampaign
Delete an Email Campaign, marking it as disabled.
Public methodStatic memberDeleteFolder
Delete an existing folder
Public methodStatic memberGetCampaignIDFromDMCreativeID
Get the Campaign ID associated with a DM Creative ID. Method does not require the Campaign to be enabled, but will throw an exception if the Campaign does not exist at all.
Public methodStatic memberGetCampaignMetadata
Reads uncommitted basic metadata for a campaign, including only the underlying DMCreativeId, and the VarOpen and VarClose strings.
Public methodStatic memberGetCreativeIDFromTemplateIDs
Gets the CreativeID that exactly matches to the provided Html and Text Template Ids. If no Creative within the given Campaign exactly matches these IDs, CreativeID = 0 will be returned and TemplateMappingError will be populated with a friendly error message. If a Creative is found, TemplateMappingError will be an empty string.
Public methodStatic memberGetDeliveryContextNameFromDMCreativeID
Retrieves The Delivery Context associated to the DM Creative's Category ID. If no Delivery Context is associated then it will try to return the client's default delivery context
Public methodStatic memberGetDMCreativeIDForCampaign(DMToken, Int32)
Fetches the DM Creative Id for a given campaign if one can be found.
Public methodStatic memberGetDMCreativeIDForCampaign(SqlConnection, SqlTransaction, Int32)
Fetches the DM Creative Id for a given campaign if one can be found.
Public methodStatic memberGetDocument
Get an EM Document
Public methodStatic memberGetDocumentName
Gets document name for specified id
Public methodStatic memberGetDocumentsByName
Get all Documents that have names containing the search string.
Public methodStatic memberGetFolderContents
Retrieves a list of EM Documents in a given folder.
Public methodStatic memberGetFolderPath
Gets the flattened folder path for a Folder ID (DM Creative Category)
Public methodStatic memberGetFolders
Retrieves a list of EM content folders.
Public methodStatic memberGetHTMLTemplateID
Get The HTML Template ID for the given document
Public methodStatic memberGetListCategoryPath
Gets the flattened list category path
Public methodStatic memberGetRecentDocuments
Retrieves a list of EM Documents that were recently modified by a given user.
Public methodStatic memberGetTemplateContent
Returns the DM template content for a given EM Creative.
Public methodStatic memberGetTemplateContentForUseInDifferentCampaign
Returns the DM Template content for a given EM Creative, but it resolves any template reference within the given DM Template according to the campaign declared by the DestinationEMCampaignId parameter. This is used when transferring the creative content from one Campaign to another Campaign. If the destination Campaign does not have a Creative containing a DM Template with the relevant name, an error will occur. This avoids that happening.
Public methodStatic memberGetTemplateContentWithAlternateEncoding
Gets corrected unicode content with new encoding
Public methodStatic memberGetTextTemplateID
Get The Text Creative ID for the given document
Public methodStatic memberGetUniqueNameForNewDocument
Generic method to Retrieve a unique name for the EM Document
Public methodStatic memberLogCampaignActivityByDMCreativeId
Logs activity on the EM Campaign associated with the provided DM Creative Id.
Public methodStatic memberLogDocumentActivity(DMToken, Int32, EMDocumentActivityType)
Logs activity on the specified EM document.
Public methodStatic memberLogDocumentActivity(DMToken, Int32, EMDocumentActivityType, SqlConnection, SqlTransaction)
Logs activity on the specified EM document.
Public methodStatic memberUpdateCreative
Update an existing Creative.
Public methodStatic memberUpdateEmailCampaign
Update an existing Email Campaign Document.
Public methodStatic memberUpdateFolderName
Update the name of an existing folder.
Public methodStatic memberValidateCampaignContainsCreative
Validate that a campaign contains a creative
Top
See Also