Class NSMailMergeSettings

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Syntax

Constructors

NSMailMergeSettings()

Initializes a new instance of the NSMailMergeSettings class.

Declaration

NSMailMergeSettings

Methods

GetAddCompanyInterest()

Adds this company interest to each company recipient.

Declaration

Integer GetAddCompanyInterest()

Returns

Type	Description
Integer

Examples

NSMailMergeSettings thing;
Integer addCompanyInterest = thing.GetAddCompanyInterest();

GetAddPersonInterest()

Adds this person interest to each person recipient.

Declaration

Integer GetAddPersonInterest()

Returns

Type	Description
Integer

Examples

NSMailMergeSettings thing;
Integer addPersonInterest = thing.GetAddPersonInterest();

GetAlwaysUseCustomAttention()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Bool GetAlwaysUseCustomAttention()

Returns

Type	Description
Bool	Should custom attention always be used? If false, only use custom attention where there is no default.

Examples

NSMailMergeSettings thing;
Bool alwaysUseCustomAttention = thing.GetAlwaysUseCustomAttention();

GetCustomAttention()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

String GetCustomAttention()

Returns

Type	Description
String	Custom value for attention.

Examples

NSMailMergeSettings thing;
String customAttention = thing.GetCustomAttention();

GetCustomMailBody()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

String GetCustomMailBody()

Returns

Type	Description
String	If specified, use this value as default mail body.

Examples

NSMailMergeSettings thing;
String customMailBody = thing.GetCustomMailBody();

GetCustomMailSubject()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

String GetCustomMailSubject()

Returns

Type	Description
String	If specified, use this value as default mail subject.

Examples

NSMailMergeSettings thing;
String customMailSubject = thing.GetCustomMailSubject();

GetDocumentId()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Integer GetDocumentId()

Returns

Type	Description
Integer	Identity of document to be used as merge draft.

Examples

NSMailMergeSettings thing;
Integer documentId = thing.GetDocumentId();

GetExtraInfo()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

String GetExtraInfo()

Returns

Type	Description
String	Used to store additional information for the delivery systems.

Examples

NSMailMergeSettings thing;
String extraInfo = thing.GetExtraInfo();

GetIncludeNoMailingsRecipient()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Bool GetIncludeNoMailingsRecipient()

Returns

Type	Description
Bool	Include recipients that are marked with NoMailings.

Examples

NSMailMergeSettings thing;
Bool includeNoMailingsRecipient = thing.GetIncludeNoMailingsRecipient();

GetIncludeRetiredRecipients()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Bool GetIncludeRetiredRecipients()

Returns

Type	Description
Bool	Include recipients that are marked as retired.

Examples

NSMailMergeSettings thing;
Bool includeRetiredRecipients = thing.GetIncludeRetiredRecipients();

GetIncludeStoppedRecipients()

Include recipients that are marked with stop

Declaration

Bool GetIncludeStoppedRecipients()

Returns

Type	Description
Bool

Examples

NSMailMergeSettings thing;
Bool includeStoppedRecipients = thing.GetIncludeStoppedRecipients();

GetIsTemporarySelection()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Bool GetIsTemporarySelection()

Returns

Type	Description
Bool	If true, the selection is a temporary selection that can be deleted later.

Examples

NSMailMergeSettings thing;
Bool isTemporarySelection = thing.GetIsTemporarySelection();

GetMailMergeDeliveryType()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Integer GetMailMergeDeliveryType()

Returns

Type	Description
Integer	How the merged document is delivered to the recipients. See EMailMergeTargetType

Examples

NSMailMergeSettings thing;
Integer mailMergeDeliveryType = thing.GetMailMergeDeliveryType();

GetProjectId()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Integer GetProjectId()

Returns

Type	Description
Integer	Identity of project to use as source for recipients.

Examples

NSMailMergeSettings thing;
Integer projectId = thing.GetProjectId();

GetRemoveCompanyInterest()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Integer GetRemoveCompanyInterest()

Returns

Type	Description
Integer	Remove this company interest on each company recipient.

Examples

NSMailMergeSettings thing;
Integer removeCompanyInterest = thing.GetRemoveCompanyInterest();

GetRemovePersonInterest()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Integer GetRemovePersonInterest()

Returns

Type	Description
Integer	Remove this person interest on each person recipient.

Examples

NSMailMergeSettings thing;
Integer removePersonInterest = thing.GetRemovePersonInterest();

GetSaveDocument()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Bool GetSaveDocument()

Returns

Type	Description
Bool	Should we save a reference to the merge document on each recipient.

Examples

NSMailMergeSettings thing;
Bool saveDocument = thing.GetSaveDocument();

GetSelectionId()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Integer GetSelectionId()

Returns

Type	Description
Integer	Identity of selection to use as source for recipients.

Examples

NSMailMergeSettings thing;
Integer selectionId = thing.GetSelectionId();

GetSynchronous()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Bool GetSynchronous()

Returns

Type	Description
Bool

Examples

NSMailMergeSettings thing;
Bool synchronous = thing.GetSynchronous();

GetTaskEntity()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

NSMailMergeTask GetTaskEntity()

Returns

Type	Description
NSMailMergeTask	If specified, register a task on recipients using properties from this object.

Examples

NSMailMergeSettings thing;
NSMailMergeTask taskEntity = thing.GetTaskEntity();

GetTestOnly()

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Bool GetTestOnly()

Returns

Type	Description
Bool	If true, do the merge task, but use current user as target, instead of selection members.

Examples

NSMailMergeSettings thing;
Bool testOnly = thing.GetTestOnly();

SetAddCompanyInterest(Integer)

Adds this company interest to each company recipient.

Declaration

Void SetAddCompanyInterest(Integer addCompanyInterest)

Parameters

Type	Name	Description
Integer	addCompanyInterest

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Integer addCompanyInterest;
thing.SetAddCompanyInterest(addCompanyInterest);

SetAddPersonInterest(Integer)

Adds this person interest to each person recipient.

Declaration

Void SetAddPersonInterest(Integer addPersonInterest)

Parameters

Type	Name	Description
Integer	addPersonInterest

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Integer addPersonInterest;
thing.SetAddPersonInterest(addPersonInterest);

SetAlwaysUseCustomAttention(Bool)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetAlwaysUseCustomAttention(Bool 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

Examples

NSMailMergeSettings thing;
Bool alwaysUseCustomAttention;
thing.SetAlwaysUseCustomAttention(alwaysUseCustomAttention);

SetCustomAttention(String)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetCustomAttention(String customAttention)

Parameters

Type	Name	Description
String	customAttention	Custom value for attention.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
String customAttention;
thing.SetCustomAttention(customAttention);

SetCustomMailBody(String)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetCustomMailBody(String customMailBody)

Parameters

Type	Name	Description
String	customMailBody	If specified, use this value as default mail body.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
String customMailBody;
thing.SetCustomMailBody(customMailBody);

SetCustomMailSubject(String)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetCustomMailSubject(String customMailSubject)

Parameters

Type	Name	Description
String	customMailSubject	If specified, use this value as default mail subject.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
String customMailSubject;
thing.SetCustomMailSubject(customMailSubject);

SetDocumentId(Integer)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetDocumentId(Integer documentId)

Parameters

Type	Name	Description
Integer	documentId	Identity of document to be used as merge draft.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Integer documentId;
thing.SetDocumentId(documentId);

SetExtraInfo(String)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetExtraInfo(String extraInfo)

Parameters

Type	Name	Description
String	extraInfo	Used to store additional information for the delivery systems.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
String extraInfo;
thing.SetExtraInfo(extraInfo);

SetIncludeNoMailingsRecipient(Bool)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetIncludeNoMailingsRecipient(Bool includeNoMailingsRecipient)

Parameters

Type	Name	Description
Bool	includeNoMailingsRecipient	Include recipients that are marked with NoMailings.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Bool includeNoMailingsRecipient;
thing.SetIncludeNoMailingsRecipient(includeNoMailingsRecipient);

SetIncludeRetiredRecipients(Bool)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetIncludeRetiredRecipients(Bool includeRetiredRecipients)

Parameters

Type	Name	Description
Bool	includeRetiredRecipients	Include recipients that are marked as retired.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Bool includeRetiredRecipients;
thing.SetIncludeRetiredRecipients(includeRetiredRecipients);

SetIncludeStoppedRecipients(Bool)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetIncludeStoppedRecipients(Bool includeStoppedRecipients)

Parameters

Type	Name	Description
Bool	includeStoppedRecipients	Include recipients that are marked with stop.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Bool includeStoppedRecipients;
thing.SetIncludeStoppedRecipients(includeStoppedRecipients);

SetIsTemporarySelection(Bool)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetIsTemporarySelection(Bool isTemporarySelection)

Parameters

Type	Name	Description
Bool	isTemporarySelection	If true, the selection is a temporary selection that can be deleted later.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Bool isTemporarySelection;
thing.SetIsTemporarySelection(isTemporarySelection);

SetMailMergeDeliveryType(Integer)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetMailMergeDeliveryType(Integer mailMergeDeliveryType)

Parameters

Type	Name	Description
Integer	mailMergeDeliveryType	How the merged document is delivered to the recipients. See EMailMergeTargetType.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Integer mailMergeDeliveryType;
thing.SetMailMergeDeliveryType(mailMergeDeliveryType);

SetProjectId(Integer)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetProjectId(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId	Identity of project to use as source for recipients.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Integer projectId;
thing.SetProjectId(projectId);

SetRemoveCompanyInterest(Integer)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetRemoveCompanyInterest(Integer removeCompanyInterest)

Parameters

Type	Name	Description
Integer	removeCompanyInterest	Remove this company interest on each company recipient.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Integer removeCompanyInterest;
thing.SetRemoveCompanyInterest(removeCompanyInterest);

SetRemovePersonInterest(Integer)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetRemovePersonInterest(Integer removePersonInterest)

Parameters

Type	Name	Description
Integer	removePersonInterest	Remove this person interest on each person recipient.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Integer removePersonInterest;
thing.SetRemovePersonInterest(removePersonInterest);

SetSaveDocument(Bool)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetSaveDocument(Bool saveDocument)

Parameters

Type	Name	Description
Bool	saveDocument	Should we save a reference to the merge document on each recipient.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Bool saveDocument;
thing.SetSaveDocument(saveDocument);

SetSelectionId(Integer)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetSelectionId(Integer selectionId)

Parameters

Type	Name	Description
Integer	selectionId	Identity of selection to use as source for recipients.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Integer selectionId;
thing.SetSelectionId(selectionId);

SetSynchronous(Bool)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetSynchronous(Bool synchronous)

Parameters

Type	Name	Description
Bool	synchronous

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
Bool synchronous;
thing.SetSynchronous(synchronous);

SetTaskEntity(NSMailMergeSettings)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetTaskEntity(NSMailMergeTask taskEntity)

Parameters

Type	Name	Description
NSMailMergeTask	taskEntity	If specified, register a task on recipients using properties from this object.

Returns

Type	Description
Void

Examples

NSMailMergeSettings thing;
NSMailMergeTask taskEntity;
thing.SetTaskEntity(taskEntity);

SetTestOnly(Bool)

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

Declaration

Void SetTestOnly(Bool 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

Examples

NSMailMergeSettings thing;
Bool testOnly;
thing.SetTestOnly(testOnly);