Email Logs

An EmailLog is a record of the email notifications that were sent. This information is helpful for auditing your site's outbound emails.

Logs available through this endpoint are retained for 6 months, after which they are automatically discarded. For longer retention, use Files.com SIEM integrations to stream logs in real time to your preferred SIEM, or configure SIEM streaming to a file.

List Email Logs

SDK Method

Files::EmailLog.list

Return Object

List<EmailLog>

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_logs = Files::EmailLog.list
  email_logs.auto_paging_each do |email_log|
    # Operate on email_log
  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 EmailLog Object

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

AttributeDescription
timestamp
date-time		Start Time of Action. Deprecrated: Use created_at.
message
string		Log Message
status
string		Status of E-Mail delivery
Possible values: success, failure, suppressed
subject
string		Subject line of E-Mail
to
string		To field of E-Mail
cc
string		CC field of E-Mail
delivery_method
string		How was the email delivered? customer_smtp or files.com
smtp_hostname
string		Customer SMTP Hostname used.
smtp_ip
string		Customer SMTP IP address as resolved for use (useful for troubleshooting DNS issues with customer SMTP).
created_at
date-time		Start Time of Action