Class: Files::EmailIncomingMessage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of EmailIncomingMessage.



7
8
9
10
 
# File 'lib/files.com/models/email_incoming_message.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_incoming_message.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_incoming_message.rb', line 5

def options
  @options
end

Class Method Details

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



78
79
80
 
# File 'lib/files.com/models/email_incoming_message.rb', line 78

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).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`, `sender`, `status` or `inbox_id`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `inbox_id`, `sender` or `status`. Valid field combinations are `[ sender, created_at ]`, `[ status, created_at ]`, `[ inbox_id, created_at ]`, `[ inbox_id, status, created_at ]` or `[ inbox_id, status, sender, created_at ]`.
filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `sender`.
filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.

Raises:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/files.com/models/email_incoming_message.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: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
  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_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].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)
  raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)

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

Instance Method Details

#body ⇒ Object

string - Body of the email



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

def body
  @attributes[:body]
end

#created_at ⇒ Object

date-time - Message creation date/time



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

def created_at
  @attributes[:created_at]
end

#id ⇒ Object

int64 - Id of the Email Incoming Message



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

def id
  @attributes[:id]
end

#inbox_id ⇒ Object

int64 - Id of the Inbox associated with this message



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

def inbox_id
  @attributes[:inbox_id]
end

#message ⇒ Object

string - Message describing the failure



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

def message
  @attributes[:message]
end

#sender ⇒ Object

string - Sender of the email



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

def sender
  @attributes[:sender]
end

#sender_name ⇒ Object

string - Sender name



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

def sender_name
  @attributes[:sender_name]
end

#status ⇒ Object

string - Status of the message



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

def status
  @attributes[:status]
end