Home       Trees       Indices       Help   
Package emailage :: Module api
[hide private]
[frames] | no frames]

Module api

source code

emailAge core API module.

This module contains all methods that are required to make a request fromt the emailAge API.

Functions [hide private]
 
get_emailage_url(method, url, consumer_key, consumer_secret)
Generate the oauth url for emailAge		 source code
 
get_base_url(use_prod=False)
Returns the base url, either sandbox or prod.		 source code
 
get_emailage_score(email, customer_key, secret_token, ip=None, use_prod=False, score_only=True)
Returns the emailAge score and message.		 source code
Variables [hide private]
  logger = logging.getLogger('emailage')
  __package__ = 'emailage'
Function Details [hide private]

get_emailage_url(method, url, consumer_key, consumer_secret)

source code 

Generate the oauth url for emailAge

Parameters:
  • method - can be POST or GET.
  • url - base url to use, either prod or sandbox..
  • consumer_key - consumer key credential for authentication.
  • consumer_secret - consumer secret credential for authentication.

get_base_url(use_prod=False)

source code 

Returns the base url, either sandbox or prod.

Parameters:
  • use_prod - use production url or sandbox.

get_emailage_score(email, customer_key, secret_token, ip=None, use_prod=False, score_only=True)

source code 

Returns the emailAge score and message.

Parameters:
  • email - email address to query for, mandatory field.
  • customer_key - customer key as per emailAge api.
  • secret_token - secret key as per emailAge api.
  • ip - optional ip address to include in the query.
  • use_prod - use emailage production url instead of sandbox.
Returns:
success, emailAge score data, message

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Sat Jan 16 05:09:52 2016 http://epydoc.sourceforge.net