Class: MailUp::Console::Email

Inherits:

Object

• Object
• MailUp::Console::Email

Defined in:

lib/mailup/console/email.rb

Instance Attribute Summary

• #api ⇒ Object

  Returns the value of attribute api.

Instance Method Summary

• #initialize(api) ⇒ Email constructor

  A new instance of Email.

• #send(message_id, email) ⇒ JSON

  Send single email message to specified recipient.

Constructor Details

#initialize(api) ⇒ Email

Returns a new instance of Email.

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

def initialize(api)
    @api = api
end

Instance Attribute Details

#api ⇒ Object

Returns the value of attribute api.

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

def api
  @api
end

Instance Method Details

#send(message_id, email) ⇒ JSON

Send single email message to specified recipient.

Examples:

send = mailup.console.email.send(5, 'joe@public.com')
send['Sent']
=> 1

Parameters:

• message_id (Integer) —

  The ID of the message to send.

• email (String) —

  The email address of the recipient.

Returns:

• (JSON) —

  A Send object with the following attributes:

  • idMessage [Integer]

  • Sent [Integer]

  • UnprocessedRecipients [Array]

  • InvalidRecipients [Array]

See Also:

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

# File 'lib/mailup/console/email.rb', line 29

def send(message_id, email)
  @api.post("#{@api.path}/Email/Send", body: {:idMessage => message_id, :Email => email})
end