Click or drag to resize

MapperUtils.SetupEmailMapper Method (IAppContext, String, String, String, Template, Boolean, String, String, IField, IField, SavedFilterApplyOptions, Boolean, Int32)

Set up a mapper (includinig requerying) for emailing.

Namespace:  NetQuarry.Data
Assembly:  EAP.Mapper (in EAP.Mapper.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public static IMapper SetupEmailMapper(
	IAppContext cxt,
	string mapperKey,
	string originatorMop,
	string filterId,
	Template tmpl,
	bool preview,
	string emailFieldKey,
	string nameFieldKey,
	out IField fldEmail,
	out IField fldName,
	SavedFilterApplyOptions fltApplyOpts,
	bool ignoreEmailFields,
	int topN
)

Parameters

cxt
Type: NetQuarry.IAppContext
The application context.
mapperKey
Type: System.String
The mapper to set up (may be overridden if the template specifies a MergeMapper).
originatorMop
Type: System.String
The MOP of the page from which the mailing was originated (allows PageView override).
filterId
Type: System.String
The SavedFilter on which to filter the mapper.
tmpl
Type: NetQuarry.Template
The Template to use, if any.
preview
Type: System.Boolean
Specifies whether preveiwing or now. If previewing, the first record will be used to populate the template.
emailFieldKey
Type: System.String
The email field to use. If null, an attempt will be made to find an EmailAddr field.
nameFieldKey
Type: System.String
The email name field to use. If null, an attempt will be made to ascertain this from the email field.
fldEmail
Type: NetQuarry.Data.IField
The email field to use. If none found, the returned mapper will not be set up for emailing.
fldName
Type: NetQuarry.Data.IField
The name field to use, if any.
fltApplyOpts
Type: NetQuarry.Data.SavedFilterApplyOptions
Options to control how the saved filter is applied to the mapper.
ignoreEmailFields
Type: System.Boolean
If any email fields are missing then continue
topN
Type: System.Int32
Max number of recipients to include in the template mailing

Return Value

Type: IMapper
The mapper configured for emailing. Valid only if an email field is found.
See Also