Articles in this section

Find if an Email Address is Among Your Correspondents (Using API Token)

Luis Fernandes
Follow

What is it?

This article is for understanding how to find a single or all the email correspondents using CMD Parameters that can be executed along with Login Script.

 

Who will use it?

Agent, End-User

 

How is it used?

To carry out all the below activity administrator need to have the API Token generated.

 

  • Command to use is “cmd=findEmailAddress”
  • Parameter required “sEmail”

 

  1. Searching for a Single Email Address 

  • Use of Login URL example:

https://kakapo.fogbugz.com/api.asp?cmd=findEmailAddress&sEmail=email-address%40example.com&token=04t6193822pekbba09nt74ninuihk2

  • Use of Fogbugz.py:

fb.findEmailAddress(sEmail="email-address@example.com")

If Success, response return should be:

“<response>
  <emails>
    <email><email-address@example.com></email>
  </emails>
</response>”

 

  1. Listing All Email Addresses: To get all email address need to remove “sEmail” parameters from Both the strings 

  • Use of Login URL example:

https://kakapo.fogbugz.com/api.asp?cmd=findEmailAddress&token=04t6193822pekbba09nt74ninuihk2

  • Use of Fogbugz.py:

fb.findEmailAddress(sEmail="email-address@example.com")

If Success, response return should be

“<response>
  <emails>
    <email>
      "First Last1" <First.last1@gmail.com>
    </email>
    <email>
      "First Last2" <First.Last2@aol.com>
    </email>
    <email>
      "First Last3" <First.Last3@yahoo.com>
    </email>
    <email>
      "First Last4" <First.Last4@hotmail.com>
    </email>
  </emails>
</response>” 

 

Related articles