Class: Files::EmailLog

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/email_log.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ EmailLog

Returns a new instance of EmailLog.



7
8
9
10
 
# File 'lib/files.com/models/email_log.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/email_log.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/email_log.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



73
74
75
 
# File 'lib/files.com/models/email_log.rb', line 73

def self.all(params = {}, options = {})
  list(params, options)
end

.list(params = {}, options = {}) ⇒ Object

Parameters:

cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.
filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.

Raises:



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/files.com/models/email_log.rb', line 62

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)

  List.new(EmailLog, params) do
    Api.send_request("/email_logs", :get, params, options)
  end
end

Instance Method Details

#cc ⇒ Object

string - CC field of E-Mail



38
39
40
 
# File 'lib/files.com/models/email_log.rb', line 38

def cc
  @attributes[:cc]
end

#delivery_method ⇒ Object

string - How was email deliered? ‘customer_smtp` or `files.com`



43
44
45
 
# File 'lib/files.com/models/email_log.rb', line 43

def delivery_method
  @attributes[:delivery_method]
end

#message ⇒ Object

string - Log Message



18
19
20
 
# File 'lib/files.com/models/email_log.rb', line 18

def message
  @attributes[:message]
end

#smtp_hostname ⇒ Object

string - Customer SMTP Hostname used.



48
49
50
 
# File 'lib/files.com/models/email_log.rb', line 48

def smtp_hostname
  @attributes[:smtp_hostname]
end

#smtp_ip ⇒ Object

string - Customer SMTP IP address as resolved for use (useful for troubleshooting DNS issues with customer SMTP).



53
54
55
 
# File 'lib/files.com/models/email_log.rb', line 53

def smtp_ip
  @attributes[:smtp_ip]
end

#status ⇒ Object

string - Status of E-Mail delivery



23
24
25
 
# File 'lib/files.com/models/email_log.rb', line 23

def status
  @attributes[:status]
end

#subject ⇒ Object

string - Subject line of E-Mail



28
29
30
 
# File 'lib/files.com/models/email_log.rb', line 28

def subject
  @attributes[:subject]
end

#timestamp ⇒ Object

date-time - Start Time of Action



13
14
15
 
# File 'lib/files.com/models/email_log.rb', line 13

def timestamp
  @attributes[:timestamp]
end

#to ⇒ Object

string - To field of E-Mail



33
34
35
 
# File 'lib/files.com/models/email_log.rb', line 33

def to
  @attributes[:to]
end