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::EmailIncomingMessage.list

Return Object

List<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

begin
  email_incoming_messages = Files::EmailIncomingMessage.list
  email_incoming_messages.auto_paging_each do |email_incoming_message|
    # Operate on email_incoming_message
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The EmailIncomingMessage Object

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

Attribute	Description
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