Each API call requires the action "act" parameter and your private API key "token" parameter.
Parameters:
base-url: https://api.emailondeck.com/api.php token: [Provide to you] act: create_email delete_email delete_email_domain delete_message list_email_addresses list_email_domains message_count message_count_domain message_count_email send_email view_email_headers view_raw_email
Example usage:
* can be POST or GET
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=[SEE-ABOVE]
Create a new email address.
Parameters:
handle: (alphanumeric, or empty to auto generate) domain: (available domain, or empty to auto generate)
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=create_email&handle=john&domain=example.com
Response:
On success: "success:" followed by email address On error: "error:" followed by error message
Delete email address and all associated messages.
Parameters:
email_address (required)
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=delete_email&email_address=john@example.com
Response:
On success: "success" On error: "error:" followed by error message
Delete all email addresses, and associated messages for a given email domain.
Parameters:
domain (required)
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=delete_email_domain&domain=example.com
Response:
On success: "success" On error: "error:" followed by error message
Delete a specific message.
Parameters:
msg_id (required)
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=delete_message&msg_id=204
Response:
On success: "success" On error: "error:" followed by error message
Delete a specific message.
Parameters:
email_address (required)
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=delete_message_all&email_address=john@example.com
Response:
On success: "success" On error: "error:" followed by error message
List all email addresses for a specific domain.
Parameters:
domain (required)
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=list_email_addresses&domain=example.com
Response:
On success: "success:" followed by email addresses is CSV format On error: "error:" followed by error message
List all available email domains.
Parameters:
n\a
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=list_email_domains
Response:
On success: "success:" followed by available email domains is CSV format On error: "error:" followed by error message
Total number of messages in entire account.
Parameters:
n\a
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=message_count
Response:
On success: "success:" followed by the number of messages On error: "error:" followed by error message
Total number of messages for an email domain.
Parameters:
domain (required)
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=message_count_domain&domain=example.com
Response:
On success: "success:" followed by the number of messages On error: "error:" followed by error message
Total number of messages for an email address.
Parameters:
email_address (required)
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=message_count_email&email_address=john@example.com
Response:
On success: "success:" followed by the number of messages On error: "error:" followed by error message
Unavailable via API. Listed here purely as informational
Parameters:
n\a
Example usage:
n\a
Response:
n\a
Total number of messages for an email address.
Parameters:
email_address (required)
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=view_email_headers&email_address=john@example.com
Response:
On success: JSON with message headers * Message Headers JSON: * msg_id: The message ID * received: The time message was recevied by the server * from: The message FROM address * subject: The message SUBJECT * success: "no messages found" - if no messages found On error: "error:" followed by error message
View the raw email for a specific message.
Parameters:
msg_id (required)
Example usage:
https://api.emailondeck.com/api.php?token=[YOUR-PRIVATE-KEY]&act=view_raw_email&msg_id=204
Response:
On success: The raw full email message On error: "error:" followed by error message