Email Yak Documentation
Navigation
  • Main Page
  • Quick Start Guide
  • How it works
  • Setup Your Domain
  • Sandbox
  • POST Requests
  • GET Requests
  • Domain Ownership
  • SPF Record
  • Push Email
  • Push Notifications
  • Parsed Data
  • Post Authentication
  • Status Codes
  • Register Domain
  • Register Address
  • Send Email
  • Get Email
  • Get Email List
  • Get All Email
  • Get New Email
  • Delete Email

Get Email

Information

URL: https://api.emailyak.com/v1/private_api_key/json/get/email/
Request type: GET
Response Content-Type: application/json; charset=utf-8

Input

EmailID - the email ID. Each email is assigned a random string of 8 characters to serve as the EmailID.

GetHeaders (optional) - a boolean value. Specifies if you would like to receive all the headers for the email. The value should be a "True", "true", or 1.

Output

Status - the status code for the response. Read more about status codes.

Message - a short message with information about your request. If there was an error, a short description of the error will be provided.

EmailID - the email ID assigned to the email.

FromAddress - the original sender of the email.

FromName - the original name of the sender, if provided. 

ToAddress - the recipient of the email. The mailbox that actually received the email.

ToAddressList - a comma-separated list of all intended recipients of the email. All addresses listed on the email envelope under "To" will be included.

CcAddressList - a comma-separated list of all cc'd recipients of the email. All addresses listed on the email envelope under "Cc" will be included.

Subject - the subject of the email.

HtmlBody - the HTML body of the email. If an HTML body is not included, this field will still be included but it will be an empty string.

TextBody - the body of the email.

ParsedData - a list of key-value sets containing the information parsed from the email. Different data types may be parsed, depending on availability. To find out more or view a list of the current parsed data types, see Parsed Data. 

RapleafData - key-value pairs of data about the sender of the email, the "FromAddress" email address. Currently, "gender", "age", and "location" are provided, if the data is available for the address. If you are interested in receiving premium Rapleaf data, which has much more info available, please contact support@emailyak.com.

Received - a datetime stamp of when the email was received.

Headers (if requested) - a list of key-value pairs with the "Name" and "Value" of each individual header.

Attachments (if any) - a list of URL's where the attachment can be downloaded.
a list of key-value pairs

Get Request URL Example


https://api.emailyak.com/v1/private_api_key/json/get/email/?EmailID=RandomEmailID&GetHeaders=True

Output JSON Example

{
	"Status": 200,
	"Message": "Success",
	"EmailID": "RandomEmailID",
	"FromAddress" : "sender@example.com",
	"ToAddress": "receiver1@example.com",
	"ToAddressList": "receiver1@example.com, receiver2@example.com",
	"CcAddressList": "receiver3@example.com, receiver4@example.com",
	"Subject" : "Test",
	"HtmlBody" : "Hello",
	"TextBody" : "Hello",
	"ParsedData" : [
		{"Type" : "DataType1", "Data" : "Value", "Key" : "Value"},
		{"Type" : "DataType2", "Data" : "Value", "Key" : "Value"}
	],
	"RapleafData": {
		"gender": "Male", 
		"age": "35-44", 
		"location": "San Francisco, California, United States"
	},
	"Received": "2010-09-11T15:55:23",
	"Headers" : [{"Name" : "Header Title", "Value" : "Value" }],
	"Attachments": [
		"https://files.emailyak.com/secret_random_key/readme.txt",
		"https://files.emailyak.com/secret_random_key/report.pdf",
	]
} 

Notes

  • Domain Ownership verification is required before any emails will be sent or received.
  • The email returned will be marked as read and will no longer appear as a new email
Create a free website with Weebly