You are here: Type Reference > Classes and Structs > ListStruct

ListStruct

 

The ListStruct describes all of the parameters for a particular list.

 

Name

Type

Description

Notes

ListID

int

The unique identifier for this list

 

Additional

string

Additional information about this list (not used by ListManager)

 

AddListNameToSubject

boolean

If true, adds the list's name to the "Subject:" header

 

Admin

string

Administrator responsible for this list

 

AllowCrossPosting

boolean

If true, this list should accept cross-posted messages (identical messages sent to multiple lists)

 

AllowDuplicatePosts

boolean

If true, this list should accept duplicate messages

 

AllowInfo

boolean

If true, this list should allow non-members to read information about it

 

AnyoneCanPost

boolean

If true, this list should allow anyone to post; if false, it requires those who post to be members

 

ApproveNum

int

The number of approvals required of new members before they may post to the list without moderation

 

ArchiveDays

int

The number of days archived messages are kept

 

ArchiveNum

int

The number of archived messages kept

 

AutoReleaseHour

int

The time of day messages should be automatically approved and released

 

BlankSubjectOk

boolean

If true, the list should permit messages with blank "Subject:" headers

 

Child

boolean

If true, this list should accept postings from other lists

 

CleanAuto

boolean

If true, this list should automatically put members who bounce too much mail on hold

 

CleanNotif

int

The length of time (days) a "held" member will be notified

 

Comment

string

Additional information about this list (not used by ListManager)

 

CommentsID

string

Comment about this list (links to a document)

 

ConfirmSubscribes

boolean

Whether this list should confirm new subscriptions

 

ConfirmUnsubscribes

ConfirmUnsubEnum

Whether this list should confirm unsubscribes

 

DateCreated

dateTime

The date and time this list was created

 

DefaultFrom

string

The default "From:" header

 

DefaultSubject

string

The default "Subject:" header

 

DefaultTo

string

The default "To:" header

 

DeliveryReports

int

What delivery reports should be sent to administrators

 

DescLongDocID

string

Long description of this list (links to a document)

 

DetectHtmlByDefault

boolean

If true, this list should detect HTML capability by default

 

DetectOpenByDefault

boolean

If true, this list should detect HTML opens by default

 

DigestFooter

string

The digest footer

 

DigestHeader

string

The digest header

 

Disabled

boolean

If true, this list is disabled

 

DontRewriteMessageIDHeader

boolean

If true, ListManager will not rewrite the Message-ID, but instead leave it alone, and use X-Lyris-Message-ID

 

EnableScripting

EnableScriptingEnum

What level of scripting the list allows

 

ErrHold

int

How many bounces before a member is put on hold

 

From

string

If set, specifies the "From:" header of every message send on this list

 

HeaderRemove

string

Which headers should be removed

 

KeepOutmailPostings

int

How long mailings sent to the list should be kept

 

Keywords

string

Keywords which describe this list

 

ListName

string

The name of the list

 

MakePostsAnonymous

boolean

If true, posts to this list will be anonymous

 

MaxMembers

int

The maximum number of members this list is allowed

 

MaxMessageSize

int

The maximum size, in bytes, non-administrators may post to the list

 

MaxMessNum

int

The maximum number of messages that may be sent through the list in a 24-hour period

 

MaxPostsPerUser

int

The maximum number of posts a single person may post to the list

 

MaxQuoting

int

The maximum number of contiguous lines that may be quoted at once in a single message

 

MemberListSecurity

MemberListSecurityEnum

Who may access the list of members

 

MergeCapOverride

MergeCapOverrideEnum

Whether this list should override the server scripting levels

 

MessageFooter

string

The default message footer

 

MessageHeader

string

The default message header

 

Moderated

ModeratedEnum

What level of moderation this list requires

 

ModifyHeaderDate

boolean

Whether the "Date:" header should automatically be rewritten to be the date and time a message is approved

 

MRIVisibility

MRIVisibilityEnum

Whether the Discussion Forum Interface for this list should be (v)isible, (h)idden or (i)nvisible

 

NameRequired

NameRequiredEnum

Whether the subscriber must provide a name when joining

 

NewSubscriberSecurity

NewSubscriberPolicyEnum

What security controls who may join the list

 

NoArchive

boolean

If true, this list maintains a message archive

 

NoBodyOk

boolean

If true, messages posted to this list may be blank

 

NoEmail

boolean

If true, this list rejects messages posted via email, and requires postings through the ListManager web interface

 

NoEmailSubscriptions

boolean

If true, this list prohibits subscriptions via email, and requires them through the ListManager web interface

 

NoListHeader

boolean

If true, the list-help headers should not be included

 

NoNNTP

boolean

If true, the list will not be accessible via NNTP

 

NoSearch

boolean

If true, the list's archives, if available, will not be searchable

 

NotifyHeldInterval

int

How frequently held members should be notified

 

OnlyAllowAdminSend

boolean

If true the list will only allow administrators to send

 

PasswordRequired

int

Whether a password is required when joining

 

PostPassword

PostPasswordEnum

Whether a member's password must be included in the message in order to be posted

 

PrivApprov

string

Sets rules for automatically approving applications to a private list

 

PurgeExpiredInterval

int

How long expired members should be kept in the database before being purged, in days

 

PurgeHeldInterval

int

How long held members should be kept in the database before being purged, in days

 

PurgeReferredInterval

int

How long referred members should be kept in the database before being purged, in days

 

PurgeUnapprovedInterval

int

How long unapproved members should be kept in the database before being purged, in days

 

PurgeUnconfirmedInterval

int

How long unconfirmed members should be kept in the database before being purged, in days

 

PurgeUnsubInterval

int

How long unsubscribed members should be kept in the database before being purged, in days

 

RecencyDayCount

int

How many days to check for recent mailings

 

RecencyEmailEnabled

boolean

If ture, recency checking/purging is enabled

 

RecencyMailCount

int

The number of mailings that should trigger recency limits

 

RecencyOperator

RecencyOperatorEnum

When checking for recency, should the number of mailings be (m)ore than, (e)qual to or (l)ess than the number in RecencyMailCount

 

RecencySequentialEnabled

boolean

If true, recency limits should be applied to sequential mailings

 

RecencyTriggeredEnabled

boolean

If true, recency limits should be applied to triggered mailings

 

RecencyWebEnabled

boolean

If true, recency limits should be applied to web mailings

 

RecipientLoggingLevel

LoggingLevelEnum

What level of delivery logging should there be? (N)o logging, non-SMTP errors (m), all (e)rrors, errors and successes (f)

 

ReferralsPerDay

int

The number of referrals allowed per member per day

 

ReleasePending

int

The length of time unapproved messages should be kept before being sent automatically

 

RemoveDuplicateCrossPostings

boolean

If true, if a list allows cross-postings, it should clean out duplicate recipients so that members of multiple lists only receive one copy of a message

 

ReplyTo

string

The "Reply-To:" header

 

RunProgAfterPosting

string

Program to execute after posting

 

RunProgAfterSub

string

Program to execute after subscribing

 

RunProgAfterUnsub

string

Program to execute after unsubscribing

 

RunProgBeforePosting

string

Program to execute before posting a message

 

RunProgBeforeSub

string

Program to execute before processing a subscribe

 

RunProgBeforeUnsub

string

Program to execute before processing an unsubscribe

 

ScriptingLevel

ScriptingLevelEnum

What level of scripting should this list allow

 

ShortDescription

string

A short description of this list

 

SimpleSub

boolean

If true, this list should only allow name, email address, or allow members to set other options (such as noack, norepro)

 

SMTPFrom

string

The SMTP "MAIL FROM:" header

 

SMTPHeaders

string

Text that should be included in the SMTP header of every message

 

SponsOrgID

string

Organization that is sponsoring this list (link to document, type is organization)

 

SubscribePassword

string

If this list is 'password' protected for new subscribers, what is the password?

 

SubscriptionReports

SubscriptionReportEnum

What subscription reports should be emailed to list administrators?

 

To

string

The default "To:" header

 

Topic

char

The category the mailing list belongs to.

** New in v.1.5.1

Visitors

boolean

If true, the list should allow non-members to see messages in the Discussion Forum Interface

 

 

Note: Since Microsoft .NET does not support NULL date/times, the date/time "2001-01-01 00:00:00" is considered null.

 

 

 

 

 

 

 

 

 



KeyValueType MailingStruct