Class NSMailMergeSettings
Settings specifying what selection to perform the mailmerge on, what merge document to use etc.
Constructors
NSMailMergeSettings()
Initializes a new instance of the NSMailMergeSettings class.
Declaration
NSMailMergeSettingsMethods
GetAddCompanyInterest()
Adds this company interest to each company recipient.
Declaration
Integer GetAddCompanyInterest()Examples
NSMailMergeSettings thing;
Integer addCompanyInterest = thing.GetAddCompanyInterest();Returns
| Type | Description |
| Integer |
GetAddPersonInterest()
Adds this person interest to each person recipient.
Declaration
Integer GetAddPersonInterest()Examples
NSMailMergeSettings thing;
Integer addPersonInterest = thing.GetAddPersonInterest();Returns
| Type | Description |
| Integer |
GetAlwaysUseCustomAttention()
Declaration
Bool GetAlwaysUseCustomAttention()Examples
NSMailMergeSettings thing;
Bool alwaysUseCustomAttention = thing.GetAlwaysUseCustomAttention();Returns
| Type | Description |
| Bool | Should custom attention always be used? If false, only use custom attention where there is no default. |
GetCustomAttention()
Declaration
String GetCustomAttention()Examples
NSMailMergeSettings thing;
String customAttention = thing.GetCustomAttention();Returns
| Type | Description |
| String | Custom value for attention. |
GetCustomMailBody()
Declaration
String GetCustomMailBody()Examples
NSMailMergeSettings thing;
String customMailBody = thing.GetCustomMailBody();Returns
| Type | Description |
| String | If specified, use this value as default mail body. |
GetCustomMailSubject()
Declaration
String GetCustomMailSubject()Examples
NSMailMergeSettings thing;
String customMailSubject = thing.GetCustomMailSubject();Returns
| Type | Description |
| String | If specified, use this value as default mail subject. |
GetDocumentId()
Declaration
Integer GetDocumentId()Examples
NSMailMergeSettings thing;
Integer documentId = thing.GetDocumentId();Returns
| Type | Description |
| Integer | Identity of document to be used as merge draft. |
GetExtraInfo()
Declaration
String GetExtraInfo()Examples
NSMailMergeSettings thing;
String extraInfo = thing.GetExtraInfo();Returns
| Type | Description |
| String | Used to store additional information for the delivery systems. |
GetIncludeNoMailingsRecipient()
Declaration
Bool GetIncludeNoMailingsRecipient()Examples
NSMailMergeSettings thing;
Bool includeNoMailingsRecipient = thing.GetIncludeNoMailingsRecipient();Returns
| Type | Description |
| Bool | Include recipients that are marked with NoMailings. |
GetIncludeRetiredRecipients()
Declaration
Bool GetIncludeRetiredRecipients()Examples
NSMailMergeSettings thing;
Bool includeRetiredRecipients = thing.GetIncludeRetiredRecipients();Returns
| Type | Description |
| Bool | Include recipients that are marked as retired. |
GetIncludeStoppedRecipients()
Include recipients that are marked with stop
Declaration
Bool GetIncludeStoppedRecipients()Examples
NSMailMergeSettings thing;
Bool includeStoppedRecipients = thing.GetIncludeStoppedRecipients();Returns
| Type | Description |
| Bool |
GetIsTemporarySelection()
Declaration
Bool GetIsTemporarySelection()Examples
NSMailMergeSettings thing;
Bool isTemporarySelection = thing.GetIsTemporarySelection();Returns
| Type | Description |
| Bool | If true, the selection is a temporary selection that can be deleted later. |
GetMailMergeDeliveryType()
Declaration
Integer GetMailMergeDeliveryType()Examples
NSMailMergeSettings thing;
Integer mailMergeDeliveryType = thing.GetMailMergeDeliveryType();Returns
| Type | Description |
| Integer | How the merged document is delivered to the recipients. See <xref href="CRMScript.NetServer.EMailMergeTargetType" data-throw-if-not-resolved="false"></xref> |
GetProjectId()
Declaration
Integer GetProjectId()Examples
NSMailMergeSettings thing;
Integer projectId = thing.GetProjectId();Returns
| Type | Description |
| Integer | Identity of project to use as source for recipients. |
GetRemoveCompanyInterest()
Declaration
Integer GetRemoveCompanyInterest()Examples
NSMailMergeSettings thing;
Integer removeCompanyInterest = thing.GetRemoveCompanyInterest();Returns
| Type | Description |
| Integer | Remove this company interest on each company recipient. |
GetRemovePersonInterest()
Declaration
Integer GetRemovePersonInterest()Examples
NSMailMergeSettings thing;
Integer removePersonInterest = thing.GetRemovePersonInterest();Returns
| Type | Description |
| Integer | Remove this person interest on each person recipient. |
GetSaveDocument()
Declaration
Bool GetSaveDocument()Examples
NSMailMergeSettings thing;
Bool saveDocument = thing.GetSaveDocument();Returns
| Type | Description |
| Bool | Should we save a reference to the merge document on each recipient. |
GetSelectionId()
Declaration
Integer GetSelectionId()Examples
NSMailMergeSettings thing;
Integer selectionId = thing.GetSelectionId();Returns
| Type | Description |
| Integer | Identity of selection to use as source for recipients. |
GetSynchronous()
Declaration
Bool GetSynchronous()Examples
NSMailMergeSettings thing;
Bool synchronous = thing.GetSynchronous();Returns
| Type | Description |
| Bool |
GetTaskEntity()
Declaration
NSMailMergeTask GetTaskEntity()Examples
NSMailMergeSettings thing;
NSMailMergeTask taskEntity = thing.GetTaskEntity();Returns
| Type | Description |
| NSMailMergeTask | If specified, register a task on recipients using properties from this object. |
GetTestOnly()
Declaration
Bool GetTestOnly()Examples
NSMailMergeSettings thing;
Bool testOnly = thing.GetTestOnly();Returns
| Type | Description |
| Bool | If true, do the merge task, but use current user as target, instead of selection members. |
SetAddCompanyInterest(Integer)
Adds this company interest to each company recipient.
Declaration
Void SetAddCompanyInterest(Integer addCompanyInterest)Examples
NSMailMergeSettings thing;
Integer addCompanyInterest;
thing.SetAddCompanyInterest(addCompanyInterest);Parameters
| Type | Name | Description |
| Integer | addCompanyInterest |
Returns
| Type | Description |
| Void |
SetAddPersonInterest(Integer)
Adds this person interest to each person recipient.
Declaration
Void SetAddPersonInterest(Integer addPersonInterest)Examples
NSMailMergeSettings thing;
Integer addPersonInterest;
thing.SetAddPersonInterest(addPersonInterest);Parameters
| Type | Name | Description |
| Integer | addPersonInterest |
Returns
| Type | Description |
| Void |
SetAlwaysUseCustomAttention(Bool)
Declaration
Void SetAlwaysUseCustomAttention(Bool alwaysUseCustomAttention)Examples
NSMailMergeSettings thing;
Bool alwaysUseCustomAttention;
thing.SetAlwaysUseCustomAttention(alwaysUseCustomAttention);Parameters
| Type | Name | Description |
| Bool | alwaysUseCustomAttention | Should custom attention always be used? If false, only use custom attention where there is no default. |
Returns
| Type | Description |
| Void |
SetCustomAttention(String)
Declaration
Void SetCustomAttention(String customAttention)Examples
NSMailMergeSettings thing;
String customAttention;
thing.SetCustomAttention(customAttention);Parameters
| Type | Name | Description |
| String | customAttention | Custom value for attention. |
Returns
| Type | Description |
| Void |
SetCustomMailBody(String)
Declaration
Void SetCustomMailBody(String customMailBody)Examples
NSMailMergeSettings thing;
String customMailBody;
thing.SetCustomMailBody(customMailBody);Parameters
| Type | Name | Description |
| String | customMailBody | If specified, use this value as default mail body. |
Returns
| Type | Description |
| Void |
SetCustomMailSubject(String)
Declaration
Void SetCustomMailSubject(String customMailSubject)Examples
NSMailMergeSettings thing;
String customMailSubject;
thing.SetCustomMailSubject(customMailSubject);Parameters
| Type | Name | Description |
| String | customMailSubject | If specified, use this value as default mail subject. |
Returns
| Type | Description |
| Void |
SetDocumentId(Integer)
Declaration
Void SetDocumentId(Integer documentId)Examples
NSMailMergeSettings thing;
Integer documentId;
thing.SetDocumentId(documentId);Parameters
| Type | Name | Description |
| Integer | documentId | Identity of document to be used as merge draft. |
Returns
| Type | Description |
| Void |
SetExtraInfo(String)
Declaration
Void SetExtraInfo(String extraInfo)Examples
NSMailMergeSettings thing;
String extraInfo;
thing.SetExtraInfo(extraInfo);Parameters
| Type | Name | Description |
| String | extraInfo | Used to store additional information for the delivery systems. |
Returns
| Type | Description |
| Void |
SetIncludeNoMailingsRecipient(Bool)
Declaration
Void SetIncludeNoMailingsRecipient(Bool includeNoMailingsRecipient)Examples
NSMailMergeSettings thing;
Bool includeNoMailingsRecipient;
thing.SetIncludeNoMailingsRecipient(includeNoMailingsRecipient);Parameters
| Type | Name | Description |
| Bool | includeNoMailingsRecipient | Include recipients that are marked with NoMailings. |
Returns
| Type | Description |
| Void |
SetIncludeRetiredRecipients(Bool)
Declaration
Void SetIncludeRetiredRecipients(Bool includeRetiredRecipients)Examples
NSMailMergeSettings thing;
Bool includeRetiredRecipients;
thing.SetIncludeRetiredRecipients(includeRetiredRecipients);Parameters
| Type | Name | Description |
| Bool | includeRetiredRecipients | Include recipients that are marked as retired. |
Returns
| Type | Description |
| Void |
SetIncludeStoppedRecipients(Bool)
Declaration
Void SetIncludeStoppedRecipients(Bool includeStoppedRecipients)Examples
NSMailMergeSettings thing;
Bool includeStoppedRecipients;
thing.SetIncludeStoppedRecipients(includeStoppedRecipients);Parameters
| Type | Name | Description |
| Bool | includeStoppedRecipients | Include recipients that are marked with stop. |
Returns
| Type | Description |
| Void |
SetIsTemporarySelection(Bool)
Declaration
Void SetIsTemporarySelection(Bool isTemporarySelection)Examples
NSMailMergeSettings thing;
Bool isTemporarySelection;
thing.SetIsTemporarySelection(isTemporarySelection);Parameters
| Type | Name | Description |
| Bool | isTemporarySelection | If true, the selection is a temporary selection that can be deleted later. |
Returns
| Type | Description |
| Void |
SetMailMergeDeliveryType(Integer)
Declaration
Void SetMailMergeDeliveryType(Integer mailMergeDeliveryType)Examples
NSMailMergeSettings thing;
Integer mailMergeDeliveryType;
thing.SetMailMergeDeliveryType(mailMergeDeliveryType);Parameters
| Type | Name | Description |
| Integer | mailMergeDeliveryType | How the merged document is delivered to the recipients. See <xref href="CRMScript.NetServer.EMailMergeTargetType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetProjectId(Integer)
Declaration
Void SetProjectId(Integer projectId)Examples
NSMailMergeSettings thing;
Integer projectId;
thing.SetProjectId(projectId);Parameters
| Type | Name | Description |
| Integer | projectId | Identity of project to use as source for recipients. |
Returns
| Type | Description |
| Void |
SetRemoveCompanyInterest(Integer)
Declaration
Void SetRemoveCompanyInterest(Integer removeCompanyInterest)Examples
NSMailMergeSettings thing;
Integer removeCompanyInterest;
thing.SetRemoveCompanyInterest(removeCompanyInterest);Parameters
| Type | Name | Description |
| Integer | removeCompanyInterest | Remove this company interest on each company recipient. |
Returns
| Type | Description |
| Void |
SetRemovePersonInterest(Integer)
Declaration
Void SetRemovePersonInterest(Integer removePersonInterest)Examples
NSMailMergeSettings thing;
Integer removePersonInterest;
thing.SetRemovePersonInterest(removePersonInterest);Parameters
| Type | Name | Description |
| Integer | removePersonInterest | Remove this person interest on each person recipient. |
Returns
| Type | Description |
| Void |
SetSaveDocument(Bool)
Declaration
Void SetSaveDocument(Bool saveDocument)Examples
NSMailMergeSettings thing;
Bool saveDocument;
thing.SetSaveDocument(saveDocument);Parameters
| Type | Name | Description |
| Bool | saveDocument | Should we save a reference to the merge document on each recipient. |
Returns
| Type | Description |
| Void |
SetSelectionId(Integer)
Declaration
Void SetSelectionId(Integer selectionId)Examples
NSMailMergeSettings thing;
Integer selectionId;
thing.SetSelectionId(selectionId);Parameters
| Type | Name | Description |
| Integer | selectionId | Identity of selection to use as source for recipients. |
Returns
| Type | Description |
| Void |
SetSynchronous(Bool)
Declaration
Void SetSynchronous(Bool synchronous)Examples
NSMailMergeSettings thing;
Bool synchronous;
thing.SetSynchronous(synchronous);Parameters
| Type | Name | Description |
| Bool | synchronous |
Returns
| Type | Description |
| Void |
SetTaskEntity(NSMailMergeSettings)
Declaration
Void SetTaskEntity(NSMailMergeTask taskEntity)Examples
NSMailMergeSettings thing;
NSMailMergeTask taskEntity;
thing.SetTaskEntity(taskEntity);Parameters
| Type | Name | Description |
| NSMailMergeTask | taskEntity | If specified, register a task on recipients using properties from this object. |
Returns
| Type | Description |
| Void |
SetTestOnly(Bool)
Declaration
Void SetTestOnly(Bool testOnly)Examples
NSMailMergeSettings thing;
Bool testOnly;
thing.SetTestOnly(testOnly);Parameters
| Type | Name | Description |
| Bool | testOnly | If true, do the merge task, but use current user as target, instead of selection members. |
Returns
| Type | Description |
| Void |