Module: Paperdrive::Client::MailThreads

Includes:
Parameters
Included in:
Paperdrive::Client
Defined in:
lib/paperdrive/client/mail_threads.rb

Overview

Instance methods related to MailThreads to embed into Paperdrive::Client
arguments are compatible with the Pipedribe API.

See Also:

Instance Method Summary collapse

Instance Method Details

#all_mail_threads(**args) ⇒ Paperdrive::Response

GET

Get mail threads

Returns:

See Also:



18
19
20
21
22
23
24
 
# File 'lib/paperdrive/client/mail_threads.rb', line 18

def all_mail_threads(**args)
  params = parameters(args) do
    required_params :folder
    optional_params :folder, :start, :limit
  end
  request(:get, 'mailbox/mailThreads', params)
end

#delete_mail_thread(id:, **args) ⇒ Paperdrive::Response

DELETE

Delete mail thread

Parameters:

  • id: (integer)

Returns:

See Also:



67
68
69
70
71
72
 
# File 'lib/paperdrive/client/mail_threads.rb', line 67

def delete_mail_thread(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:delete, "mailbox/mailThreads/#{id}", params)
end

#mail_thread(id:, **args) ⇒ Paperdrive::Response

GET

Get one mail thread

Parameters:

  • id: (integer)

Returns:

See Also:



31
32
33
34
35
36
 
# File 'lib/paperdrive/client/mail_threads.rb', line 31

def mail_thread(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "mailbox/mailThreads/#{id}", params)
end

#mail_thread_mail_messages(id:, **args) ⇒ Paperdrive::Response

GET

Get all mail messages of mail thread

Parameters:

  • id: (integer)

Returns:

See Also:



43
44
45
46
47
48
 
# File 'lib/paperdrive/client/mail_threads.rb', line 43

def mail_thread_mail_messages(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "mailbox/mailThreads/#{id}/mailMessages", params)
end

#update_mail_thread(id:, **args) ⇒ Paperdrive::Response

PUT

Update mail thread details

Parameters:

  • id: (integer)

Returns:

See Also:



55
56
57
58
59
60
 
# File 'lib/paperdrive/client/mail_threads.rb', line 55

def update_mail_thread(id:, **args)
  params = parameters(args) do
    optional_params :deal_id, :shared_flag, :read_flag, :archived_flag
  end
  request(:put, "mailbox/mailThreads/#{id}", params)
end