Email Incoming Messages

An EmailIncomingMessage is an audit log designed to track status of email to inbox uploads.

List Email Incoming Messages

Endpoint

GET/email_incoming_messages

Return Object

EmailIncomingMessage[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

curl https://app.files.com/api/rest/v1/email_incoming_messages.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "inbox_id": 1,
    "sender": "example",
    "sender_name": "example",
    "status": "success",
    "body": "example",
    "message": "example",
    "created_at": "2000-01-01T01:00:00Z",
    "inbox_title": "Inbox Title"
  }
]

The EmailIncomingMessage Object

Some of the endpoints above return a EmailIncomingMessage object. The attributes of this object are listed below.

AttributeDescription
id
int64		Id of the Email Incoming Message
inbox_id
int64		Id of the Inbox associated with this message
sender
string		Sender of the email
sender_name
string		Sender name
status
string		Status of the message
Possible values: success, partial_failure, failure, skipped
body
string		Body of the email
message
string		Message describing the failure
created_at
date-time		Message creation date/time
inbox_title
string		Title of the Inbox associated with this message

Example EmailIncomingMessage Object

{
  "id": 1,
  "inbox_id": 1,
  "sender": "example",
  "sender_name": "example",
  "status": "success",
  "body": "example",
  "message": "example",
  "created_at": "2000-01-01T01:00:00Z",
  "inbox_title": "Inbox Title"
}