logo

Retrieve an email credential

Retrieves an email credential with a specified token ID.

SecuritySecretApiKey or JWT
Request
path Parameters
hash
required
string

ID of the token.

Responses
200

Email credential retrieved.

Response Schema: application/json
host
required
string

SMTP host name.

hash
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

deactivationTime
string <date-time>

Date and time when the credential is deactivated.

port
integer [ 1 .. 65535 ]
Default: 25

SMTP port value.

encryption
string
Default: "none"

Encryption value.

Enum: "none" "tls" "ssl"
object (SmtpAuthorization)

Authentication type and details.

type
string
Default: "none"
Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/credential-hashes/emails/{hash}
Request samples 
const details = await api.credentialHashes.getEmailCredential({hash: 'foobar-001'});
console.log(details.fields.host);
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "host": "string",
  • "port": 25,
  • "encryption": "none",
  • "auth": {
    },
  • "_links": [
    ]
}
➔ Next to Update an email credential