MailingService
The following operations are supported. For a formal definition, please review the Service Description.
-
Add
Add a new mailing to send at an undetermined date. Returns MessageID as Integer. Note: Must call Send(MessageID) function to send mailing. -
AddToSendLater
Add a new mailing to send later. Returns MessageID as Integer. -
AddToSendNow
Add a new mailing to send now. Returns MessageID as Integer. -
ApprovalMailExists
Check if a draft (unscheduled) mailing exists. -
DeleteApprovalMail
Delete mailing in draft (unscheduled) queue. -
DeleteSentMail
Delete email that has already been sent. -
ListDeliveredMailings
List delivered mail recipients for a mailing.
CompletionStatusID value descriptions:
300 - The mail was sent successfully.
301 - The destination mail server reported a temporary failure error code (between 400 - 499).
302 - The destination mail server reported a permanent failure error code (500+).
303 - A temporary DNS failure occurred.
304 - The domain is reported to be bad via DNS.
305 - A bounce was received for this recipient.
306 - An attempt was made to send to an email address (rather than a contact/member ID) and that address is not syntactically valid.
307 - The message to send for this recipient was deleted from the database.
308 - The expiration date to send the mailing was reached before all attempts were completed.
309 - The recipient was not sent to because the mailing was stopped by an administrator.
310 - The recipient was not processed due to the skip command in mailmerge.
311 - The recipient was not sent to because the mailing was stopped during mail merging by the 'abort' command. -
ListInProgressRecipients
List in progress mail recipients for a mailing.
StatusID value descriptions:
0 - Recipient has not been attempted.
301 - The destination mail server reported a temporary failure error code (between 400 - 499).
303 - A temporary DNS failure occurred. -
ListMailingStatistics
Return statistics for a MailingID. Table of codes:300 The mail was sent successfully. 301 The destination mail server reported a temporary failure error code (between 400 - 499). 302 The destination mail server reported a permanent failure error code (500+). 303 A temporary DNS failure occurred. 304 The domain is reported to be bad via DNS. 305 A bounce was received for this recipient. 306 An attempt was made to send to an email address (rather than a contact/member ID) and that address is not syntactically valid. 307 The message to send for this recipient was deleted from the database. 308 The expiration date to send the mailing was reached before all attempts were completed. 309 The recipient was not sent to because the mailing was stopped by an administrator. 310 The recipient was not processed due to the skip command in mailmerge. 311 The recipient was not sent to because the mailing was stopped during mail merging by the 'abort' command. -
ListMailingsForApproval
List draft (unscheduled) mailings. -
ListScheduledMailings
List mailings that are scheduled to send at a later date. -
ListSentMailings
List mailings that have been sent. -
ListSentMailingsSummary
Return a summary of all mailings and their completion status in a given date range. -
ListTrackingSummary
Return a summary of open and clicktracking for all mailings in a given date range. -
LoadMailingForApproval
Load one draft (unscheduled) mailing. -
LoadSentMailing
Load one mailing that has already been sent. -
ScheduleSend
Schedule an existing mailing to send at a later date. -
ScheduleSendWithSendTimeOptimization
Schedule an existing mailing to send at a later date with Send Time Optimization. The mailing will be sent to the recipient based on when they are most likely to engage. Recipients will be sent to over the 24-hour period following the send date. -
ScheduleSendWithTimeZoneSending
Schedule an existing mailing to send at a later date with Time Zone Sending. Must be scheduled at least 24 hours into the future. If time zone is unknown, the default will be time zone set for account. -
Send
Send an existing mailing now. -
SendSpamTest
Send a spam test mailing to a reciepient. Returns the ModerateID for the new test mailing. -
SendTest
Send a test mailing to a reciepient. Returns the ModerateID for the new test mailing. -
SentMailExists
Check if a sent mailing exists.