mandrill-api 1.0.49 → 1.0.55

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ba5d218cdae924880eabda68b5168694cb51d4231a435f3c27d798a825a2fd1
+  data.tar.gz: 88f79993a7ac30a36beb6d73fc8a22e1cd61db2e88cbeab663cbb3b165f627e8
+SHA512:
+  metadata.gz: 56e9f88f4192ca42d5a900eaf558487708e564109dd31603d86550188e9ebe936501c32d515c5936eb448b0fb80c263e69af0ccbfa5b72e64a2d0e594bbcb3dc
+  data.tar.gz: 686d3f646ece2704e864b8994e179b0e39d04b56e8f6d878de3b56a54a7556ce9bd59e7d28d39d85133251fc74c1dda6bba402c95ef40e1a65988242c07c7433

data/lib/mandrill.rb

@@ -71,10 +71,16 @@ module Mandrill
                 'Unknown_Export' => UnknownExportError,
                 'IP_ProvisionLimit' => IPProvisionLimitError,
                 'Unknown_Pool' => UnknownPoolError,
+                'NoSendingHistory' => NoSendingHistoryError,
+                'PoorReputation' => PoorReputationError,
                 'Unknown_IP' => UnknownIPError,
                 'Invalid_EmptyDefaultPool' => InvalidEmptyDefaultPoolError,
                 'Invalid_DeleteDefaultPool' => InvalidDeleteDefaultPoolError,
-                'Invalid_DeleteNonEmptyPool' => InvalidDeleteNonEmptyPoolError
+                'Invalid_DeleteNonEmptyPool' => InvalidDeleteNonEmptyPoolError,
+                'Invalid_CustomDNS' => InvalidCustomDNSError,
+                'Invalid_CustomDNSPending' => InvalidCustomDNSPendingError,
+                'Metadata_FieldLimit' => MetadataFieldLimitError,
+                'Unknown_MetadataField' => UnknownMetadataFieldError
             }
 
             begin
@@ -134,6 +140,9 @@ module Mandrill
         def senders()
             Senders.new self
         end
+        def metadata()
+            Metadata.new self
+        end
     end
 end
 

data/lib/mandrill/api.rb

@@ -447,7 +447,7 @@ module Mandrill
         # @return [Array] Up to 1000 rejection entries
         #     - [Hash] return[] the information for each rejection blacklist entry
         #         - [String] email the email that is blocked
-        #         - [String] reason the type of event (hard-bounce, soft-bounce, spam, unsub) that caused this rejection
+        #         - [String] reason the type of event (hard-bounce, soft-bounce, spam, unsub, custom) that caused this rejection
         #         - [String] detail extended details about the event, such as the SMTP diagnostic for bounces or the comment for manually-created rejections
         #         - [String] created_at when the email was added to the blacklist
         #         - [String] last_event_at the timestamp of the most recent event that either created or renewed this rejection
@@ -797,17 +797,18 @@ module Mandrill
         #     - [String] signing_domain a custom domain to use for SPF/DKIM signing instead of mandrill (for "via" or "on behalf of" in email clients)
         #     - [String] return_path_domain a custom domain to use for the messages's return-path
         #     - [Boolean] merge whether to evaluate merge tags in the message. Will automatically be set to true if either merge_vars or global_merge_vars are provided.
+        #     - [String] merge_language the merge tag language to use when evaluating merge tags, either mailchimp or handlebars
         #     - [Array] global_merge_vars global merge variables to use for all recipients. You can override these per recipient.
         #         - [Hash] global_merge_vars[] a single global merge variable
         #             - [String] name the global merge variable's name. Merge variable names are case-insensitive and may not start with _
-        #             - [String] content the global merge variable's content
+        #             - [Mixed] content the global merge variable's content
         #     - [Array] merge_vars per-recipient merge variables, which override global merge variables with the same name.
         #         - [Hash] merge_vars[] per-recipient merge variables
         #             - [String] rcpt the email address of the recipient that the merge variables should apply to
         #             - [Array] vars the recipient's merge variables
         #                 - [Hash] vars[] a single merge variable
         #                     - [String] name the merge variable's name. Merge variable names are case-insensitive and may not start with _
-        #                     - [String] content the merge variable's content
+        #                     - [Mixed] content the merge variable's content
         #     - [Array] tags an array of string to tag the message with.  Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently.  Tags should be 50 characters or less.  Any tags starting with an underscore are reserved for internal use and will cause errors.
         #         - [String] tags[] a single tag - must not start with an underscore
         #     - [String] subaccount the unique id of a subaccount for this message - must already exist or will fail with an error
@@ -831,11 +832,11 @@ module Mandrill
         # @param [Boolean] async enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of "queued" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async.
         # @param [String] ip_pool the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.
         # @param [String] send_at when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance.
-        # @return [Array] of structs for each recipient containing the key "email" with the email address and "status" as either "sent", "queued", or "rejected"
+        # @return [Array] of structs for each recipient containing the key "email" with the email address, and details of the message status for that recipient
         #     - [Hash] return[] the sending results for a single recipient
         #         - [String] email the email address of the recipient
         #         - [String] status the sending status of the recipient - either "sent", "queued", "scheduled", "rejected", or "invalid"
-        #         - [String] reject_reason the reason for the rejection if the recipient status is "rejected"
+        #         - [String] reject_reason the reason for the rejection if the recipient status is "rejected" - one of "hard-bounce", "soft-bounce", "spam", "unsub", "custom", "invalid-sender", "invalid", "test-mode-limit", or "rule"
         #         - [String] _id the message's unique id
         def send(message, async=false, ip_pool=nil, send_at=nil)
             _params = {:message => message, :async => async, :ip_pool => ip_pool, :send_at => send_at}
@@ -874,17 +875,18 @@ module Mandrill
         #     - [String] signing_domain a custom domain to use for SPF/DKIM signing instead of mandrill (for "via" or "on behalf of" in email clients)
         #     - [String] return_path_domain a custom domain to use for the messages's return-path
         #     - [Boolean] merge whether to evaluate merge tags in the message. Will automatically be set to true if either merge_vars or global_merge_vars are provided.
+        #     - [String] merge_language the merge tag language to use when evaluating merge tags, either mailchimp or handlebars
         #     - [Array] global_merge_vars global merge variables to use for all recipients. You can override these per recipient.
         #         - [Hash] global_merge_vars[] a single global merge variable
         #             - [String] name the global merge variable's name. Merge variable names are case-insensitive and may not start with _
-        #             - [String] content the global merge variable's content
+        #             - [Mixed] content the global merge variable's content
         #     - [Array] merge_vars per-recipient merge variables, which override global merge variables with the same name.
         #         - [Hash] merge_vars[] per-recipient merge variables
         #             - [String] rcpt the email address of the recipient that the merge variables should apply to
         #             - [Array] vars the recipient's merge variables
         #                 - [Hash] vars[] a single merge variable
         #                     - [String] name the merge variable's name. Merge variable names are case-insensitive and may not start with _
-        #                     - [String] content the merge variable's content
+        #                     - [Mixed] content the merge variable's content
         #     - [Array] tags an array of string to tag the message with.  Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently.  Tags should be 50 characters or less.  Any tags starting with an underscore are reserved for internal use and will cause errors.
         #         - [String] tags[] a single tag - must not start with an underscore
         #     - [String] subaccount the unique id of a subaccount for this message - must already exist or will fail with an error
@@ -908,19 +910,19 @@ module Mandrill
         # @param [Boolean] async enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of "queued" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async.
         # @param [String] ip_pool the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.
         # @param [String] send_at when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance.
-        # @return [Array] of structs for each recipient containing the key "email" with the email address and "status" as either "sent", "queued", "scheduled", or "rejected"
+        # @return [Array] of structs for each recipient containing the key "email" with the email address, and details of the message status for that recipient
         #     - [Hash] return[] the sending results for a single recipient
         #         - [String] email the email address of the recipient
         #         - [String] status the sending status of the recipient - either "sent", "queued", "rejected", or "invalid"
-        #         - [String] reject_reason the reason for the rejection if the recipient status is "rejected"
+        #         - [String] reject_reason the reason for the rejection if the recipient status is "rejected" - one of "hard-bounce", "soft-bounce", "spam", "unsub", "custom", "invalid-sender", "invalid", "test-mode-limit", or "rule"
         #         - [String] _id the message's unique id
         def send_template(template_name, template_content, message, async=false, ip_pool=nil, send_at=nil)
             _params = {:template_name => template_name, :template_content => template_content, :message => message, :async => async, :ip_pool => ip_pool, :send_at => send_at}
             return @master.call 'messages/send-template', _params
         end
 
-        # Search the content of recently sent messages and optionally narrow by date range, tags and senders
-        # @param [String] query the search terms to find matching messages for
+        # Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use <a href="/api/docs/messages.html#method=info">/messages/info.json</a> to get the information for a single message, or <a href="http://help.mandrill.com/entries/21738186-Introduction-to-Webhooks">webhooks</a> to push activity to your own application for querying.
+        # @param [String] query <a href="http://help.mandrill.com/entries/22211902">search terms</a> to find matching messages
         # @param [String] date_from start date
         # @param [String] date_to end date
         # @param [Array] tags an array of tag names to narrow the search to, will return messages that contain ANY of the tags
@@ -1091,18 +1093,18 @@ module Mandrill
         # @param [String] ip_pool the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.
         # @param [String] send_at when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately.
         # @param [String] return_path_domain a custom domain to use for the messages's return-path
-        # @return [Array] of structs for each recipient containing the key "email" with the email address and "status" as either "sent", "queued", or "rejected"
+        # @return [Array] of structs for each recipient containing the key "email" with the email address, and details of the message status for that recipient
         #     - [Hash] return[] the sending results for a single recipient
         #         - [String] email the email address of the recipient
         #         - [String] status the sending status of the recipient - either "sent", "queued", "scheduled", "rejected", or "invalid"
-        #         - [String] reject_reason the reason for the rejection if the recipient status is "rejected"
+        #         - [String] reject_reason the reason for the rejection if the recipient status is "rejected" - one of "hard-bounce", "soft-bounce", "spam", "unsub", "custom", "invalid-sender", "invalid", "test-mode-limit", or "rule"
         #         - [String] _id the message's unique id
         def send_raw(raw_message, from_email=nil, from_name=nil, to=nil, async=false, ip_pool=nil, send_at=nil, return_path_domain=nil)
             _params = {:raw_message => raw_message, :from_email => from_email, :from_name => from_name, :to => to, :async => async, :ip_pool => ip_pool, :send_at => send_at, :return_path_domain => return_path_domain}
             return @master.call 'messages/send-raw', _params
         end
 
-        # Queries your scheduled emails by sender or recipient, or both.
+        # Queries your scheduled emails.
         # @param [String] to an optional recipient address to restrict results to
         # @return [Array] a list of up to 1000 scheduled emails
         #     - [Hash] return[] a scheduled email
@@ -1156,11 +1158,12 @@ module Mandrill
 
         # Adds an email to your email rejection whitelist. If the address is currently on your blacklist, that blacklist entry will be removed automatically.
         # @param [String] email an email address to add to the whitelist
+        # @param [String] comment an optional description of why the email was whitelisted
         # @return [Hash] a status object containing the address and the result of the operation
         #     - [String] email the email address you provided
-        #     - [Boolean] whether the operation succeeded
-        def add(email)
-            _params = {:email => email}
+        #     - [Boolean] added whether the operation succeeded
+        def add(email, comment=nil)
+            _params = {:email => email, :comment => comment}
             return @master.call 'whitelists/add', _params
         end
 
@@ -1888,7 +1891,7 @@ module Mandrill
             return @master.call 'senders/check-domain', _params
         end
 
-        # Sends a verification email in order to verify ownership of a domain. Domain verification is an optional step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
+        # Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
         # @param [String] domain a domain name at which you can receive email
         # @param [String] mailbox a mailbox at the domain where the verification email should be sent
         # @return [Hash] information about the verification that was sent
@@ -1994,5 +1997,59 @@ module Mandrill
         end
 
     end
+    class Metadata
+        attr_accessor :master
+
+        def initialize(master)
+            @master = master
+        end
+
+        # Get the list of custom metadata fields indexed for the account.
+        # @return [Array] the custom metadata fields for the account
+        #     - [Hash] return[] the individual custom metadata field info
+        #         - [String] name the unique identifier of the metadata field to update
+        #         - [String] state the current state of the metadata field, one of "active", "delete", or "index"
+        #         - [String] view_template Mustache template to control how the metadata is rendered in your activity log
+        def list()
+            _params = {}
+            return @master.call 'metadata/list', _params
+        end
+
+        # Add a new custom metadata field to be indexed for the account.
+        # @param [String] name a unique identifier for the metadata field
+        # @param [String] view_template optional Mustache template to control how the metadata is rendered in your activity log
+        # @return [Hash] the information saved about the new metadata field
+        #     - [String] name the unique identifier of the metadata field to update
+        #     - [String] state the current state of the metadata field, one of "active", "delete", or "index"
+        #     - [String] view_template Mustache template to control how the metadata is rendered in your activity log
+        def add(name, view_template=nil)
+            _params = {:name => name, :view_template => view_template}
+            return @master.call 'metadata/add', _params
+        end
+
+        # Update an existing custom metadata field.
+        # @param [String] name the unique identifier of the metadata field to update
+        # @param [String] view_template optional Mustache template to control how the metadata is rendered in your activity log
+        # @return [Hash] the information for the updated metadata field
+        #     - [String] name the unique identifier of the metadata field to update
+        #     - [String] state the current state of the metadata field, one of "active", "delete", or "index"
+        #     - [String] view_template Mustache template to control how the metadata is rendered in your activity log
+        def update(name, view_template)
+            _params = {:name => name, :view_template => view_template}
+            return @master.call 'metadata/update', _params
+        end
+
+        # Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
+        # @param [String] name the unique identifier of the metadata field to update
+        # @return [Hash] the information for the deleted metadata field
+        #     - [String] name the unique identifier of the metadata field to update
+        #     - [String] state the current state of the metadata field, one of "active", "delete", or "index"
+        #     - [String] view_template Mustache template to control how the metadata is rendered in your activity log
+        def delete(name)
+            _params = {:name => name}
+            return @master.call 'metadata/delete', _params
+        end
+
+    end
 end
 

data/lib/mandrill/errors.rb

@@ -39,6 +39,10 @@ module Mandrill
     end
     class UnknownPoolError < Error
     end
+    class NoSendingHistoryError < Error
+    end
+    class PoorReputationError < Error
+    end
     class UnknownIPError < Error
     end
     class InvalidEmptyDefaultPoolError < Error
@@ -47,5 +51,13 @@ module Mandrill
     end
     class InvalidDeleteNonEmptyPoolError < Error
     end
+    class InvalidCustomDNSError < Error
+    end
+    class InvalidCustomDNSPendingError < Error
+    end
+    class MetadataFieldLimitError < Error
+    end
+    class UnknownMetadataFieldError < Error
+    end
 end
 

metadata

@@ -1,113 +1,86 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mandrill-api
-version: !ruby/object:Gem::Version 
-  hash: 117
-  prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 49
-  version: 1.0.49
+version: !ruby/object:Gem::Version
+  version: 1.0.55
 platform: ruby
-authors: 
+authors:
 - Mandrill Devs
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-10-17 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2021-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 7
-        - 7
+      - !ruby/object:Gem::Version
         version: 1.7.7
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: excon
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 95
-        segments: 
-        - 0
-        - 16
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.16.0
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id002
-description: A Ruby API library for the Mandrill email as a service platform.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Deprecated. Replaced by MailchimpTransactional - A Ruby API library for
+  the Mandrill email as a service platform.
 email: community@mandrill.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/mandrill.rb
 - lib/mandrill/api.rb
 - lib/mandrill/errors.rb
 homepage: https://bitbucket.org/mailchimp/mandrill-api-ruby/
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
-summary: A Ruby API library for the Mandrill email as a service platform.
+specification_version: 4
+summary: Deprecated. Replaced by MailchimpTransactional - A Ruby API library for the
+  Mandrill email as a service platform.
 test_files: []
-
-has_rdoc: