Class: MailUp::Console::User

Inherits:

Object

• Object
• MailUp::Console::User

Defined in:

lib/mailup/console/user.rb

Instance Attribute Summary

• #api ⇒ Object

  Returns the value of attribute api.

Instance Method Summary

• #emails(params = {}) ⇒ JSON

  Retrieve the email messages (cloned and not cloned) for the current user.

• #initialize(api) ⇒ User constructor

  A new instance of User.

• #lists(params = {}) ⇒ JSON

  Retrieve the admin console lists for the current user.

Constructor Details

#initialize(api) ⇒ User

Returns a new instance of User.

# File 'lib/mailup/console/user.rb', line 6

def initialize(api)
    @api = api
end

Instance Attribute Details

#api ⇒ Object

Returns the value of attribute api.

# File 'lib/mailup/console/user.rb', line 4

def api
  @api
end

Instance Method Details

#emails(params = {}) ⇒ JSON

Retrieve the email messages (cloned and not cloned) for the current user.

Examples:

emails = mailup.console.user.emails
emails['TotalElementsCount']
=> 10
emails['Items'].first['Subject']
=> "Test Subject"

emails = mailup.console.user.emails(pageNumber: 0, pageSize: 1)

Parameters:

• params (Hash) (defaults to: {}) —

  Optional params or filters:

Options Hash (params):

• :pageNumber (Integer) —

  The page number to return.

• :pageSize (Integer) —

  The number of results to per page.

• :filterby (String) —

  A filtering expression.

• :orderby (String) —

  The sorting condition for the results.

Returns:

• (JSON) —

  Results and data including:

  • IsPaginated [Boolean]

  • Items [Array<Hash>]

  • PageNumber [Integer]

  • PageSize [Integer]

  • Skipped [Integer]

  • TotalElementsCount [Integer]

See Also:

• http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetMailMessagesByUser

# File 'lib/mailup/console/user.rb', line 71

def emails(params={})
  @api.get("#{@api.path}/User/Emails", params: params)
end

#lists(params = {}) ⇒ JSON

Retrieve the admin console lists for the current user.

Examples:

lists = mailup.console.user.lists
lists = mailup.console.user.lists
lists['TotalElementsCount']
=> 10
lists['Items'].first['Name']
=> "Test List"

lists = mailup.console.user.lists(pageNumber: 0, pageSize: 250)

Parameters:

• params (Hash) (defaults to: {}) —

  Optional params or filters:

Options Hash (params):

• :pageNumber (Integer) —

  The page number to return.

• :pageSize (Integer) —

  The number of results to per page.

• :filterby (String) —

  A filtering expression.

• :orderby (String) —

  The sorting condition for the results.

Returns:

• (JSON) —

  Results and data including:

  • IsPaginated [Boolean]

  • Items [Array<Hash>]

  • PageNumber [Integer]

  • PageSize [Integer]

  • Skipped [Integer]

  • TotalElementsCount [Integer]

See Also:

• http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetConsoleListsByUser

# File 'lib/mailup/console/user.rb', line 39

def lists(params = {})
  @api.get("#{@api.path}/User/Lists", params: params)
end