MapperUtilsSetupEmailMapper Method (IAppContext, String, String, String, Template, Boolean, String, String, IField, IField) |
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
)
Public Shared Function SetupEmailMapper (
cxt As IAppContext,
mapperKey As String,
originatorMop As String,
filterId As String,
tmpl As Template,
preview As Boolean,
emailFieldKey As String,
nameFieldKey As String,
<OutAttribute> ByRef fldEmail As IField,
<OutAttribute> ByRef fldName As IField
) As IMapper
Parameters
- cxt
- Type: NetQuarryIAppContext
The application context. - mapperKey
- Type: SystemString
The mapper to set up (may be overridden if the template specifies a MergeMapper). - originatorMop
- Type: SystemString
The MOP of the page from which the mailing was originated (allows PageView override). - filterId
- Type: SystemString
The SavedFilter on which to filter the mapper. - tmpl
- Type: NetQuarryTemplate
The Template to use, if any. - preview
- Type: SystemBoolean
Specifies whether preveiwing or now. If previewing, the first record will be used to populate the template. - emailFieldKey
- Type: SystemString
The email field to use. If null, an attempt will be made to find an EmailAddr field. - nameFieldKey
- Type: SystemString
The email name field to use. If null, an attempt will be made to ascertain this from the email field. - fldEmail
- Type: NetQuarry.DataIField
The email field to use. If none found, the returned mapper will not be set up for emailing. - fldName
- Type: NetQuarry.DataIField
The name field to use, if any.
Return Value
Type:
IMapperThe mapper configured for emailing. Valid only if an email field is found.
See Also