C# Класс Sailthru.SailthruClient

Показать файл Открыть проект

Открытые методы

Метод Описание
ApiDelete ( string action, Hashtable parameters ) : SailthruResponse

For making API DELETE Request

ApiGet ( String action, Hashtable parameters ) : SailthruResponse

For making API GET Request

ApiPost ( string action, Hashtable parameters ) : SailthruResponse

For making API POST Request

CancelSend ( string sendId ) : SailthruResponse

cancel a future send before it goes out.

GetBlast ( string blastId ) : SailthruResponse

Get Blast

GetContent ( string url ) : SailthruResponse

Get information about one of your urls.

GetEmail ( Sailthru.Models.EmailRequest request ) : SailthruResponse

Get information about one of your users.

GetEmail ( string email ) : SailthruResponse

Get information about one of your users.

GetSend ( string sendId ) : SailthruResponse

check on the status of a send

GetStat ( String stat, Hashtable htOptions ) : SailthruResponse

Request various stats from Sailthru.

GetStat ( String stat, String list = null, String date = null, Hashtable htOptions = null ) : SailthruResponse

Request various stats from Sailthru.

GetStat ( String stat, String template = null, String startDate = null, String endDate = null, Hashtable htOptions = null ) : SailthruResponse

Request various stats from Sailthru.

GetTemplate ( string templateName ) : SailthruResponse

Get Template

GetUser ( UserRequest request ) : SailthruResponse

Get information about one of your users. Users are referenced by multiple keys.

ImportContacts ( string strEmail, string strPassword, bool boolIncludeNames ) : SailthruResponse

Fetch email contacts from an address book at one of the major email providers (aol/gmail/hotmail/yahoo)

Multisend ( string strTemplateName, string strEmail, Hashtable htVars = null, Hashtable htOptions = null ) : SailthruResponse

Send a transactional email for multiple users

ProcessImportJob ( String listName, List emails ) : SailthruResponse
ProcessImportJob ( String listName, String filePath ) : SailthruResponse
ProcessImportJob ( String reportEmail, String postbackUrl, String listName, List emails ) : SailthruResponse
ProcessImportJob ( String reportEmail, String postbackUrl, String listName, String filePath ) : SailthruResponse
ProcessJob ( String jobType, String reportEmail, String postbackUrl, Hashtable parameters ) : SailthruResponse
Purchase ( Sailthru.Models.PurchaseRequest request ) : SailthruResponse

Submit a Purchase to Sailthru

ReceiveOptoutPost ( NameValueCollection parameters ) : bool

Receive the output of a Post.

ReceiveVerifyPost ( NameValueCollection parameters ) : bool

Receive and verify the output of a Post.

SailthruClient ( string apiKey, string secret ) : System

Constructor with default API URI

SailthruClient ( string apiKey, string secret, string apiHost ) : System

Constructor with custom API URI

SaveTemplate ( Sailthru.Models.TemplateRequest request ) : SailthruResponse

Save Template

SaveTemplate ( string strTemplateName, Hashtable fields = null ) : SailthruResponse

Save Template

ScheduleBlast ( Sailthru.Models.BlastRequest request ) : SailthruResponse

Create, update, and/or schedule a blast.

ScheduleBlast ( string strName, string strList, string strScheduleTime, string strFromName, string strFromEmail, string strSubject, string strContentHtml, string strContentText, Hashtable htOptions = null ) : SailthruResponse

Create, update, and/or schedule a blast.

Send ( SendRequest request ) : SailthruResponse

Send a transactional Email for a single or multiple users.

Send ( string strTemplateName, string strEmail, Hashtable htVars = null, Hashtable htOptions = null ) : SailthruResponse

Send a transactional Email for a single user

SetContent ( Sailthru.Models.ContentRequest request ) : SailthruResponse

Set information about one of your urls.

SetEmail ( Sailthru.Models.EmailRequest request ) : SailthruResponse

Update information about one of your users, including adding and removing the user from lists.

SetEmail ( string strEmail, Hashtable htVars = null, Hashtable htLists = null, Hashtable htTemplates = null, int verified, String optout = null, string send = null, Hashtable sendVars = null, String sms = null, String twitter = null, String changeEmail = null ) : SailthruResponse

Update information about one of your users, including adding and removing the user from lists.

SetUser ( UserRequest request ) : SailthruResponse

Set information about one of your users. Users are referenced by multiple keys.

getLastRateLimitInfo ( string action, string method ) : Hashtable

Get rate limit information for last API call

Защищенные методы

Метод Описание
ApiPostWithFile ( string action, Hashtable htForPost, String filePath ) : SailthruResponse
BuildPostRequest ( String action, Hashtable parameters ) : HttpWebRequest
BuildPostWithFileRequest ( String action, Hashtable parameters, String filePath ) : HttpWebRequest
BuildRequest ( String method, String path ) : HttpWebRequest
BuildRequest ( String method, String action, Hashtable parameters ) : HttpWebRequest
GetParameterString ( Hashtable parameters ) : string
SendRequest ( HttpWebRequest request, String action ) : SailthruResponse

Приватные методы

Метод Описание
AddAuthenticationAndFormatToParams ( Hashtable parameters ) : void
GetSignatureHash ( IEnumerable values ) : String
GetSignatureHash ( NameValueCollection col ) : String
OrdinalSort ( Object values ) : void
UrlEncode ( string s ) : string

URL Encode String

md5 ( string value ) : string

Generates an MD5 hash of the string.

Описание методов

ApiDelete() публичный Метод

For making API DELETE Request
public ApiDelete ( string action, Hashtable parameters ) : SailthruResponse
action string
parameters System.Collections.Hashtable
Результат SailthruResponse

ApiGet() публичный Метод

For making API GET Request
public ApiGet ( String action, Hashtable parameters ) : SailthruResponse
action String API Method String
parameters System.Collections.Hashtable API Parameter Hashtable
Результат SailthruResponse

ApiPost() публичный Метод

For making API POST Request
public ApiPost ( string action, Hashtable parameters ) : SailthruResponse
action string
parameters System.Collections.Hashtable
Результат SailthruResponse

ApiPostWithFile() защищенный Метод

protected ApiPostWithFile ( string action, Hashtable htForPost, String filePath ) : SailthruResponse
action string
htForPost System.Collections.Hashtable
filePath String
Результат SailthruResponse

BuildPostRequest() защищенный Метод

protected BuildPostRequest ( String action, Hashtable parameters ) : HttpWebRequest
action String
parameters System.Collections.Hashtable
Результат System.Net.HttpWebRequest

BuildPostWithFileRequest() защищенный Метод

protected BuildPostWithFileRequest ( String action, Hashtable parameters, String filePath ) : HttpWebRequest
action String
parameters System.Collections.Hashtable
filePath String
Результат System.Net.HttpWebRequest

BuildRequest() защищенный Метод

protected BuildRequest ( String method, String path ) : HttpWebRequest
method String
path String
Результат System.Net.HttpWebRequest

BuildRequest() защищенный Метод

protected BuildRequest ( String method, String action, Hashtable parameters ) : HttpWebRequest
method String
action String
parameters System.Collections.Hashtable
Результат System.Net.HttpWebRequest

CancelSend() публичный Метод

cancel a future send before it goes out.
public CancelSend ( string sendId ) : SailthruResponse
sendId string
Результат SailthruResponse

GetBlast() публичный Метод

Get Blast
public GetBlast ( string blastId ) : SailthruResponse
blastId string
Результат SailthruResponse

GetContent() публичный Метод

Get information about one of your urls.
public GetContent ( string url ) : SailthruResponse
url string
Результат SailthruResponse

GetEmail() публичный Метод

Get information about one of your users.
public GetEmail ( Sailthru.Models.EmailRequest request ) : SailthruResponse
request Sailthru.Models.EmailRequest
Результат SailthruResponse

GetEmail() публичный Метод

Get information about one of your users.
public GetEmail ( string email ) : SailthruResponse
email string
Результат SailthruResponse

GetParameterString() защищенный Метод

protected GetParameterString ( Hashtable parameters ) : string
parameters System.Collections.Hashtable
Результат string

GetSend() публичный Метод

check on the status of a send
public GetSend ( string sendId ) : SailthruResponse
sendId string
Результат SailthruResponse

GetStat() публичный Метод

Request various stats from Sailthru.
public GetStat ( String stat, Hashtable htOptions ) : SailthruResponse
stat String
htOptions System.Collections.Hashtable
Результат SailthruResponse

GetStat() публичный Метод

Request various stats from Sailthru.
public GetStat ( String stat, String list = null, String date = null, Hashtable htOptions = null ) : SailthruResponse
stat String
list String
date String
htOptions System.Collections.Hashtable
Результат SailthruResponse

GetStat() публичный Метод

Request various stats from Sailthru.
public GetStat ( String stat, String template = null, String startDate = null, String endDate = null, Hashtable htOptions = null ) : SailthruResponse
stat String
template String
startDate String
endDate String
htOptions System.Collections.Hashtable
Результат SailthruResponse

GetTemplate() публичный Метод

Get Template
public GetTemplate ( string templateName ) : SailthruResponse
templateName string
Результат SailthruResponse

GetUser() публичный Метод

Get information about one of your users. Users are referenced by multiple keys.
public GetUser ( UserRequest request ) : SailthruResponse
request Sailthru.Models.UserRequest
Результат SailthruResponse

ImportContacts() публичный Метод

Fetch email contacts from an address book at one of the major email providers (aol/gmail/hotmail/yahoo)
public ImportContacts ( string strEmail, string strPassword, bool boolIncludeNames ) : SailthruResponse
strEmail string Email String
strPassword string Password String
boolIncludeNames bool Boolean
Результат SailthruResponse

Multisend() публичный Метод

Send a transactional email for multiple users
public Multisend ( string strTemplateName, string strEmail, Hashtable htVars = null, Hashtable htOptions = null ) : SailthruResponse
strTemplateName string
strEmail string
htVars System.Collections.Hashtable
htOptions System.Collections.Hashtable
Результат SailthruResponse

ProcessImportJob() публичный Метод

public ProcessImportJob ( String listName, List emails ) : SailthruResponse
listName String
emails List
Результат SailthruResponse

ProcessImportJob() публичный Метод

public ProcessImportJob ( String listName, String filePath ) : SailthruResponse
listName String
filePath String
Результат SailthruResponse

ProcessImportJob() публичный Метод

public ProcessImportJob ( String reportEmail, String postbackUrl, String listName, List emails ) : SailthruResponse
reportEmail String
postbackUrl String
listName String
emails List
Результат SailthruResponse

ProcessImportJob() публичный Метод

public ProcessImportJob ( String reportEmail, String postbackUrl, String listName, String filePath ) : SailthruResponse
reportEmail String
postbackUrl String
listName String
filePath String
Результат SailthruResponse

ProcessJob() публичный Метод

public ProcessJob ( String jobType, String reportEmail, String postbackUrl, Hashtable parameters ) : SailthruResponse
jobType String
reportEmail String
postbackUrl String
parameters System.Collections.Hashtable
Результат SailthruResponse

Purchase() публичный Метод

Submit a Purchase to Sailthru
public Purchase ( Sailthru.Models.PurchaseRequest request ) : SailthruResponse
request Sailthru.Models.PurchaseRequest Purchaserequest parameters.
Результат SailthruResponse

ReceiveOptoutPost() публичный Метод

Receive the output of a Post.
public ReceiveOptoutPost ( NameValueCollection parameters ) : bool
parameters System.Collections.Specialized.NameValueCollection
Результат bool

ReceiveVerifyPost() публичный Метод

Receive and verify the output of a Post.
public ReceiveVerifyPost ( NameValueCollection parameters ) : bool
parameters System.Collections.Specialized.NameValueCollection
Результат bool

SailthruClient() публичный Метод

Constructor with default API URI
public SailthruClient ( string apiKey, string secret ) : System
apiKey string
secret string
Результат System

SailthruClient() публичный Метод

Constructor with custom API URI
public SailthruClient ( string apiKey, string secret, string apiHost ) : System
apiKey string
secret string
apiHost string
Результат System

SaveTemplate() публичный Метод

Save Template
public SaveTemplate ( Sailthru.Models.TemplateRequest request ) : SailthruResponse
request Sailthru.Models.TemplateRequest TemplateRequest parameters.
Результат SailthruResponse

SaveTemplate() публичный Метод

Save Template
public SaveTemplate ( string strTemplateName, Hashtable fields = null ) : SailthruResponse
strTemplateName string
fields System.Collections.Hashtable
Результат SailthruResponse

ScheduleBlast() публичный Метод

Create, update, and/or schedule a blast.
public ScheduleBlast ( Sailthru.Models.BlastRequest request ) : SailthruResponse
request Sailthru.Models.BlastRequest BlastRequest parameters.
Результат SailthruResponse

ScheduleBlast() публичный Метод

Create, update, and/or schedule a blast.
public ScheduleBlast ( string strName, string strList, string strScheduleTime, string strFromName, string strFromEmail, string strSubject, string strContentHtml, string strContentText, Hashtable htOptions = null ) : SailthruResponse
strName string
strList string
strScheduleTime string
strFromName string
strFromEmail string
strSubject string
strContentHtml string
strContentText string
htOptions System.Collections.Hashtable
Результат SailthruResponse

Send() публичный Метод

Send a transactional Email for a single or multiple users.
public Send ( SendRequest request ) : SailthruResponse
request SendRequest SendRequest parameters.
Результат SailthruResponse

Send() публичный Метод

Send a transactional Email for a single user
public Send ( string strTemplateName, string strEmail, Hashtable htVars = null, Hashtable htOptions = null ) : SailthruResponse
strTemplateName string
strEmail string
htVars System.Collections.Hashtable
htOptions System.Collections.Hashtable
Результат SailthruResponse

SendRequest() защищенный Метод

protected SendRequest ( HttpWebRequest request, String action ) : SailthruResponse
request System.Net.HttpWebRequest
action String
Результат SailthruResponse

SetContent() публичный Метод

Set information about one of your urls.
public SetContent ( Sailthru.Models.ContentRequest request ) : SailthruResponse
request Sailthru.Models.ContentRequest
Результат SailthruResponse

SetEmail() публичный Метод

Update information about one of your users, including adding and removing the user from lists.
public SetEmail ( Sailthru.Models.EmailRequest request ) : SailthruResponse
request Sailthru.Models.EmailRequest EmailRequest parameters.
Результат SailthruResponse

SetEmail() публичный Метод

Update information about one of your users, including adding and removing the user from lists.
public SetEmail ( string strEmail, Hashtable htVars = null, Hashtable htLists = null, Hashtable htTemplates = null, int verified, String optout = null, string send = null, Hashtable sendVars = null, String sms = null, String twitter = null, String changeEmail = null ) : SailthruResponse
strEmail string
htVars System.Collections.Hashtable
htLists System.Collections.Hashtable
htTemplates System.Collections.Hashtable
verified int
optout String
send string
sendVars System.Collections.Hashtable
sms String
twitter String
changeEmail String
Результат SailthruResponse

SetUser() публичный Метод

Set information about one of your users. Users are referenced by multiple keys.
public SetUser ( UserRequest request ) : SailthruResponse
request Sailthru.Models.UserRequest
Результат SailthruResponse

getLastRateLimitInfo() публичный Метод

Get rate limit information for last API call
public getLastRateLimitInfo ( string action, string method ) : Hashtable
action string API endpoint
method string HTTP method
Результат System.Collections.Hashtable