NSMailMergeSettings - SuperOffice

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

Constructors

NSMailMergeSettings()

NSMailMergeSettings

Initializes a new instance of the NSMailMergeSettings class.

Methods

GetAddCompanyInterest()

Adds this company interest to each company recipient.

Integer GetAddCompanyInterest()

Returns: CRMScript.Global.Integer Example:

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

GetAddPersonInterest()

Adds this person interest to each person recipient.

Integer GetAddPersonInterest()

Returns: CRMScript.Global.Integer Example:

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

GetAlwaysUseCustomAttention()

Bool GetAlwaysUseCustomAttention()

Returns: CRMScript.Global.Bool - Should custom attention always be used? If false, only use custom attention where there is no default. Example:

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

GetCustomAttention()

String GetCustomAttention()

Returns: CRMScript.Global.String - Custom value for attention. Example:

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

GetCustomMailBody()

String GetCustomMailBody()

Returns: CRMScript.Global.String - If specified, use this value as default mail body. Example:

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

GetCustomMailSubject()

String GetCustomMailSubject()

Returns: CRMScript.Global.String - If specified, use this value as default mail subject. Example:

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

GetDocumentId()

Integer GetDocumentId()

Returns: CRMScript.Global.Integer - Identity of document to be used as merge draft. Example:

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

GetExtraInfo()

String GetExtraInfo()

Returns: CRMScript.Global.String - Used to store additional information for the delivery systems. Example:

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

GetIncludeNoMailingsRecipient()

Bool GetIncludeNoMailingsRecipient()

Returns: CRMScript.Global.Bool - Include recipients that are marked with NoMailings. Example:

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

GetIncludeRetiredRecipients()

Bool GetIncludeRetiredRecipients()

Returns: CRMScript.Global.Bool - Include recipients that are marked as retired. Example:

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

GetIncludeStoppedRecipients()

Include recipients that are marked with stop

Bool GetIncludeStoppedRecipients()

Returns: CRMScript.Global.Bool Example:

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

GetIsTemporarySelection()

Bool GetIsTemporarySelection()

Returns: CRMScript.Global.Bool - If true, the selection is a temporary selection that can be deleted later. Example:

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

GetMailMergeDeliveryType()

Integer GetMailMergeDeliveryType()

Returns: CRMScript.Global.Integer - How the merged document is delivered to the recipients. See <xref href=“CRMScript.NetServer.EMailMergeTargetType” data-throw-if-not-resolved=“false”></xref> Example:

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

GetProjectId()

Integer GetProjectId()

Returns: CRMScript.Global.Integer - Identity of project to use as source for recipients. Example:

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

GetRemoveCompanyInterest()

Integer GetRemoveCompanyInterest()

Returns: CRMScript.Global.Integer - Remove this company interest on each company recipient. Example:

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

GetRemovePersonInterest()

Integer GetRemovePersonInterest()

Returns: CRMScript.Global.Integer - Remove this person interest on each person recipient. Example:

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

GetSaveDocument()

Bool GetSaveDocument()

Returns: CRMScript.Global.Bool - Should we save a reference to the merge document on each recipient. Example:

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

GetSelectionId()

Integer GetSelectionId()

Returns: CRMScript.Global.Integer - Identity of selection to use as source for recipients. Example:

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

GetSynchronous()

Bool GetSynchronous()

Returns: CRMScript.Global.Bool Example:

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

GetTaskEntity()

NSMailMergeTask GetTaskEntity()

Returns: CRMScript.NetServer.NSMailMergeTask - If specified, register a task on recipients using properties from this object. Example:

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

GetTestOnly()

Bool GetTestOnly()

Returns: CRMScript.Global.Bool - If true, do the merge task, but use current user as target, instead of selection members. Example:

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

SetAddCompanyInterest(Integer)

Adds this company interest to each company recipient.

Void SetAddCompanyInterest(Integer addCompanyInterest)

Returns: CRMScript.Global.Void Example:

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

SetAddPersonInterest(Integer)

Adds this person interest to each person recipient.

Void SetAddPersonInterest(Integer addPersonInterest)

Returns: CRMScript.Global.Void Example:

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

SetAlwaysUseCustomAttention(Bool)

Void SetAlwaysUseCustomAttention(Bool alwaysUseCustomAttention)

Returns: CRMScript.Global.Void Example:

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

SetCustomAttention(String)

Void SetCustomAttention(String customAttention)

Returns: CRMScript.Global.Void Example:

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

SetCustomMailBody(String)

Void SetCustomMailBody(String customMailBody)

Returns: CRMScript.Global.Void Example:

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

SetCustomMailSubject(String)

Void SetCustomMailSubject(String customMailSubject)

Returns: CRMScript.Global.Void Example:

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

SetDocumentId(Integer)

Void SetDocumentId(Integer documentId)

Returns: CRMScript.Global.Void Example:

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

SetExtraInfo(String)

Void SetExtraInfo(String extraInfo)

Returns: CRMScript.Global.Void Example:

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

SetIncludeNoMailingsRecipient(Bool)

Void SetIncludeNoMailingsRecipient(Bool includeNoMailingsRecipient)

Returns: CRMScript.Global.Void Example:

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

SetIncludeRetiredRecipients(Bool)

Void SetIncludeRetiredRecipients(Bool includeRetiredRecipients)

Returns: CRMScript.Global.Void Example:

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

SetIncludeStoppedRecipients(Bool)

Void SetIncludeStoppedRecipients(Bool includeStoppedRecipients)

Returns: CRMScript.Global.Void Example:

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

SetIsTemporarySelection(Bool)

Void SetIsTemporarySelection(Bool isTemporarySelection)

Returns: CRMScript.Global.Void Example:

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

SetMailMergeDeliveryType(Integer)

Void SetMailMergeDeliveryType(Integer mailMergeDeliveryType)

Returns: CRMScript.Global.Void Example:

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

SetProjectId(Integer)

Void SetProjectId(Integer projectId)

Returns: CRMScript.Global.Void Example:

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

SetRemoveCompanyInterest(Integer)

Void SetRemoveCompanyInterest(Integer removeCompanyInterest)

Returns: CRMScript.Global.Void Example:

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

SetRemovePersonInterest(Integer)

Void SetRemovePersonInterest(Integer removePersonInterest)

Returns: CRMScript.Global.Void Example:

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

SetSaveDocument(Bool)

Void SetSaveDocument(Bool saveDocument)

Returns: CRMScript.Global.Void Example:

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

SetSelectionId(Integer)

Void SetSelectionId(Integer selectionId)

Returns: CRMScript.Global.Void Example:

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

SetSynchronous(Bool)

Void SetSynchronous(Bool synchronous)

Returns: CRMScript.Global.Void Example:

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

SetTaskEntity(NSMailMergeSettings)

Void SetTaskEntity(NSMailMergeTask taskEntity)

Returns: CRMScript.Global.Void Example:

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

SetTestOnly(Bool)

Void SetTestOnly(Bool testOnly)

Returns: CRMScript.Global.Void Example:

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

​Constructors

​NSMailMergeSettings()

​Methods

​GetAddCompanyInterest()

​GetAddPersonInterest()

​GetAlwaysUseCustomAttention()

​GetCustomAttention()

​GetCustomMailBody()

​GetCustomMailSubject()

​GetDocumentId()

​GetExtraInfo()

​GetIncludeNoMailingsRecipient()

​GetIncludeRetiredRecipients()

​GetIncludeStoppedRecipients()

​GetIsTemporarySelection()

​GetMailMergeDeliveryType()

​GetProjectId()

​GetRemoveCompanyInterest()

​GetRemovePersonInterest()

​GetSaveDocument()

​GetSelectionId()

​GetSynchronous()

​GetTaskEntity()

​GetTestOnly()

​SetAddCompanyInterest(Integer)

​SetAddPersonInterest(Integer)

​SetAlwaysUseCustomAttention(Bool)

​SetCustomAttention(String)

​SetCustomMailBody(String)

​SetCustomMailSubject(String)

​SetDocumentId(Integer)

​SetExtraInfo(String)

​SetIncludeNoMailingsRecipient(Bool)

​SetIncludeRetiredRecipients(Bool)

​SetIncludeStoppedRecipients(Bool)

​SetIsTemporarySelection(Bool)

​SetMailMergeDeliveryType(Integer)

​SetProjectId(Integer)

​SetRemoveCompanyInterest(Integer)

​SetRemovePersonInterest(Integer)

​SetSaveDocument(Bool)

​SetSelectionId(Integer)

​SetSynchronous(Bool)

​SetTaskEntity(NSMailMergeSettings)

​SetTestOnly(Bool)

Constructors

NSMailMergeSettings()

Methods

GetAddCompanyInterest()

GetAddPersonInterest()

GetAlwaysUseCustomAttention()

GetCustomAttention()

GetCustomMailBody()

GetCustomMailSubject()

GetDocumentId()

GetExtraInfo()

GetIncludeNoMailingsRecipient()

GetIncludeRetiredRecipients()

GetIncludeStoppedRecipients()

GetIsTemporarySelection()

GetMailMergeDeliveryType()

GetProjectId()

GetRemoveCompanyInterest()

GetRemovePersonInterest()

GetSaveDocument()

GetSelectionId()

GetSynchronous()

GetTaskEntity()

GetTestOnly()

SetAddCompanyInterest(Integer)

SetAddPersonInterest(Integer)

SetAlwaysUseCustomAttention(Bool)

SetCustomAttention(String)

SetCustomMailBody(String)

SetCustomMailSubject(String)

SetDocumentId(Integer)

SetExtraInfo(String)

SetIncludeNoMailingsRecipient(Bool)

SetIncludeRetiredRecipients(Bool)

SetIncludeStoppedRecipients(Bool)

SetIsTemporarySelection(Bool)

SetMailMergeDeliveryType(Integer)

SetProjectId(Integer)

SetRemoveCompanyInterest(Integer)

SetRemovePersonInterest(Integer)

SetSaveDocument(Bool)

SetSelectionId(Integer)

SetSynchronous(Bool)

SetTaskEntity(NSMailMergeSettings)

SetTestOnly(Bool)