Email Incoming Messages

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

List Email Incoming Messages

SDK Method

\Files\Model\EmailIncomingMessage::list;

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

try {
  $email_incoming_messages = \Files\Model\EmailIncomingMessage::list();
  foreach ($email_incoming_messages as $email_incoming_message) {
    // Operate on $email_incoming_message
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The EmailIncomingMessage Object

Some of the methods 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