edmservice.mtrmail.net
Open in
urlscan Pro
202.67.170.227
Public Scan
URL:
https://edmservice.mtrmail.net/
Submission: On August 23 via automatic, source certstream-suspicious — Scanned from DE
Submission: On August 23 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
Service
The following operations are supported. For a formal definition, please review
the Service Description.
* ActivationCampaignByFtpFile
Activation campaign by ftp file.
Arguments:
loginEmail: Login Email of Spread.
loginPassword: Login Password of Spread.
fileType: Type of upload data, include ".xls", ".csv", ".xlsx"
ContactListName: the name of contact list .
campaignId: Need to be activated by the campaignId
ftpIp: Ftp IP
ftpUser: Ftp User
ftpPassword: Ftp Password
ftpFilePath: Ftp FilePath
return: result
* AddOrUpdateWebhook
Add Webhook Event .
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
Event: Webhook event type.
enable: set status true or false.
return execute result
* AddSenderEmail
Add Sender Email .
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
SenderEmail: New Sender Email To Add.
return true if success.
* ChangePublishStatus
Publish or not publish Newsletters
* CreateCampaignBySimpleType
Create a new email campaign and send it out.
* CreateNewAccount
Create a new account.(This method is only for reseller.)
Arguments:
loginEmail: Login Email of Spread.
loginPassword: Login Password of Spread.
newAccountName: New account name
newAccountEmail: New account email
newAccountPassword:New account password
return true if succeed.
* DeleteCampaign
Delete the campaigns.
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password or APIKey of Spread.
campaignID: Campaign ID.
return true if success.
* DeleteSenderEmail
Delete Sender Email.
Arguments:
loginEmail: Login Email of Spread.
APIKey: API KEY of Spread.
senderEmail: The Sender Email to be deleted.
return true if success.
* DeleteSubscribersFromAccount
Delete subscribers from account.
Arguments:
loginEmail: Spread account.
password: APIKEY/Password of Spread.
subscriberEmails: Array of Subscriber's emails.
* DeleteSubscribersFromList
Delete subscribers from contact list.
Arguments:
loginEmail: Spread accpunt.
password: Password of Spread.
subscriberEmails: Array of Subscriber's emails
subscription: Delete from which contat list.
* DeleteSubscription
Delete the subscription.
Arguments:
loginEmail: Login Email of Spread.
APIKey: API Key of Spread.
subscriptionID: The ID of Subscription
return true if succeed.
* EmailExists
Validate Email exists(This method is only for reseller.)
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
accountEmail:New account name
return: true if exists.Otherwise,false
* EmailSend
Send email , return email id
* ExcludeContactList
Set exclude lists to a campaign.
Arguments:
LoginEmail: Login Email of Spread.
Password: Login Password of Spread.
CampaignNamedListName:The name of campaign
ExcludeLists: Name of contact list.if more than one list,use ";" as
seperator.e.g. listA;listB;listC
return count of list excluded.
* ExcludeContacts
(Exclude Contacts List.)
loginEmail: Login Email Of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
contacts: contacts list.
excludes: excludes contacts list.
* ExcludeContactsByDomain
(Exclude Contacts List by domain.)
loginEmail: Login Email Of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
contacts: contacts list.
domain: domain
* ExcludeContactsByNetEase
(Exclude Contacts List by NetEase.)
loginEmail: Login Email Of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
contacts: contacts list.
isNetEase: is it net ease
* GetAPIKey
Get APIKey
Arguments:
loginEmail: Login Email of Spread.
loginPassword: Login Password of Spread.
return:APIKey
* GetAccessToken
Get access token
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
return:access token
* GetAccountInfo
Get Account detail information
Arguments:
loginEmail: Login Email of Spread.
loginPassword: Login Password of Spread.
return:table
column:EmailCredit,SentCount,MaxSubscriber,CurrentSubscribers,ExpiryDate,Status
* GetAccountUnsubscribes
Get Unsubscribe report in a period of time for a account.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
startDate:Starting time
endDate:End time
return dataset.
Dataset Columns:
subscriber_email, date
* GetAccountUnsubscribesToFtp
Get Unsubscribe report in a period of time for a account.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
startDate:Starting time
endDate:End time
return string.
String message:
success or fail
* GetCampaignAbuses
Get abuse report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
startDate:Starting time
endDate:End time
return dataset.
Dataset Columns:
subscriber_email, date
* GetCampaignBounces
Get Bounces report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
startDate:Starting time
endDate:End time
return dataset.
Dataset Columns:
subscriber_email,type_name,chkdate
* GetCampaignClicks
Get clicks report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
startDate:Starting time
endDate:End time
return dataset.
Dataset Columns:
subscriber_email,date_clicked ,url
* GetCampaignClicksWithName
Get clicks report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
startDate:Starting time
endDate:End time
return dataset.
Dataset Columns:
subscriber_email,date_clicked ,url,first_name,middle_name,last_name
* GetCampaignConversions
Get Conversion report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
startDate:Starting time
endDate:End time
return dataset.
Dataset Columns:
subscriber_email, conversion_time,value,type,url
* GetCampaignConvertions
Please use GetCampaignConversions instead.
* GetCampaignDetailReport
Get campaign detail report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
campaignID:campaign id
subscriberEmail:subscriber Email,get subscriber sent status
return dataset.
Dataset Columns:
* GetCampaignOpens
Get campaignopen report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
campaignID: campaignIDstartDate:Starting time
endDate:End time
return dataset.
* GetCampaignOpensByPage
Get campaignopen report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
campaignID: campaignIDstartDate:Starting time
endDate:End time
return dataset.
* GetCampaignOpensJson
Get campaignopen report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
campaignID: campaignIDstartDate:Starting time
endDate:End time
return json.
* GetCampaignOpensWithName
Get open report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
startDate:Starting time
endDate:End time
return dataset.
Dataset Columns:
subscriber_email, email_opening_time,first_name,middle_name,last_name
* GetCampaignSents
Get send report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
startDate:Starting time
endDate:End time
return dataset.
Dataset Columns:
subscriber_email, isSuccess,sending_status_time
* GetCampaignSubscriberDetail
GetCampaignSubscriberDetail
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
subscriber_email: The email of subscriber.
campaign_id: The ID of campaign.
return dataset.
Dataset Columns:
Credit,Sent,ExpiryDate
* GetCampaignUnsubscribes
Get Unsubscribe report in a period of time for a campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
startDate:Starting time
endDate:End time
return dataset.
Dataset Columns:
subscriber_email, date
* GetCampaigns
Get the Information of Campaigns.
Arguments:
loginEmail: Login Email of Spread.
APIKey: AP IKey of Spread.
pageNumber: The index of page.
pageSize: The size of page.
return dateset result.
* GetCampaignsSend2TalkkingUser
For TalkKing,Get Campaigns send to TalkKing Users that campaign's
scheduleTime during [@startTime, @endTime).The timespan between @startTime
and @endTime shouldn't be greater then 1 hour.
* GetDateRangeSubscribers
Get specified status's subscribers in subscription.
Arguments:
loginEmail: Login Email of Spread.
APIKey: APIKey of Spread API.
subscription: Subscription Name
status: subscriber status, the text contains "Any" or "Deleted" or "Active"
or "Unsubscribed" or "Unconfirmed" or "Undeliverable" or "SpamReporter" or
"DoNotMail" or "Blacklist", which is splited with ",".
startDate: Starting time, you can set the value like "1 Jan 2019 00:00:00" or
"2019-01-01 00:00:00".
endDate: End Time, the format is like startDate.
return dataset.
Dataset Columns:
subscriber_email,Status
* GetEmailStatus
Get email status(Request\Delivered\Opened\Clicked\Bounce\SPAM\Invalid)
Return emailId$status (123-456$Opened)
LoginEmail: Login Email of Spread.
Password: Login Password of Spread.
EmailIds: EmailId, semicolon(;) as delimiter.
* GetNetEaseRank
(get NetEase Rank)
loginEmail: Login Email Of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
* GetSMSStatus
Get SMS status (0: unsuccessfully \ 1: successfully)
Return Phone number$status (85212345678$1)
LoginEmail: Login Email of Spread.
Password: Login Password of Spread.
CampaignId: Campaign id
* GetSenderEmails
Get All Sender Email.
Arguments:
loginEmail: Login Email of Spread account.
APIKey: API Key of Spread.
return dataset result.
* GetSmsReplies
Get Sms Replies
Arguments:
loginEmail: Login Email of Spread.
APIKey: The APIKey of your Spread account which you can retrieve from your
Spread account (My account=> Settings).
campaignId: Campaign Id
return table, column: phone\content\time.
* GetSubscriberDetail
GetSubscriberDetail
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
subscriber_email: The email of subscriber.
return dataset.
Dataset Columns:
Credit,Sent,ExpiryDate
* GetSubscriberReport
Get the Report of an Email Subscriber.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
* GetSubscribers
Get specified status's subscribers in subscription.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
subscription: Subscription Name
status: subscriber status
return dataset.
Dataset Columns:
subscriber_email,Status
* GetUploadRequestStatus
GetUploadRequestStatus
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
RequestID: The request of SpreadWebServcie.UploadContactListFile return .
return dataset.
Dataset Columns:
RequestID, UploadStatus(Complete or Error or Uploading), ContactList,
UploadTime, TotalCount, NewCount, DuplicateCount,DeletedCount, ExistingCount,
SpamCount, UnsubscribedCount, DoNotMailCount, UndeliverableCount,
asUnconfirmedCount, InvalidCount
* GetUserCredit
GetUserCredit
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
accountType: The type of account.
return dataset.
Dataset Columns:
Credit,Sent,ExpiryDate
* HelloWorld
* NameExists
Validate Name exists(This method is only for reseller.)
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
accountName:New account name
return: true if exists.Otherwise,false
* SearchContacts
Get if subscribers satified the conditions,it is only for internal use
currently
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
Criteria: A string represent the Conditions in Json Formate.
TopN: Quantity of subscribers needed
SaveAsList: Name of subscription to be created.if more than one list,use ";"
as seperator.e.g. listA;listB;listC
ForceCreate: TRUE or FALSE. When number of subscribers returned less than
TopN,if TRUE then will create new list and FALSE will not.
Return the number of subscribers that meet the condition.
Remark: This function is currently for internal use.
* Send
Send email one to one
* Send2
The same function as Send but you can set specify campaign name instead of
today as default campaign name.
Arguments:
LoginEmail: Login Email of Spread.
Password: The password of your Spread account or API Key which you can
retrieve from your Spread account (My account=> Settings).
CampaignName: The name of the campaign to be send.
From: The email address of sender.
FromName, The name of sender.
[To]: The email address of recipient.
Subject: The subject of the Email.
Body: The content of the Email.
Remarks: The maximum daily limit 20 different campaign Name.The contact will
be automatically added to the contact list named "Auto_ + Campaign Name".
This function allows duplicate sending, so the contact list may contains
duplicate email. Don't use this contact list in other campaigns, if you want
to avoid duplicate sending.
* Send3
The same function as Send but you can specify campaign name instead of today
as default campaign name.
* SendAndCc
Send email one to one contain cc
* SendBatch
Send Batch
* SendMTREmail
Send MTR Email with multi attachment .
Arguments:
return sent result （string).
Remarks: use POST method to submit your data
* SendSMS
Create a new sms campaign
Arguments:
loginEmail: Login Email of Spread.
APIKey: The APIKey of your Spread account which you can retrieve from your
Spread account (My account=> Settings).
SMSContent: The content of SMS campaign.
sender:The sender of SMS campaign.
schedule: The date of when to establish the email campaign.
campaignStatus: The status of the email campaign.
phoneSubscribers: An array of string contains the phone number added to this
email campaign.
category: An array of string contains the names of categories added to this
email campaign.
return campaignID.
* SendSimpleAttachment
send transactional email with 1 attachment.
Arguments:
loginEmail: Login Email of Spread.
password: Password or API KEY of Spread.
CampaignName: CampaignName
FromName: Display Name
[To]: The recipient
replyTo:Reply Email address
Subject: Email subject.
Body: Email body.
Attachment:The upload file stream
AttachmentName:Attachment display name (include extensions,for example
'file.zip')return sent result（string).
Remarks: use this method to send 1 attachment.
* SendTemplateAttachment
send transactional email with 1 attachment.
Arguments:
LoginEmail: Login Email of Spread account.
APIKey: API KEY of Spread.
[To]: The Recipient. attention: The recipient defined in the template
campaign will not be sent.
Subject: the email subject, it will be the campaign subject if empty.
TemplateId: Campaign ID.
SubstitutionVars: tag's value in the content.
CreativeLanguage: Creative Language.
Attachment:The upload file stream
AttachmentName:Attachment display name (include extensions,for example
'file.zip')
return sent result（string).
Remarks: use this method to send 1 attachment.
* SendTemplateAttachments
Send Email with multiple attachments .
Arguments:
LoginEmail: Login Email of Spread account.
APIKey: API KEY of Spread.
[To]: The Recipient. attention: The recipient defined in the template
campaign will not be sent.
Subject: the email subject, it will be the campaign subject if empty.
TemplateId: Campaign ID.
SubstitutionVars: tag's value in the content.
CreativeLanguage: Creative Language.
files:Attachment structure,only for file types below :zip pdf docx doc xlsx
xls rtf txt gif jpeg jpg png tif bmp ppt pptx
return sent result （string).
Remarks: use to send attachments.
* SendTemplateEmail
Send email by Template, return email id.
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or API Key which you can retrieve from your
Spread account (My account=> Settings).
MemberId. If there is no member id, please set 0.
Email: The email address of recipient.
TemplateId: The TemplateId(CampaignID) of email.
SubstitutionVars: It is a custom value of Json type. If there is a tag named
[CUSTOM] in campaign, then you can send : {"[CUSTOM]":"Value"} .
CreativeLanguage: language, such as : en,en-us,zh-tw,zh-cn.
Return email id.
Remarks: If you want to send the template, it should be approved.
* SendWithAttachment
Send Email with multi attachment .
Arguments:
loginEmail: Login Email of Spread.
password: Password or API KEY of Spread.
CampaignName: CampaignName
FromName: Display Name
[To]: The recipient
replyTo:Reply Email address
Subject: Email subject.
Body: Email body.
files:Attachment structure,only for file types below :zip pdf docx doc xlsx
xls rtf txt gif jpeg jpg png tif bmp ppt pptx
return sent result （string).
Remarks: use to send attachments.
* SendmultipleAttachment
Send Email with multi attachment .
Arguments:
loginEmail: Login Email of Spread.
password: Password or API KEY of Spread.
CampaignName: CampaignName
FromName: Display Name
[To]: The recipient
replyTo:Reply Email address
Subject: Email subject.
Body: Email body.
files:Attachment
return sent result （string).
Remarks: use POST method to submit your data
* SetCampaignDailyLimit
Setting Campaign DailyLimit(It is only for internal use currently.)
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
campaignID:The Campaign ID which you want to set.
return true if success.
* SetCampaignTimeLimit
Setting Campaign TimeLimit(It is only for internal use currently.)
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
campaignID: The Campaign ID which you want to set.
TimeSpan: Send time limit of campaign. format like: [ { '1':
['01:00-02:00','01:00-02:00'] }, { '2': ['01:00-02:00','01:00-02:00'] } ]
'0' means every day, '1': Monday, '2': Tuesday,'3': Wednesday, '4':
Thursday,'5': Friday, '6': Saturday, '7': Sunday
return true if success.
* SplitContactListByRange
SplitContactListByRange(It is only for internal use currently.)
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
SourceContactListName: The Contact List which you want to split.
Range: The Range of Contact List, format like: 0~10
TargetContactListName: The Contact List Which you want to insert.
return true if success.
* SplitContacts
Split the contact list.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
oldListName:The name of old list name
SaveAsList: Name of subscription to be created.if more than one list,use ";"
as seperator.e.g. listA;listB;listC
return true if succeed.
* TransferCredit
Transfer credit to another account.(This method is only for reseller.)
Arguments:
loginEmail: Login Email of Spread.
loginPassword: Login Password of Spread.
transferToEmail: Email of transfer credit to user
creditCount: Total amount of transfer credit
return true if succeed.
* UnsubscribeEmailInAccount
UnsubscribeEmailInAccount
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
subscriberEmail: The email of subscriber.
return true if success.
* UnsubscribeEmailInContactList
UnsubscribeEmailInContactList
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
subscriberEmail: The email of subscriber.
contactListName: The name of contactlist.
return true if success.
* UpdateBirthdayTriggerCampaignSubscriberBirthday
Update the existing birthday trigger campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password or API KEY of Spread.
CampaignId: CampaignId of the existing campaign.
SubscriberEmail: subscriber email
Birthday: Birthday.
return Birthday Trigger Logs.
* UpdateCampaignStatus
Create a new email campaign and campaign creatives .
Arguments:
loginEmail: Login Email of Spread.
APIKey: API Key of Spread.
campaignID: The ID of the email campaign.
campaignStatus: The status of the email campaign.
return true if succeed.
Remarks: If only the campaign is in "Sending" or "Waiting" can be updated to
"Pause", Or in "Pause" can be updated to "Waiting".
* UpdateMemberEmail
Update member email
* UpdateMemberOptIn
Email address of the subscriber who requested to opt-in.
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
MemberId: MemberId of member.
Return 1 means success, else return error message.
Remarks: use POST method to submit your data
* UpdateMemberOptOut
Email address of the subscriber who requested to opt-out.
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or API Key which you can retrieve from your
Spread account (My account=> Settings).
MemberId: MemberId of member.
Return 1 means success, else return error message.
Remarks: use POST method to submit your data
* UpdateMemberStatus
Email address of the subscriber who requested to opt-in.
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or API Key which you can retrieve from your
Spread account (My account=> Settings).
MemberId: MemberId of the subscriber.
Status: The status of member (Active, Frozen, Cancel).
AcceptPromotion: "Y" for opt-in, "N" for opt-out.
Return 1 means success, else return error message.
Remarks: use POST method to submit your data
* UpdateSubscription
Update the subscription.
Arguments:
loginEmail: Login Email of Spread.
APIKey: API Key of Spread.
subscriptionID: The ID of Subscription.
newSubscriptionName: New name of Subscription.
newDescription: New description of Subscription
return true if succeed.
* UploadContactListFile
Upload contact file .
Arguments:
loginEmail: Login Email of Spread.
loginPassword: Login Password of Spread.
fileType: Type of upload data, include ".xls", ".csv", ".xlsx"
fileStream: The upload file stream ( length<100MB )
ContactListName: the name of contact list .
return: result
* UploadSubscribersInfo
Add new/existing subscribers into a subscription.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
SubscriberArgs(): email, firstName, middleName, lastName, jobTitle, company,
homePhone, address1, address2, address3, city, state, country,postalCode,
subPostalCode, customField1, customField2, customField3.
subscription: The subscription where the subscriber being added.
optInType: Double Opt-In Option.
return ResponseResult containing error messages if any.
Remarks: Subscriber would receive confirmation email if user's Double Opt-in
option is ON.if the count of subscribers is larger than 100 , the subscribers
will be added in backgroud thread anda trackingId will be returned in
ResponseResult, or else save subscribers immediately and result can be viewed
in the errorDetails of ResponseResult for each subscribers
* UplodeZipFile
Upload zip files as mail contents.
Arguments:
loginEmail: Login Email of Spread.
loginPassword: Login Password of Spread.
fileStream: The zip file stream
campaignId: Campaign ID.If campaignid is nothing,create new campaign.
return true if succeed.
* VerifyAccessToken
Verify access token
Arguments:
emailAddress:The emailAddress of user
token: Access token
return true if succeed.
* addSubscriberByEmail
Add new/existing subscriber into a subscription.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
subscriberEmails: Subscriber's emails to be deleted.
subscription: The subscription where the subscriber being added.
optInType: Double Opt-In Option.
return true if the subscriber need to be confirmed.
Remarks: Subscriber would receive confirmation email if user's Double Opt-in
option is ON.
* addSubscriberByInfo
Add new/existing subscriber into a subscription.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
SubscriberArgs: email, firstName, middleName, lastName, jobTitle, company,
homePhone, address1, address2, address3, city, state, country,postalCode,
subPostalCode, customField1, customField2, customField3.
subscription: The subscription where the subscriber being added.
optInType: Double Opt-In Option.
return true if the subscriber need to be confirmed.
Remarks: Subscriber would receive confirmation email if user's Double Opt-in
option is ON.
* addSubscriberByInfoSerialize
(It is only for internal use currently.)
* addSubscribersByInfo
Add new/existing subscribers into a subscription.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
SubscriberArgs(): email, firstName, middleName, lastName, jobTitle, company,
homePhone, address1, address2, address3, city, state, country,postalCode,
subPostalCode, customField1, customField2, customField3.
subscription: The subscription where the subscriber being added.
optInType: Double Opt-In Option.
return dataset containing error messages if any.
Remarks: Subscriber would receive confirmation email if user's Double Opt-in
option is ON.
* addSubscribersByInfo2
Add new/existing subscribers into a subscription.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
SubscriberArgs(): email, firstName, middleName, lastName, jobTitle, company,
homePhone, address1, address2, address3, city, state, country,postalCode,
subPostalCode, customField1, customField2, customField3.
subscription: The subscription where the subscriber being added.
optInType: Double Opt-In Option.
return dataset containing error messages if any.
Remarks: Subscriber would receive confirmation email if user's Double Opt-in
option is ON.
* addSubscribersByInfo2Serialize
(It is only for internal use currently.)
* addSubscribersByInfoSerialize
(It is only for internal use currently.)
* createBirthdayTriggerCampaign
Create a new email campaign with birthday trigger.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password or API KEY of Spread.
campaignArgs: Campaign Class, includes campaignName, fromEmail, from,
subject, content, signature and schedule
category: An array of string contains the names of categories added to this
email campaign.
birthSetting: the birthday trigger setting,include BeforeBirthdayDay:the No.
of days before birthday to send email.
AfterBirthdayMonth:the No. of months expires after birthday
EndToMonth: By the end of the month
isDraft: is Draft or not.
return campaignID.
* createCampaign
Create a new email campaign and send it out.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password or API KEY of Spread.
campaignArgs: Campaign Class, includes campaignName, fromEmail, from,
subject, content, signature and schedule
category: An array of string contains the names of categories added to this
email campaign.
interval: Type of email Campaign. -1, send for once only. Non-negetive
number, n days after subscribers subscribe.
return campaignID.
* createCampaign2
Create a new email campaign and campaign creatives .
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
campaignName: The name of the email campaign.
campaignCreatives: campaignCreatives Array, CampaignCreatives Class includes
displayName, fromAddress, replyTo, subject, creativeContent, target and
isCampaignDefault.
category: An array of string contains the names of categories added to this
email campaign.
interval: Type of email Campaign. -1, send for once only. Non-negetive
number, n days after subscribers subscribe.
schedule: The date of when to establish the email campaign.
signature: The signature of the email campaign.
campaignStatus: The status of the email campaign.
return campaignID.
* createCampaign2Serialize
(It is only for internal use currently.)
* createCampaignDraft
Create a new email campaign draft.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
campaignArgs: Campaign Class, includes campaignName, fromEmail, from,
subject, content, signature and schedule
category: An array of string contains the names of categories added to this
email campaign.
interval: Type of email Campaign. -1, send for once only. Non-negetive
number, n days after subscribers subscribe.
return campaignID.
* createCampaignDraft2
Create a new email campaign draft.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
campaignArgs: Campaign Class, includes campaignName, fromEmail, from,
subject, content, signature and schedule
category: An array of string contains the names of categories added to this
email campaign.
interval: Type of email Campaign. -1, send for once only. Non-negetive
number, n days after subscribers subscribe.
return campaignID.
* createCampaignDraftSerialize
(It is only for internal use currently.)
* createCampaignSerialize
(It is only for internal use currently.)
* createContactList
Create a new Contact List.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
subscriptionName: Subscription Name
description: Description of the new subscription.
return true if succeed.
* createSubscription
Create a new subscription.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
subscriptionName: Subscription Name
description: Description of the new subscription.
return true if succeed.
* getActiveSubscribersByContactList
getActiveSubscribersByContactList(It is only for internal use currently.)
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
contactListName: The Contact List you want to do.
return the count of active subscribers.
* getAllSubscription
Get all subscriptions.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
return dataset.
Dataset Columns:
Subscription Name, description, status, no. of subscribers
* getCampaignID
Validate Campaign exists
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
campaignName: Name of the campaign
return:campaign ID
* getCampaignReport
Get the Report of an Email Campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
CampaignID
return CampaignReport.
* getCampaignReportSerialize
(It is only for internal use currently.)
* getCampaignStatus
Get the Status of an Email Campaign.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
CampaignID
return Status.
* getSubscription
Get subscriptions in particular Status.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
status
return dataset.
Dataset Columns:
Subscription Name, description, status, no. of subscribers
* getSubscriptions2String
Get subscriptions in particular Status.
Arguments:
loginEmail: Login Email of Spread.
password: Login Password of Spread.
status
return string.
* getUserSentReport
getUserSentReport
Arguments:
loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve
from your Spread account (My account=> Settings).
campaignType: The type of campaign.
startDate:Starting time
endDate:End time
return dataset.
Dataset Columns:
Year,Month,Sent