$packageName
$packageName : string
The class can create and retrieve specific tenant.
This is the main client class which performs authentication, obtains auth token, if expired refresh auth token. Settings/Configuration can be passed to this class during construction or set it in config.php file. Configuration passed as parameter overrides the values from the configuration file.
$parentFolders : \FuelSdk\ET_Folder
__construct(boolean $getWSDL = false, boolean $debug = false, array $params = null)
Initializes a new instance of the ET_Client class.
boolean | $getWSDL | Flag to indicate whether to load WSDL from source. If true, WSDL is load from the source and saved in to path set in xmlLoc variable. If false, WSDL stored in the path set in xmlLoc is loaded. |
boolean | $debug | Flag to indicate whether debug information needs to be logged. Logging is enabled when the value is set to true and disabled when set to false. |
array | $params | Array of settings as string. Following are the possible settings. defaultwsdl - WSDL location/path clientid - Client Identifier optained from App Center clientsecred - Client secret associated with clientid appsignature - Application signature optained from App Center baseUrl - ExactTarget SOAP API Url baseAuthUrl - ExactTarget authentication rest api resource url If your application behind a proxy server, use the following setting proxyhost - proxy server host name or ip address proxyport - proxy server prot number proxyusername - proxy server user name proxypassword - proxy server password |
__doRequest(string $request, string $location, string $saction, string $version, integer $one_way) : string
Perfoms an soap request.
string | $request | Soap request xml |
string | $location | Url as string |
string | $saction | Soap action name |
string | $version | Future use |
integer | $one_way | Future use |
Soap web service request result
setAuthToken(string $tenantKey, string $authToken, string $authTokenExpiration)
Set the authentication token in the tenantTokens array.
string | $tenantKey | Tenant key for which auth toke to be set |
string | $authToken | Authentication token to be set |
string | $authTokenExpiration | Authentication token expiration value |
AddSubscriberToList(string $emailAddress, array $listIDs, string $subscriberKey = null) : mixed
Add subscriber to list.
string | $emailAddress | Email address of the subscriber |
array | $listIDs | Array of list id to which the subscriber is added |
string | $subscriberKey | Newly added subscriber key |
post or patch response object. If the subscriber already existing patch response is returned otherwise post response returned.
SendEmailToList(string $emailID, string $listID, string $sendClassficationCustomerKey) : mixed
Create an email send definition, send the email based on the definition and delete the definition.
string | $emailID | Email identifier for which the email is sent |
string | $listID | Send definition list identifier |
string | $sendClassficationCustomerKey | Send classification customer key |
Final delete action result
SendEmailToDataExtension(string $emailID, string $sendableDataExtensionCustomerKey, string $sendClassficationCustomerKey) : mixed
Create an email send definition, send the email based on the definition and delete the definition.
string | $emailID | Email identifier for which the email is sent |
string | $sendableDataExtensionCustomerKey | Sendable data extension customer key |
string | $sendClassficationCustomerKey | Send classification customer key |
Final delete action result
CreateAndStartListImport(string $listId, string $fileName) : mixed
Create an import definition and start the import process
string | $listId | List identifier. Used as the destination object identifier. |
string | $fileName | Name of the file to be imported |
Returns the import process result
CreateAndStartDataExtensionImport(string $dataExtensionCustomerKey, string $fileName, boolean $overwrite) : mixed
Create an import definition and start the import process
string | $dataExtensionCustomerKey | Data extension customer key. Used as the destination object identifier. |
string | $fileName | Name of the file to be imported |
boolean | $overwrite | Flag to indicate to overwrite the uploaded file |
Returns the import process result
GetTenants() : \FuelSdk\ET_GetRest
Object of type ET_GetRest which contains http status code, response, etc from the GET REST service