Class: MailUp::Console::Import

Inherits:

Object

• Object
• MailUp::Console::Import

Defined in:

lib/mailup/console/import.rb

Instance Attribute Summary

• #api ⇒ Object

  Returns the value of attribute api.

Instance Method Summary

• #confirmation_email_id ⇒ Object

  Get Sending Confirmation Email Id.

• #initialize(id, api) ⇒ Import constructor

  A new instance of Import.

• #status ⇒ JSON

  Get import status.

Constructor Details

#initialize(id, api) ⇒ Import

Returns a new instance of Import.

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

def initialize(id, api)
  @api = api
  @id = id
end

Instance Attribute Details

#api ⇒ Object

Returns the value of attribute api.

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

def api
  @api
end

Instance Method Details

#confirmation_email_id ⇒ Object

Get Sending Confirmation Email Id.

See Also:

• http://help.mailup.com/display/mailupapi/Recipients#Recipients-SendConfirmationEmail

# File 'lib/mailup/console/import.rb', line 40

def confirmation_email_id
  @api.get("#{@api.path}/Import/#{@id}/Sending")
end

#status ⇒ JSON

Get import status.

Examples:

status = mailup.console.import(9).status
status['Completed']
=> true
status['UpdatedRecipients']
=> 159

Returns:

• (JSON) —

  A Status object with the following attributes:

  • idImport [Integer]

  • Completed [Boolean]

  • UpdatedRecipients [Integer]

  • ValidRecipients [Integer]

  • CreatedRecipients [Integer]

  • ImportedRecipients [Integer]

  • NotValidRecipients [Integer]

See Also:

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

# File 'lib/mailup/console/import.rb', line 32

def status
  @api.get("#{@api.path}/Import/#{@id}")
end