Email Account Management APIs

Fetch Email Account Info

API to fetch information about an email account on Titan Mail Cloud infra.

  • At least one of (titanAccountId) or (titanOrderId, email) should be present in request
get/partner/fetchEmailAccount

Request

  • Base URL: https://bll.titan.email
  • URL: https://bll.titan.email/partner/fetchEmailAccount
  • Auth: none declared

Query parameters

titanOrderIdnumber
Example:1

The unique order ID against each domain provisioned with Titan

titanAccountIdnumber
Example:1

The unique mail account ID against each email provisioned with Titan.

emailstring
Example:info@xyz.com

Specify the email account for which the information is required.

Response

OK

namestring

<span data-no-badge></span>This is the name of the user associated to the email account provided

firstNamestring

The first name of the customer for whom the email address is being created.

lastNamestring

The last name of the customer for whom the email address is being created.

titanOrderIdnumber

<span data-no-badge></span>The unique order ID against each domain provisioned with Titan

alternateEmailAddressstring

<span data-no-badge></span>Alternate email address associated to the email account provided

status'active' | 'suspended' | 'deleted'

<span data-no-badge></span>The current status of the email account.

storageUsednumber

<span data-no-badge></span>

storageLimitnumber

<span data-no-badge></span>

isAdminboolean

<span data-no-badge></span>

aliasesstring[]

<span data-no-badge></span>

purgeAtstring

In yyyy-MM-dd format. All the account data would be purged from Titan's system permanently on this date. Account is expected to be in the deleted state and not already purged.

Example response

{
  "name": "Info",
  "firstName": "James",
  "lastName": "Bond",
  "titanOrderId": 1,
  "alternateEmailAddress": "james@xyz.com",
  "status": "active",
  "storageUsed": 1234,
  "storageLimit": 5000,
  "isAdmin": true,
  "purgeAt": "2024-02-20"
}

Changes

No recorded changes to this operation across all 1 revision of this API.