Class MailMergeSettings
Settings specifying what selection to perform the mailmerge on, what merge document to use etc.
Carrier object for MailMergeSettings. Services for the MailMergeSettings Carrier is available from the ISelectionAgent.
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class MailMergeSettings : CarrierConstructors
MailMergeSettings()
Default constructor
Declaration
public MailMergeSettings()Properties
AddCompanyInterest
Add this company interest to each company recipient.
Declaration
public virtual int AddCompanyInterest { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
AddPersonInterest
Add this person interest to each person recipient.
Declaration
public virtual int AddPersonInterest { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
AlwaysUseCustomAttention
Should custom attention always be used? If false, only use custom attention where there is no default.
Declaration
public virtual bool AlwaysUseCustomAttention { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
CustomAttention
Custom value for attention.
Declaration
public virtual string CustomAttention { get; set; }Property Value
| Type | Description |
|---|---|
| String |
CustomMailBody
If specified, use this value as default mail body.
Declaration
public virtual string CustomMailBody { get; set; }Property Value
| Type | Description |
|---|---|
| String |
CustomMailSubject
If specified, use this value as default mail subject.
Declaration
public virtual string CustomMailSubject { get; set; }Property Value
| Type | Description |
|---|---|
| String |
DocumentId
Identity of document to be used as merge draft.
Declaration
public virtual int DocumentId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
ExtraInfo
Used to store additional information for the delivery systems.
Declaration
public virtual string ExtraInfo { get; set; }Property Value
| Type | Description |
|---|---|
| String |
IncludeNoMailingsRecipient
Include recipients that are marked with NoMailings
Declaration
public virtual bool IncludeNoMailingsRecipient { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
IncludeRetiredRecipients
Include recipients that are marked as retired
Declaration
public virtual bool IncludeRetiredRecipients { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
IncludeStoppedRecipients
Include recipients that are marked with stop
Declaration
public virtual 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 virtual bool IsTemporarySelection { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
MailMergeDeliveryType
How the merged document is delivered to the recipients.
Declaration
public virtual EMailMergeTargetType MailMergeDeliveryType { get; set; }Property Value
| Type | Description |
|---|---|
| SuperOffice.Data.EMailMergeTargetType |
ProjectId
Identity of project to use as source for recipients.
Declaration
public virtual int ProjectId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
RemoveCompanyInterest
Remove this company interest on each company recipient.
Declaration
public virtual int RemoveCompanyInterest { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
RemovePersonInterest
Remove this person interest on each person recipient.
Declaration
public virtual int RemovePersonInterest { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
SaveDocument
Should we save a reference to the merge document on each recipient.
Declaration
public virtual bool SaveDocument { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
SelectionId
Identity of selection to use as source for recipients.
Declaration
public virtual int SelectionId { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
Synchronous
Declaration
public virtual bool Synchronous { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
TaskEntity
If specified, register a task on recipients using properties from this object.
Declaration
public virtual MailMergeTask TaskEntity { get; set; }Property Value
| Type | Description |
|---|---|
| MailMergeTask |
TestOnly
If true, do the merge task, but use current user as target, instead of selection members
Declaration
public virtual bool TestOnly { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
ToString()
Returns the carrier contents as a formatted string.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String | The carrier contents. |
ToString(String)
Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.
Declaration
public string ToString(string prefix)Parameters
| Type | Name | Description |
|---|---|---|
| String | prefix | The line prefix (typically used for indenting) |
Returns
| Type | Description |
|---|---|
| String | The carrier contents. |