autoresponderGetDetail
public static array autoresponderGetDetail(string token, string autoresponderID)
Get all the details for given Autoresponder ID
| Parameters |
| string token | A valid token for your account. To generate a token, use the login method. |
| string autoresponderID | The autoresponderID ID . To get all the Autoresponder campaigns, use the autoresponderGetList method. |
| Returns |
| array | Returns an array with the details. |
| Return Structure |
| string id | The ID of the email campaign. |
| string autoresponderName | Name of the Autoresponder |
| string status | Status of the Autoresponder |
| string createdDate | The date on which the Autoresponder was created |
| string modifiedDate | The date on which the Autoresponder was last updated |
| string contactListID | Id of the contact list associated with the Autoresponder |
| string contactListName | Name of the contact list associated with the Autoresponder |
| string isSegment | Whether the associated list is a segment |
| string fromName | Name displayed as "from" in your contact's in-box |
| string fromEmail | Email displayed as "from address" in your contact's in-box |
| string permissionReminderMessage | optional. Permission reminder message text |
| bool webpageVersion | optional. Include a link to view a web version of the email. Defaults to false. |
| array emails | The array containing the Autoresponder email details.| string autoresponderDetailID | The id of the Autoresponder email | | string subject | The subject of the Autoresponder email | | string days | No of days after the date of the creation of the Autoresponder when the email is to be sent to the list | | string type | Type of the autoresponder - valid values are 'one off email' , 'annual email' , 'new subscriber email' | | string whentosend | When to send the autoresponder valid values are 'after' , 'before', ignore if this is not applicable | | string fieldtocompare | Label of the datecolumn which is used as a reference for 'annual email' or 'one off email' , ignore if this is not applicable |
|
- <?php
- /**
- This Example shows how to authenticate a user using XML-RPC.
- Note that we are using the PEAR XML-RPC client and recommend others do as well.
- **/
- require_once 'XML/RPC2/Client.php';
- require_once 'inc/config.php';
- $client = XML_RPC2_Client::create($apiURL);
- $token = $client->login($apiLogin, $apiPassword);
-
- /**
- Fetch the latest Autoresponder, so that we can retrieve the Autoresponder ID.
- **/
- $AutoresponderList = $client->autoresponderGetList($token,1,10,'','','');
- $autoresponderID = $AutoresponderList[0]['id'];
-
- $data = $client->autoresponderGetDetail($token,$autoresponderID);
- print_r($data);
- ?>