inboxtracker.spam_trap.available_domains

class inboxtracker.spam_trap.AvailableDomains(base_uri, api_key, transport_class=<class 'inboxtracker.base.RequestsTransport'>)
get_available_domains(**kwargs)

Gets the list of domains associated to your account/child accounts.

Parameters

  • childAccountId (int) – The child account to narrow results. This parameter is optional unless the API key is configured to require the childAccountId parameter.

  • partnerAccountId (str) – The partnerAccountId associated with the childAccountId. This parameter is required by API keys configured to require the childAccountId-partnerAccountId parameters; otherwise the parameter is ignored.

Returns

A list object of dict containing the domains available on the account.

inboxtracker.spam_trap.domain

class inboxtracker.spam_trap.Domain(base_uri, api_key, transport_class=<class 'inboxtracker.base.RequestsTransport'>)
get_domain_rollup(**kwargs)
Gets a list of aggregated detailed spam trap information and associated campaign information for sending

domains. A details link is returned which can be used to retrieve the details for each of the spam trap hits included in the aggregated spam trap information.

Parameters

  • qd (str) –

    A date range query parameter.

    Accepts: since:YYYYMMDD, between:YYYYMMDDhhmmss,YYYYMMDDhhmmss, and daysBack:N.

    Examples: since:20190601, between:20191001000000,20191002060000, daysBack:30

  • domain – List of strings. The domains to filter on.

  • trapSource –

    List of strings. The trap sources to filter on.

    Accepts: ABUSIX, CLOUDMARK, SNDS, GTN_PASSIVE, GTN_ACTIVE

  • trapType –

    List of strings. The trap types to filter on.

    Accepts: PRISTINE, MIXED, RECYCLED, PARKED, TYPO

  • ipAddress – List of strings. IP addresses to filter on. Accepts IP ranges, each IP range must be no larger that 256 IPs.

  • campaignIdentifier – List of strings. The campaign identifier used to identify the campaign when using a Campaign Identification method other than Subject/Date. Use the subjectLine filter if a domain is using Subject/Date to identify campaigns.

  • subjectLine – List of strings. The subject lines to filter on.

  • fromAddresses – List of strings. The “from” addresses to filter on.

  • page (int) – The page to query for in pagination.

  • per_page (int) – The amount of records per page you wish to query for (max 100)

  • order (str) –

    The property to sort by (‘property’ for decending, ‘-property’ for ascending)

    Accepts: domain, -domain, hitCountTotal, -hitCountTotal, firstSeen, -firstSeen, lastSeen, -lastSeen, hitSources, -hitSources, trapTypes, -trapTypes, subjectLine, -subjectLine, campaign, and -campaign.

Returns

A list object of dict containing spam trap information

get_domain_rollup_details(**kwargs)
Gets a list of spam trap hits with detailed information. It is recommended that this endpoint be accessed

using the details link returned by the domain/rollup endpoint. To retrieve details for a campaign you must set a campaignId OR subjectLine filter for the campaign of interest. If you do not set a campaignId OR subjectLine filter you will only get detailed hits without an associated campaign.

Parameters

  • qd (str) –

    A date range query parameter.

    Accepts: since:YYYYMMDD, between:YYYYMMDDhhmmss,YYYYMMDDhhmmss, and daysBack:N.

    Examples: since:20190601, between:20191001000000,20191002060000, daysBack:30

  • domain – List of strings. The domains to filter on.

  • trapSource –

    List of strings. The trap sources to filter on.

    Accepts: ABUSIX, CLOUDMARK, SNDS, GTN_PASSIVE, GTN_ACTIVE

  • trapType –

    List of strings. The trap types to filter on.

    Accepts: PRISTINE, MIXED, RECYCLED, PARKED, TYPO

  • ipAddress – List of strings. IP addresses to filter on. Accepts IP ranges, each IP range must be no larger that 256 IPs.

  • campaignId (int) – The campaign id used to filter on.

  • subjectLine (str) – The subject line to filter on.

  • fromAddresses – List of strings. The “from” addresses to filter on.

  • page (int) – The page to query for in pagination.

  • per_page (int) – The amount of records per page you wish to query for (max 100)

  • order (str) –

    The property to sort by (‘property’ for decending, ‘-property’ for ascending)

    Accepts: domain, -domain, hitCountTotal, -hitCountTotal, firstSeen, -firstSeen, lastSeen, -lastSeen, ipAddress, -ipAddress, hitSources, -hitSources, subjectLine, -subjectLine, fromAddress, -fromAddress, trapAgeDays, and -trapAgeDays.

Returns

A list object of dict containing spam trap details for a campaign

get_traps_by_domain(**kwargs)

Get a list of spam trap hits grouped by domain.

Parameters

  • qd (str) –

    A date range query parameter.

    Accepts: since:YYYYMMDD, between:YYYYMMDDhhmmss,YYYYMMDDhhmmss, and daysBack:N.

    Examples: since:20190601, between:20191001000000,20191002060000, daysBack:30

  • domain – List of strings. The domains to filter on.

  • trapSource –

    List of strings. The trap sources to filter on.

    Accepts: ABUSIX, CLOUDMARK, SNDS, GTN_PASSIVE, GTN_ACTIVE

  • trapType –

    List of strings. The trap types to filter on.

    Accepts: PRISTINE, MIXED, RECYCLED, PARKED, TYPO

  • ipAddress – List of strings. IP addresses to filter on. Accepts IP ranges, each IP range must be no larger that 256 IPs.

  • page (int) – The page to query for in pagination.

  • per_page (int) – The amount of records per page you wish to query for (max 100)

  • order (str) –

    The property to sort by (‘property’ for decending, ‘-property’ for ascending)

    Accepts: domain, -domain, hitCountTotal, -hitCountTotal, hitCountRecycled, -hitCountRecycled, hitCountMixed, -hitCountMixed, hitCountParked, -hitCountParked, hitCountPristine, -hitCountPristine, hitCountTypo, and -hitCountTypo.

Returns

A list object of dict containing spam trap hit counts

inboxtracker.spam_trap.ip

class inboxtracker.spam_trap.IP(base_uri, api_key, transport_class=<class 'inboxtracker.base.RequestsTransport'>)
get_ip_rollup(**kwargs)
Gets a list of aggregated detailed spam trap information and associated campaign information by IP address for

sending domains. A details link is returned which can be used to retrieve the details for each of the spam trap hits included in the aggregated spam trap information.

Parameters

  • qd (str) –

    A date range query parameter.

    Accepts: since:YYYYMMDD, between:YYYYMMDDhhmmss,YYYYMMDDhhmmss, and daysBack:N.

    Examples: since:20190601, between:20191001000000,20191002060000, daysBack:30

  • domain – List of strings. The domains to filter on.

  • trapSource –

    List of strings. The trap sources to filter on.

    Accepts: ABUSIX, CLOUDMARK, SNDS, GTN_PASSIVE, GTN_ACTIVE

  • trapType –

    List of strings. The trap types to filter on.

    Accepts: PRISTINE, MIXED, RECYCLED, PARKED, TYPO

  • ipAddress – List of strings. IP addresses to filter on. Accepts IP ranges, each IP range must be no larger that 256 IPs.

  • campaignIdentifier – List of strings. The campaign identifier used to identify the campaign when using a Campaign Identification method other than Subject/Date. Use the subjectLine filter if a domain is using Subject/Date to identify campaigns.

  • subjectLine – List of strings. The subject lines to filter on.

  • fromAddresses – List of strings. The “from” addresses to filter on.

  • page (int) – The page to query for in pagination.

  • per_page (int) – The amount of records per page you wish to query for (max 100)

  • order (str) –

    The property to sort by (‘property’ for decending, ‘-property’ for ascending)

    Accepts: ipAddress, -ipAddress, hitCountTotal, -hitCountTotal, firstSeen, -firstSeen, lastSeen, -lastSeen, hitSources, -hitSources, trapTypes, -trapTypes, subjectLine, -subjectLine, campaign, and -campaign.

Returns

A list object of dict containing spam trap data

get_ip_rollup_details(**kwargs)
Gets a list of spam trap hits with detailed information. It is recommended that this endpoint be accessed

using the details link returned by the ip/rollup endpoint. To retrieve details for a campaign you must set a campaignId OR subjectLine filter for the campaign of interest. If you do not set a campaignId OR subjectLine filter you will only get detailed hits without an associated campaign.

Parameters

  • qd (str) –

    A date range query parameter.

    Accepts: since:YYYYMMDD, between:YYYYMMDDhhmmss,YYYYMMDDhhmmss, and daysBack:N.

    Examples: since:20190601, between:20191001000000,20191002060000, daysBack:30

  • domain – List of strings. The domains to filter on.

  • trapSource –

    List of strings. The trap sources to filter on.

    Accepts: ABUSIX, CLOUDMARK, SNDS, GTN_PASSIVE, GTN_ACTIVE

  • trapType –

    List of strings. The trap types to filter on.

    Accepts: PRISTINE, MIXED, RECYCLED, PARKED, TYPO

  • ipAddress – List of strings. IP addresses to filter on. Accepts IP ranges, each IP range must be no larger that 256 IPs.

  • campaignId (int) – The campaign id used to filter on.

  • subjectLine (str) – The subject line to filter on.

  • fromAddresses – List of strings. The “from” addresses to filter on.

  • page (int) – The page to query for in pagination.

  • per_page (int) – The amount of records per page you wish to query for (max 100)

  • order (str) –

    The property to sort by (‘property’ for decending, ‘-property’ for ascending)

    Accepts: hitCountTotal, -hitCountTotal, firstSeen, -firstSeen, lastSeen, -lastSeen, ipAddress, -ipAddress, hitSources, -hitSources, subjectLine,``-subjectLine``, fromAddress, -fromAddress, trapAgeDays, and -trapAgeDays.

Returns

A list object of dict containing spam trap data.

get_traps_by_ip(**kwargs)

Get a list of spam trap hits grouped by IP address.

Parameters

  • qd (str) –

    A date range query parameter.

    Accepts: since:YYYYMMDD, between:YYYYMMDDhhmmss,YYYYMMDDhhmmss, and daysBack:N.

    Examples: since:20190601, between:20191001000000,20191002060000, daysBack:30

  • domain – List of strings. The domains to filter on.

  • trapSource –

    List of strings. The trap sources to filter on.

    Accepts: ABUSIX, CLOUDMARK, SNDS, GTN_PASSIVE, GTN_ACTIVE

  • trapType –

    List of strings. The trap types to filter on.

    Accepts: PRISTINE, MIXED, RECYCLED, PARKED, TYPO

  • ipAddress – List of strings. IP addresses to filter on. Accepts IP ranges, each IP range must be no larger that 256 IPs.

  • page (int) – The page to query for in pagination.

  • per_page (int) – The amount of records per page you wish to query for (max 100)

  • order (str) –

    The property to sort by (‘property’ for decending, ‘-property’ for ascending)

    Accepts: ipAddress, -ipAddress, hitCountTotal, -hitCountTotal, hitCountRecycled, -hitCountRecycled, hitCountMixed, -hitCountMixed, hitCountParked, -hitCountParked, hitCountPristine, -hitCountPristine, hitCountTypo, and -hitCountTypo

Returns

A list object of dict containing aggregated spam trap data

inboxtracker.spam_trap.ping

class inboxtracker.spam_trap.Ping(base_uri, api_key, transport_class=<class 'inboxtracker.base.RequestsTransport'>)
ping_service()

Ping the service to verify it is reachable.

Returns

A str object. A successful ping will return the string ‘pong’.