Table of Contents

getSenders

Returns a list of authorized senders on the specified account.

getSenders URL: https://www.spamarrest.com/api/getSenders

xml=<getSenders>
<apiKey>api_key</apiKey>
<salogin>username</salogin>
<sapass>password</sapass>
<status>[Enabled|Blocked]</status>
<sortfield>[created|email|senderStatusCause|friendlyName]</sortfield>
<match>match_string</match>
<order>[asc|desc]</order>
<offset>offset</offset>
<limit>rows_returned</limit>
</getSenders>

Example:

xml=<getSenders>
<apiKey>s83laznde19d91</apiKey>
<salogin>michaeln</salogin>
<sapass>password</sapass>
<status>enabled</status>
<sortfield>email</sortfield>
<match>gmail</match>
<order>asc</order>
<offset>0</offset>
<limit>20</limit>
</getSenders>

This will return the first 20 authorized addresses sorted by email address in ascending order for user “michaeln” whose email address contains the string “gmail”.

authEmail

Adds an authorized sender on the specified account.

authEmail URL: https://www.spamarrest.com/api/authEmail

xml=<authEmail>
<apiKey>api_key</apiKey>
<salogin>username</salogin>
<sapass>password</sapass>
<email>example@example.com</email>
</authEmail>

Example:

xml=<authEmail>
<apiKey>s83laznde19d91</apiKey>
<salogin>michaeln</salogin>
<sapass>password</sapass>
<email>example@example.com</email>
</authEmail>

This will authorize the address “example@example.com”. Any emails sent from that address that are in the user's Unverified folder will also be delivered.

removeSender

Removes an authorized sender on the specified account.

removeSender URL: https://www.spamarrest.com/api/removeSender

xml=<removeSender>
<apiKey>api_key</apiKey>
<salogin>username</salogin>
<sapass>password</sapass>
<email>example@example.com</email>
</removeSender>

Example:

xml=<removeSender>
<apiKey>s83laznde19d91</apiKey>
<salogin>michaeln</salogin>
<sapass>password</sapass>
<email>example@example.com</email>
</removeSender>

This will remove the address “example@example.com” from the authorized senders list of “michaeln”.

 
senders.txt · Last modified: 2010/07/28 03:14 by michaeln
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki