account::get_new_email

Description

Get a chosen new email address before it has been verified.

If you have chosen to change the email address on your account, you can check what your choice of new email address is. This can only be done before your change has been accepted.

Blank values will be returned if there is no new email address to retrieve.

Request details

Arguments

key
API key

Responses

<?xml version="1.0" encoding="utf-8"?>
<newemail>
  <email>user1@example.com</email>
  <status>confirmed</status>
</newemail>

<?xml version="1.0" encoding="utf-8"?>
<newemail>
  <email/>
  <status/>
</newemail>
	
email
Choice of new email address (blank if there is none)
status
confirmed
You have confirmed you have control of, or at least access to, the new email address
unconfirmed
You have yet to confirm ownership the new email address

Exceptions

Examples

Get new email address where new email address exists

GET /account/get_new_email/?key=acbd18db4cc2f85cedef654fccc4a4d8
<?xml version="1.0" encoding="utf-8"?>
<newemail>
  <email>user1@example.com</email>
  <status>confirmed</status>
</newemail>
	

Get new email address where no new email address exists

GET /account/get_new_email/?key=acbd18db4cc2f85cedef654fccc4a4d8
<?xml version="1.0" encoding="utf-8"?>
<newemail>
  <email/>
  <status/>
</newemail>
	

See also

  1. Index
  2. About the API

    1. Summary
    2. Specification
    3. Do not use undocumented features
    4. Change log
  3. Using the API

    1. Requests
      1. Authenticated requests
      2. Limits
      3. Common request value data types
    2. Understanding responses
      1. HTTP status codes used
      2. Exceptions
        1. access
        2. account
        3. database
        4. hostingaccount
        5. server
        6. system
  4. Function reference