Class MailMergeSettings

This class holds all settings needed to perform a document merge operation

Inheritance
System.Object
MailMergeSettings
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: SuperOffice.CRM.MailMerge
Assembly: SoDataBase.dll
Syntax
public class MailMergeSettings

Constructors

MailMergeSettings()

Declaration
public MailMergeSettings()

Properties

AddCompanyInterest

Add this company interest to each company recipient.

Declaration
public int AddCompanyInterest { get; set; }
Property Value
Type Description
System.Int32

AddPersonInterest

Add this person interest to each person recipient.

Declaration
public int AddPersonInterest { get; set; }
Property Value
Type Description
System.Int32

AlwaysUseCustomAttention

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

Declaration
public bool AlwaysUseCustomAttention { get; set; }
Property Value
Type Description
Boolean

CustomAttention

Custom value for attention.

Declaration
public string CustomAttention { get; set; }
Property Value
Type Description
System.String

CustomMailBody

If specified, use this value as default mail body.

Declaration
public string CustomMailBody { get; set; }
Property Value
Type Description
System.String

CustomMailSubject

If specified, use this value as default mail body.

Declaration
public string CustomMailSubject { get; set; }
Property Value
Type Description
System.String

DocumentId

Identity of document to be used as merge draft.

Declaration
public int DocumentId { get; set; }
Property Value
Type Description
System.Int32

ExtraInfo

Declaration
public string ExtraInfo { get; set; }
Property Value
Type Description
System.String

IncludeNoMailingsRecipients

Include recipients with no NoMailings

Declaration
public bool IncludeNoMailingsRecipients { get; set; }
Property Value
Type Description
Boolean

IncludeRetiredRecipients

Include recipients marked as retired

Declaration
public bool IncludeRetiredRecipients { get; set; }
Property Value
Type Description
Boolean

IncludeStoppedRecipients

Include recipients that are marked with stop

Declaration
public bool IncludeStoppedRecipients { get; set; }
Property Value
Type Description
Boolean

IsTemporarySelection

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

Declaration
public bool IsTemporarySelection { get; set; }
Property Value
Type Description
Boolean

MailMergeDeliveryType

How the merged document is delivered to the recipients.

Declaration
public EMailMergeTargetType MailMergeDeliveryType { get; set; }
Property Value
Type Description
EMailMergeTargetType

ProjectId

Identity of project to use as source for recipients.

Declaration
public int ProjectId { get; set; }
Property Value
Type Description
System.Int32

RemoveCompanyInterest

Remove this company interest on each company recipient.

Declaration
public int RemoveCompanyInterest { get; set; }
Property Value
Type Description
System.Int32

RemovePersonInterest

Remove this person interest on each person recipient.

Declaration
public int RemovePersonInterest { get; set; }
Property Value
Type Description
System.Int32

SaveDocument

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

Declaration
public bool SaveDocument { get; set; }
Property Value
Type Description
Boolean

SelectionId

Identity of selection to use as source for recipients.

Declaration
public int SelectionId { get; set; }
Property Value
Type Description
System.Int32

TaskEntity

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

Declaration
public MailMergeTask TaskEntity { get; set; }
Property Value
Type Description
MailMergeTask

TestOnly

If true, do the merge task, but use only current user as recipient, not selection members

Declaration
public bool TestOnly { get; set; }
Property Value
Type Description
Boolean

Extension Methods

EnumUtil.MapEnums<From, To>(From)