• 홈
• Sailthru_Client

PHP 클래스 Sailthru_Client

파일 보기 프로젝트 열기: sailthru/sailthru-php5-client 1 사용 예제들

보호된 프로퍼티들

프로퍼티	타입	설명
$api_key	string	Sailthru API Key
$api_uri	string	Sailthru API URL, can be different for different users according to their settings
$http_request_type	string	cURL or non-cURL request
$secret	string	Sailthru Secret
$user_agent_string	String	User agent making request to Sailthru API server Even, if you modify user-agent, please try to include 'PHP5' somewhere in the user-agent

공개 메소드들

메소드	설명
__construct ( string $api_key, string $secret, string $api_uri = false, array $options = null )	Instantiate a new client; constructor optionally takes overrides for api_uri and whether to share the version of PHP that is being used.
apiDelete ( string $action, array $data, $options = [] ) : array	Perform an API DELETE request, using the shared-secret auth hash.
apiGet ( string $action, array $data = [], $method = 'GET', $options = [] ) : array	Perform an API GET request, using the shared-secret auth hash.
apiPost ( string $action, array $data, array $binary_data_param = [], array $options = [] ) : array	Perform an API POST (or other) request, using the shared-secret auth hash.
cancelBlast ( $blast_id ) : array	Cancel a scheduled Blast
cancelSend ( string $send_id ) : array	Cancel a send that was scheduled for a future time.
deleteAlert ( $email, $alert_id ) : array	Remove an alert from a user's settings.
deleteBlast ( $blast_id ) : array	Delete Blast
deleteList ( string $list ) : array	Deletes a list.
deleteTemplate ( string $template_name ) : array	Delete a template.
getAlert ( String $email ) : array	Retrieve a user's alert settings.
getBlast ( $blast_id ) : array	Get Blast information
getBlasts ( array $options ) : array	Get info on multiple blasts
getConnectTimeout ( )
getEmail ( string $email, array $options = [] ) : array	Return information about an email address, including replacement vars and lists.
getInclude ( string $include_name, array $options = [] ) : array	Fetch information about an include
getIncludes ( ) : array	Fetch name of all existing includes
getJobStatus ( String $job_id ) : array	Get status of a job
getLastRateLimitInfo ( string $action, string $method ) : array	get the rate limit information for the very last call with given action and method
getLastResponseInfo ( ) : array	get information from last server response when used with cURL returns associative array as per http://us.php.net/curl_getinfo
getList ( string $list ) : array	Get information about a list.
getLists ( ) : array	Get information about all lists
getSend ( string $send_id ) : array	Get the status of a send.
getTemplate ( string $template_name, array $options = [] ) : array	Fetch information about a template
getTemplateFromRevision ( $revision_id )
getTemplates ( ) : array	Fetch name of all existing templates
getTimeout ( )
getTriggerByEvent ( string $event ) : array	Get information on a trigger
getTriggerById ( string $trigger_id ) : array	Get information on a trigger
getTriggerByTemplate ( string $template, string $trigger_id = null ) : array	Get information on a trigger
getTriggers ( ) : array	Get Triggers
getUserByKey ( String $id, String $key, array $fields = [] ) : array	Get user by specified key
getUserBySid ( String $id ) : array	Get user by Sailthru ID
multisend ( string $template_name, array $emails, array $vars = [], array $evars = [], array $options = [] ) : array	Remotely send an email template to multiple email addresses.
postEvent ( string $id, string $event, array $options = [] ) : array	Notify Sailthru of an event
postEventTrigger ( string $event, integer $time, string $time_unit, string $zephyr ) : array	Create a trigger for events
postTrigger ( string $template, integer $time, string $time_unit, string $event, string $zephyr ) : array	Create a trigger for templates
previewBlastWithEmail ( $blast_id, $send_email ) : array	Get an email preview of a blast.
previewBlastWithHTML ( $blast_id, $email ) : array	Get an HTML preview of a blast.
previewContentWithEmail ( $content_html, $send_email ) : array	Get an email preview of content_html.
previewContentWithHTML ( $content_html, $email ) : array	Get an HTML preview of content_html.
previewRecurringBlastWithEmail ( $blast_repeat_id, $send_email ) : array	Get an email preview of a recurring blast.
previewRecurringBlastWithHTML ( $blast_repeat_id, $email ) : array	Get an HTML preview of a recurring blast.
previewTemplateWithEmail ( $template, $send_email ) : array	Get an email preview of a template.
previewTemplateWithHTML ( $template, $email ) : array	Get an HTML preview of a template.
processBlastQueryJob ( integer $blast_id, boolean | String $report_email = false, boolean | String $postback_url = false, array $options = [] ) : array	Export blast data in CSV format
processExportListJob ( String $list, boolean | String $report_email = false, boolean | String $postback_url = false, array $options = [] ) : array	Process a export list job
processImportJob ( String $list, String $emails, boolean | String $report_email = false, boolean | String $postback_url = false, array $options = [] ) : array	Process import job from given email string CSV
processImportJobFromFile ( String $list, $file_path, boolean | String $report_email = false, boolean | String $postback_url = false, array $options = [] ) : array	Process import job from given file path of a CSV or email per line file
processPurchaseImportJobFromFile ( String $file_path, boolean | String $report_email = false, boolean | String $postback_url = false, array $options = [] ) : array	Process purchase import job from given file path of an email per line JSON file
processSnapshotJob ( array $query, boolean | String $report_email = false, boolean | String $postback_url = false, array $options = [] ) : array	Process a snapshot job
processUpdateJob ( String $context, $value, array $update = [], boolean | String $report_email = false, boolean | String $postback_url = false, array $file_params = [], array $options = [] ) : array	Perform a bulk update of any number of user profiles from given context: String CSV, file, URL or query
processUpdateJobFromEmails ( String $emails, array $update = [], boolean | String $report_email = false, boolean | String $postback_url = false, array $options = [] ) : array	Perform a bulk update of any number of user profiles from emails CSV
processUpdateJobFromFile ( $file, array $update = [], boolean | String $report_email = false, boolean | String $postback_url = false, array $options = [] ) : array	Perform a bulk update of any number of user profiles from given file
processUpdateJobFromQuery ( Array $query, array $update = [], String $report_email = false, String $postback_url = false, array $options = [] )	Perform a bulk update of any number of user profiles from a query
processUpdateJobFromUrl ( String $url, array $update = [], boolean | String $report_email = false, boolean | String $postback_url = false, array $options = [] ) : array	Perform a bulk update of any number of user profiles from given URL
purchase ( $email, array $items, $incomplete = null, $message_id = null, array $options = [] ) : array	Record that a user has made a purchase, or has added items to their purchase total.
purchaseIncomplete ( $email, array $items, $message_id, array $options = [] ) : array	Make a purchase API call with incomplete flag
pushContent ( String $title, String $url, String $date = null, Mixed $tags = null, $vars = [], $options = [] ) : array	Push a new piece of content to Sailthru, triggering any applicable alerts.
receiveHardBouncePost ( ) : boolean	Hard bounce postbacks
receiveOptoutPost ( ) : boolean	Optout postbacks
receiveUpdatePost ( ) : boolean	Update postbacks
receiveVerifyPost ( ) : boolean	Returns true if the incoming request is an authenticated verify post.
saveAlert ( String $email, String $type, String $template, String $when = null, array $options = [] ) : array	Add a new alert to a user. You can add either a realtime or a summary alert (daily/weekly).
saveInclude ( string $include_name, array $include_fields = [] ) : array	Save an include
saveList ( string $list, string $type = null, boolean $primary = null, array $query = [] ) : array	Create a list, or update a list.
saveTemplate ( string $template_name, array $template_fields = [] ) : array	Save a template.
saveTemplateFromRevision ( string $template_name, $revision_id ) : array	Save a template from revision
saveUser ( String $id, array $options = [] ) : array	Save existing user
scheduleBlast ( string $name, string $list, string $schedule_time, string $from_name, string $from_email, string $subject, string $content_html, string $content_text, array $options = [] ) : array	Schedule a mass mail blast
scheduleBlastFromBlast ( String | integer $blast_id, String $schedule_time, array $options = [] ) : array	Schedule a mass mail blast from previous blast
scheduleBlastFromTemplate ( String $template, String $list, String $schedule_time, array $options = [] ) : array	Schedule a mass mail from a template
send ( string $template, string $email, array $vars = [], array $options = [], string $schedule_time = null ) : array	Remotely send an email template to a single email address.
setEmail ( string $email, array $vars = [], array $lists = [], array $templates = [], integer $verified, string $optout = null, string $send = null, array $send_vars = [] ) : array	Set replacement vars and/or list subscriptions for an email address.
setEmail2 ( $email, array $options = [] ) : array	Update / add email address
setHorizonCookie ( string $email, string $domain = null, integer $duration = null, boolean $secure = false ) : boolean	Set Horizon cookie
setHttpHeaders ( array $headers )
stats ( array $data ) : array	Make Stats API Request
stats_blast ( $blast_id = null, $start_date = null, $end_date = null, array $data = [] ) : array	Retrieve information about a particular blast or aggregated information from all of blasts over a specified date range.
stats_list ( String $list = null, String $date = null ) : array	Retrieve information about your subscriber counts on a particular list, on a particular day.
stats_send ( $template = null, $start_date = null, $end_date = null, array $data = [] ) : array	Retrieve information about a particular send or aggregated information from all of templates over a specified date range.
updateBlast ( $blast_id, string $name = null, string $list = null, string $schedule_time = null, string $from_name = null, string $from_email = null, string $subject = null, string $content_html = null, string $content_text = null, array $options = [] ) : array	updates existing blast

보호된 메소드들

메소드	설명
httpRequest ( $action, array $data, string $method = 'POST', array $options = [] ) : string	Perform an HTTP request, checking for curl extension support
httpRequestCurl ( string $action, array $data, string $method = 'POST', array $options = [] ) : string	Perform an HTTP request using the curl extension
httpRequestWithoutCurl ( string $action, array $data, string $method = 'POST', array $options = [] ) : string	Adapted from: http://netevil.org/blog/2006/nov/http-post-from-php-without-curl
prepareJsonPayload ( array $data, array $binary_data = [] )	Prepare JSON payload
processJob ( String $job, array $data = [], boolean | String $report_email = false, boolean | String $postback_url = false, array $binary_data_param = [], array $options = [] ) : array	process job api call

비공개 메소드들

메소드	설명
parseRateLimitHeaders ( string $headers ) : array | null	parse rate limit headers from http response

메소드 상세

프로퍼티 상세