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

MailingStruct

 

The MailingStruct defines a mailing.

 

Name

Type

Description

AdditionalHeaders

string

Any addtional headers (e.g., X-type headers)

Attachments

string

Any attachments.

The syntax for using this element is:

 

'Attachments' => '{foo 2003 times.txt}'

 

where times.txt is the name of the attached file, and 2003 is the value for 'uniqueid_' in the 'docparts_' table. "Foo" is simply a placeholder and can be replaced with any string you choose.

Note that both the quotes and the curly brackets are significant. Using 'foo 2003 times.txt' instead of '{foo 2003 times.txt}' will cause the SOAP server to reply with an error.

BypassModeration

boolean

If true, the mailing may bypass moderation

Campaign

string

What campaign the mailing should belong to

CharSetID

int

The ID of the charset for this mailing (from CharSetStruct)

DetectHtml

boolean

If true, the mailing should detect if the recipient has the ability to read HTML

DontAttemptAfterDate

dateTime

The "kill date" after which this mailing should no longer be delivered

EnableRecency

boolean

If true, recency checking should be done for this mailing

From

string

The header "From:"

HtmlMessage

string

The HTML portion of the mailing

HtmlSectionEncoding

int

The HTML message encoding

IsHtmlSectionEncoded

boolean

If true, the HTML portion of the mailing has been encoded

IsTextSectionEncoded

boolean

If true, the text portion of the mailing has been encoded

ListName

string

The list this mailing is posted to

RecencyNumberOfMailings

int

If enabled, the number of mailings that should trigger recency limits.

RecencyWhich

string

When checking for recency, should the number of mailings be more than, equal to or less than the number in RecencyNumberof Mailings (from RecencyWhichEnum)

ReplyTo

string

The "Reply To:" header

ResendAfterDays

int

If set, means that when the message is approved, it should be resubmitted for automatic approval after so many days

SampleSize

int

The maximum number of recipients to receive this mailing. If not set, there is no maximum

ScheduledMailingDate

dateTime

The date and time the mailing is scheduled to be sent

Subject

string

The "Subject:" header

TextMessage

string

The text portion of the mailing

TextSectionEncoding

int

The encoding of the text section

Title

string

The title of the mailing

To

string

The "To:" header

TrackOpens

boolean

If true, this mailing should detect if recipients open it

RewriteDateWhenSent

boolean

If true, the mailing should have its "Date:" header rewritten to be the time it was actually sent, removing the original "Date:" header

 

NOTES

 

 



ListStruct MemberStruct