Method: Mandrill::Messages#cancel_scheduled

Defined in:
lib/mandrill/api.rb

#cancel_scheduled(id) ⇒ Hash

Cancels a scheduled email.

Parameters:

  • id (String) —

    a scheduled email id, as returned by any of the messages/send calls or messages/list-scheduled

Returns:

  • (Hash) —

    information about the scheduled email that was cancelled.

    • String

      _id the scheduled message id

    • String

      created_at the UTC timestamp when the message was created, in YYYY-MM-DD HH:MM:SS format

    • String

      send_at the UTC timestamp when the message will be sent, in YYYY-MM-DD HH:MM:SS format

    • String

      from_email the email’s sender address

    • String

      to the email’s recipient

    • String

      subject the email’s subject



1131
1132
1133
1134
 
# File 'lib/mandrill/api.rb', line 1131

def cancel_scheduled(id)
    _params = {:id => id}
    return @master.call 'messages/cancel-scheduled', _params
end