mailgun-ruby 1.2.12 → 1.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf800982a326bb3cd2417126fc5a9de3de7ca0c4cf2c9387541244f3ee6d362d
-  data.tar.gz: f3515a9207e04c66d69afcaee25ee7aa746ee58f58ea4a48d2511363c1bc6005
+  metadata.gz: 3905ad8ab1dae85ea3b87b10d2ac01700de085adab73d9e02373f4d54e70451d
+  data.tar.gz: e5794e301066318205a9ffb6de455d73642d3162b1ad75900cefed7aa95db798
 SHA512:
-  metadata.gz: a65a2e514f1865825d8c4d7673fd2060e4dd3902402c0500e9dcf213052fff6fb7222379bd155430f30d6abf0300361228ec3cb1db53d2998b2718fb27ffb46a
-  data.tar.gz: 2f3988bcd4ecd490305543d3719b37f1531f796558879604263810d02d0bca068647634d8d9141f90711d1d9c4f3038ff29b385bdbe0df0537ac80bc451a05e1
+  metadata.gz: af8ed54564c2f13b818aa7da6a550b9000b4148ee437b108d01219d80b610580fde3a1973dd831db3ffd8b0dbe934d9288b479a335a5521e3f275815a9f30c8e
+  data.tar.gz: 5d11d20420e6333e9e71104fc529d80f19ed689cb300bc5b19ec4c2b855e9c92e24e59d7de83122d2bcdc910a0ec60f783ea277e011e8d375bb1e471be30802e

data/.ruby-env.yml.example

@@ -10,3 +10,4 @@
 MAILGUN_APIKEY : '<MAILGUN_APIKEY>'
 MAILGUN_PUB_APIKEY : '<MAILGUN_PUBLIC_APIKEY>'
 MAILGUN_TESTDOMAIN : '<MAILGUN_SANDBOX_DOMAIN>'
+

data/CHANGELOG.md

@@ -4,6 +4,26 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [1.2.14] - 2024-02-13
+
+### Added
+
+- Tags CRUD support (https://github.com/mailgun/mailgun-ruby/pull/316)
+- Additional Domain Endpoints (https://github.com/mailgun/mailgun-ruby/pull/314)
+- Webhooks Update Method (https://github.com/mailgun/mailgun-ruby/pull/305)
+- Add support for AMP HTML (https://github.com/mailgun/mailgun-ruby/pull/304)
+- Add support for AMP HTML (https://github.com/mailgun/mailgun-ruby/pull/304)
+
+### Fixed
+
+- Typos in docs, specs (- Add support for AMP HTML (https://github.com/mailgun/mailgun-ruby/pull/304)).
+
+## [1.2.13] - 2023-11-25
+
+### Added
+
+- Subaccounts API support (https://github.com/mailgun/mailgun-ruby/pull/310).
+
 ## [1.2.12] - 2023-10-22
 
 ### Added
@@ -13,4 +33,4 @@ All notable changes to this project will be documented in this file.
 ### Fixed
 
 - transform_for_mailgun block iteration issue (https://github.com/mailgun/mailgun-ruby/pull/298).
-- Typos in several files (https://github.com/mailgun/mailgun-ruby/pull/297).
+- Typos in several files (https://github.com/mailgun/mailgun-ruby/pull/297).

data/README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.2.12'
+gem 'mailgun-ruby', '~>1.2.14'
 ```
 
 Usage
@@ -188,8 +188,11 @@ This SDK includes the following components:
 - [Domains](docs/Domains.md)
 - [Webhooks](docs/Webhooks.md)
 - [Events](docs/Events.md)
+- [Snippets](docs/Snippets.md)
+- [Subaccounts](docs/Subaccounts.md)
 - [Suppressions](docs/Suppressions.md)
 - [Templates](docs/Templates.md)
+- [EmailValidation](docs/EmailValidation.md)
 
 Message Builder allows you to quickly create the array of parameters, required
 to send a message, by calling a methods for each parameter.

data/docs/Domains.md

@@ -53,5 +53,5 @@ See the [Suppressions](/docs/Suppressions.md) for usage samples and
 
 More Documentation
 ------------------
-See the official [Mailgun Domain Docs](https://documentation.mailgun.com/api-domains.html)
+See the official [Mailgun Domain Docs](https://documentation.mailgun.com/en/latest/api-domains.html)
 for more information

data/docs/EmailValidation.md

@@ -0,0 +1,34 @@
+Mailgun - Email Validation
+====================
+
+This is the Mailgun Ruby *Email Validation* utilities.
+
+The below assumes you've already installed the Mailgun Ruby SDK in to your
+project. If not, go back to the master README for instructions.
+
+Usage - Email Validation
+-----------------------
+
+```ruby
+# First, instantiate the Mailgun Address. It pulls api key for Client from Mailgun.api_key variable.
+email_validator = Mailgun::Address.new
+
+# Given an arbitrary address, validates address based off defined checks.
+# Response Example:
+# {
+#     "address": "existingemail@realdomain.com",
+#     "is_disposable_address": false,
+#     "is_role_address": false,
+#     "reason": [],
+#     "result": "deliverable",
+#     "risk": "low"
+# }
+email_validator.validate('email@example.com')
+
+
+```
+
+More Documentation
+------------------
+See the official [Mailgun Email Validation Docs](https://documentation.mailgun.com/en/latest/api-email-validation.html)
+for more information

data/docs/Events.md

@@ -42,5 +42,5 @@ last time you called "next".
 
 More Documentation
 ------------------
-See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html)
+See the official [Mailgun Docs](https://documentation.mailgun.com/en/latest/api-events.html)
 for more information.

data/docs/MessageBuilder.md

@@ -104,5 +104,5 @@ message_ids = mb_obj.finalize
 
 More Documentation
 ------------------
-See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html)
+See the official [Mailgun Docs](https://documentation.mailgun.com/en/latest/api-sending.html)
 for more information.

data/docs/Messages.md

@@ -103,5 +103,5 @@ message_ids = mb_obj.finalize
 
 More Documentation
 ------------------
-See the official [Mailgun Docs](https://documentation.mailgun.com/api-sending.html)
+See the official [Mailgun Docs](https://documentation.mailgun.com/en/latest/api-sending.html)
 for more information.

data/docs/OptInHandler.md

@@ -100,4 +100,4 @@ Available Functions
 
 More Documentation
 ------------------
-See the official [Mailgun Docs](https://documentation.mailgun.com/en/latest/api-sending.html) for more information.
+See the official [Mailgun Docs](https://documentation.mailgun.com/) for more information.

data/docs/Snippets.md

@@ -513,7 +513,7 @@ Be sure to visit the Mailgun official
 information about our API.
 
 If you find a bug, please submit the issue in Github directly.
-[Mailgun-Ruby Issues](https://github.com/mailgun/Mailgun-PHP/issues)
+[Mailgun-Ruby Issues](https://github.com/mailgun/mailgun-ruby/issues)
 
 As always, if you need additional assistance, drop us a note at
 [support@mailgun.com](mailto:support@mailgun.com).

data/docs/Subaccounts.md

@@ -0,0 +1,68 @@
+Mailgun - [Subaccounts](https://help.mailgun.com/hc/en-us/articles/16380043681435-Subaccounts)
+====================
+
+Rails
+-----
+
+The library can be initialized with a Rails initializer containing similar:
+```ruby
+Mailgun.configure do |config|
+  config.api_key = 'your-secret-api-key'
+end
+```
+Or have the initializer read your environment setting if you prefer.
+
+```ruby
+  Mailgun.api_key = 'your-secret-api-key'
+```
+
+```ruby
+  mb_obj = Mailgun::Subaccounts.new
+
+  # Get subaccounts list
+  mb_obj.get_subaccounts(limit: 10, skip: 0, sort: 'ask', enabled: true)
+  => {"subaccounts"=>[{"id"=>"XYZ", "name"=>"test.subaccount1", "status"=>"open"}, {"id"=>"YYY", "name"=>"test.subaccount2", "status"=>"open"}], "total"=>2}
+
+  # Get subaccount information
+  mb_obj.info(subaccount_id)
+  => {"subaccount"=>{"id"=>"XYZ", "name"=>"test.subaccount1", "status"=>"open"}
+
+  # Add Subaccount
+  mb_obj.create(name)
+  => {"subaccount"=>{"id"=>"XYZ", "name"=>"test.subaccount1", "status"=>"open"}}
+
+  # Disable
+  mb_obj.disable(subaccount_id)
+  => {"subaccount"=>{"id"=>"XYZ", "name"=>"test.subaccount1", "status"=>"disabled"}}
+
+  # Enable
+  mb_obj.enable(subaccount_id)
+  => {"subaccount"=>{"id"=>"XYZ", "name"=>"test.subaccount1", "status"=>"open"}}
+```
+
+Primary accounts can make API calls on behalf of their subaccounts.
+```ruby
+# First, instantiate the Mailgun Client with your API key
+mg_client = Mailgun::Client.new 'your-api-key'
+mg_client.set_subaccount('SUBACCOUNT_ID')
+
+# Define your message parameters
+message_params = {  from: 'bob@SUBACCOUNT_DOMAIN',
+                    to: 'sally@example.com',
+                    subject: 'The Ruby SDK is awesome!',
+                    text: 'It is really easy to send a message!'
+                  }
+
+# Send your message through the client
+# Note: This will not actually hit the API, and will return a generic OK response.
+mg_client.send_message('SUBACCOUNT_DOMAIN', message_params)
+
+# Reset subaccount for primary usage
+mg_client.reset_subaccount
+```
+
+
+More Documentation
+------------------
+See the official [Mailgun Docs](https://documentation.mailgun.com/en/latest/subaccounts.html#subaccounts)
+for more information.

data/docs/Suppressions.md

@@ -38,6 +38,16 @@ supp_client.list_complaints
 
 ----
 
+To get the next or previous suppressions page:
+
+```ruby
+supp_client.list_bounces # returns first *limit* records + next, previous pages urls
+supp_client.next # returns next *limit* records
+supp_client.prev # returns previous *limit* records
+```
+
+----
+
 To batch-add a set of bounces:
 
 ```ruby

data/docs/Webhooks.md

@@ -36,5 +36,5 @@ hook.remove_all 'my.perfect.domain'
 
 More Documentation
 ------------------
-See the official [Mailgun Domain Docs](https://documentation.mailgun.com/api-webhooks.html)
+See the official [Mailgun Domain Docs](https://documentation.mailgun.com/en/latest/api-webhooks.html)
 for more information

data/docs/railgun/EmailValidation.md

@@ -0,0 +1,34 @@
+Mailgun - Email Validation
+====================
+
+This is the Mailgun Ruby *Email Validation* utilities.
+
+The below assumes you've already installed the Mailgun Ruby SDK in to your
+project. If not, go back to the master README for instructions.
+
+Usage - Email Validation
+-----------------------
+
+```ruby
+# First, instantiate the Mailgun Address. It pulls api key for Client from Mailgun.api_key variable.
+email_validator = Mailgun::Address.new
+
+# Given an arbitrary address, validates address based off defined checks.
+# Response Example:
+# {
+#     "address": "existingemail@realdomain.com",
+#     "is_disposable_address": false,
+#     "is_role_address": false,
+#     "reason": [],
+#     "result": "deliverable",
+#     "risk": "low"
+# }
+email_validator.validate('email@example.com')
+
+
+```
+
+More Documentation
+------------------
+See the official [Mailgun Email Validation Docs](https://documentation.mailgun.com/en/latest/api-email-validation.html)
+for more information

data/lib/mailgun/client.rb

@@ -9,6 +9,7 @@ module Mailgun
   #
   # See the Github documentation for full examples.
   class Client
+    SUBACCOUNT_HEADER = 'X-Mailgun-On-Behalf-Of'.freeze
 
     def initialize(api_key = Mailgun.api_key,
                    api_host = Mailgun.api_host || 'api.mailgun.net',
@@ -29,6 +30,7 @@ module Mailgun
       RestClient.proxy = proxy_url
       @http_client = RestClient::Resource.new(endpoint, rest_client_params)
       @test_mode = test_mode
+      @api_version = api_version
     end
 
     # Enable test mode
@@ -50,6 +52,16 @@ module Mailgun
       @http_client.options[:password] = api_key
     end
 
+    # Add subaccount id to headers
+    def set_subaccount(subaccount_id)
+      @http_client.options[:headers] = { SUBACCOUNT_HEADER => subaccount_id }
+    end
+
+    # Reset subaccount for primary usage
+    def reset_subaccount
+      @http_client.options[:headers].delete(SUBACCOUNT_HEADER)
+    end
+
     # Client is in test mode?
     #
     # @return [Boolean] Is the client set in test mode?
@@ -57,6 +69,11 @@ module Mailgun
       @test_mode
     end
 
+    # @return [String] client api version
+    def api_version
+      @api_version
+    end
+
     # Provides a store of all the emails sent in test mode so you can check them.
     #
     # @return [Hash]
@@ -157,8 +174,12 @@ module Mailgun
     # @param [String] resource_path This is the API resource you wish to interact
     # with. Be sure to include your domain, where necessary.
     # @return [Mailgun::Response] A Mailgun::Response object.
-    def delete(resource_path)
-      response = @http_client[resource_path].delete
+    def delete(resource_path, params = nil)
+      if params
+        response = @http_client[resource_path].delete(params: params)
+      else
+        response = @http_client[resource_path].delete
+      end
       Response.new(response)
     rescue => err
       raise communication_error err

data/lib/mailgun/domains/domains.rb

@@ -95,8 +95,236 @@ module Mailgun
     #
     # Returns [Hash] of updated domain
     def update(domain, options = {})
-      fail(ParameterError, 'No domain given to add on Mailgun', caller) unless domain
+      fail(ParameterError, 'No domain given to update on Mailgun', caller) unless domain
       @client.put("domains/#{domain}", options).to_h
     end
+
+    # Public: Creates a new set of SMTP credentials for the defined domain.
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   login  - [String] The user name (ex. bob.bar)
+    #   password  - [String] A password for the SMTP credentials. (Length Min 5, Max 32)
+    #
+    # Returns [Hash] with message key
+    def create_smtp_credentials(domain, options = {})
+      fail(ParameterError, 'No domain given to create credentials on Mailgun', caller) unless domain
+      @client.post("domains/#{domain}/credentials", options).to_h
+    end
+
+    # Public: Updates the specified SMTP credentials.
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # login  - [String] The user name (ex. bob.bar)
+    # options - [Hash] of
+    #   password  - [String] A password for the SMTP credentials. (Length Min 5, Max 32)
+    #
+    # Returns [Hash] with message key
+    def update_smtp_credentials(domain, login, options = {})
+      fail(ParameterError, 'No domain given to update credentials on Mailgun', caller) unless domain
+      fail(ParameterError, 'No login given to update credentials on Mailgun', caller) unless login
+      @client.put("domains/#{domain}/credentials/#{login}", options).to_h
+    end
+
+    # Public: Deletes the defined SMTP credentials.
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # login  - [String] The user name (ex. bob.bar)
+    #
+    # Returns [Hash] with message and spec keys
+    def delete_smtp_credentials(domain, login)
+      fail(ParameterError, 'No domain given to delete credentials on Mailgun', caller) unless domain
+      fail(ParameterError, 'No login given to delete credentials on Mailgun', caller) unless login
+      @client.delete("domains/#{domain}/credentials/#{login}").to_h
+    end
+
+    # Public: Returns delivery connection settings for the defined domain.
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    #
+    # Returns [Hash] Information on the delivery connection settings
+    def get_domain_connection_settings(domain)
+      fail(ParameterError, 'No domain given to retrieve connections on Mailgun', caller) unless domain
+      @client.get("domains/#{domain}/connection").to_h
+    end
+
+    # Public: Updates the specified delivery connection settings for the defined domain.d
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   require_tls  - [Boolean] true or false. If true - requires the message only be sent over a TLS connection
+    #   skip_verification  - [Boolean] true or false. If true - the certificate and hostname will not be verified
+    #     when trying to establish a TLS connection
+    #
+    # Returns [Hash] Information on the delivery connection settings
+    def update_domain_connection_settings(domain, options = {})
+      fail(ParameterError, 'No domain given to update connections on Mailgun', caller) unless domain
+      @client.put("domains/#{domain}/connection", options).to_h
+    end
+
+    # Public: Returns tracking settings for the defined domain.
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    #
+    # Returns [Hash] Information on the tracking settings
+    def get_domain_tracking_settings(domain)
+      fail(ParameterError, 'No domain given to retrieve tracking settings on Mailgun', caller) unless domain
+      @client.get("domains/#{domain}/tracking").to_h
+    end
+
+    # Public: Updates the open tracking settings for a domain.
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   active  - [Boolean] yes or no. If set to yes, a tracking pixel will be inserted below your HTML content.
+    #   place_at_the_top  - [Boolean] yes or no. If set to yes, tracking pixel will be moved to top of your HTML content.
+    #
+    # Returns [Hash] Information on the tracking open settings
+    def update_domain_tracking_open_settings(domain, options = {})
+      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
+      @client.put("domains/#{domain}/tracking/open", options).to_h
+    end
+
+    # Public: Updates the click tracking settings for a domain.
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   active  - [Boolean] yes or no. If set to yes, links will be overwritten and pointed to our servers so we can track clicks.
+    #
+    # Returns [Hash] Information on the tracking click settings
+    def update_domain_tracking_click_settings(domain, options = {})
+      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
+      @client.put("domains/#{domain}/tracking/click", options).to_h
+    end
+
+    # Public: Updates unsubscribe tracking settings for a domain.
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   active  - [Boolean] true or false.
+    #   html_footer  - [String] Custom HTML version of unsubscribe footer.
+    #   text_footer  - [String] Custom text version of unsubscribe footer.
+    #
+    # Returns [Hash] Information on the tracking unsubscribe settings
+    def update_domain_tracking_unsubscribe_settings(domain, options = {})
+      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
+      @client.put("domains/#{domain}/tracking/unsubscribe", options).to_h
+    end
+
+    # Public: Change the DKIM authority for a domain.
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   self  - [Boolean] true - the domain will be the DKIM authority for itself even
+    #           if the root domain is registered on the same mailgun account
+    #
+    # Returns [Hash] Information on the DKIM authority
+    def update_domain_dkim_authority(domain, options = {})
+      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
+      @client.put("domains/#{domain}/dkim_authority", options).to_h
+    end
+
+    # Public: Update the DKIM selector for a domains
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   dkim_selector  - [String] change the DKIM selector for a domain.
+    #
+    # Returns [Hash] with message key
+    def update_domain_dkim_selector(domain, options = {})
+      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
+      @client.put("domains/#{domain}/dkim_selector", options).to_h
+    end
+
+    # Public: Update the CNAME used for tracking opens and clicks
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   web_prefix  - [String] change the tracking CNAME for a domain.
+    #
+    # Returns [Hash] with message key
+    def update_domain_web_prefix(domain, options = {})
+      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
+      @client.put("domains/#{domain}/web_prefix", options).to_h
+    end
+
+    # Public: Lists the domain keys for a specified signing domain / authority
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    #
+    # Returns [Hash] with domain keys data
+    def get_domain_keys(domain)
+      fail(ParameterError, 'Client api version must be v4', caller) unless @client.api_version == 'v4'
+      fail(ParameterError, 'No domain given to retrieve keys on Mailgun', caller) unless domain
+      @client.get("domains/#{domain}/keys").to_h
+    end
+
+    # Public: Activate a domain key for a specified authority and selector.
+    #
+    # domain    - [String] Name of the domain (ex. domain.com)
+    # selector  - [String] The selector you want to activate for the domain key
+    #
+    # Returns [Hash] with message key and autority + selector data
+    def activate_domain_key(domain, selector)
+      fail(ParameterError, 'Client api version must be v4', caller) unless @client.api_version == 'v4'
+      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
+      fail(ParameterError, 'No selector given to activate key on Mailgun', caller) unless selector
+      @client.put("domains/#{domain}/keys/#{selector}/activate", {}).to_h
+    end
+
+    # Public: Deactivate a domain key for a specified authority and selector
+    #
+    # domain    - [String] Name of the domain (ex. domain.com)
+    # selector  - [String] The selector you want to activate for the domain key
+    #
+    # Returns [Hash] with message key and autority + selector data
+    def deactivate_domain_key(domain, selector)
+      fail(ParameterError, 'Client api version must be v4', caller) unless @client.api_version == 'v4'
+      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
+      fail(ParameterError, 'No selector given to activate key on Mailgun', caller) unless selector
+      @client.put("domains/#{domain}/keys/#{selector}/deactivate", {}).to_h
+    end
+
+    # Public: Create a domain key
+    #
+    # options - [Hash] of
+    #   signing_domain  - [String] Name of the domain (ex. domain.com)
+    #   selector - [String] Selector to be used for the new domain key
+    #   bits - [Integer] Key size, can be 1024 or 2048
+    #   pem - [String] Private key PEM
+    #
+    # Returns [Hash] with message key
+    def create_domain_key(options = {})
+      fail(ParameterError, 'Client api version must be v1', caller) unless @client.api_version == 'v1'
+      @client.post("dkim/keys", options).to_h
+    end
+
+    # Public: Delete a domain key.
+    #
+    # options - [Hash] of
+    #   signing_domain - [Integer] Name of the domain (ex. domain.com)
+    #   selector - [String] Name of the selector
+    #
+    # Returns [Hash] with message key
+    def delete_domain_key(options = {})
+      fail(ParameterError, 'Client api version must be v1', caller) unless @client.api_version == 'v1'
+      @client.delete("dkim/keys", options).to_h
+    end
+
+    # Public: Returns total stats for a given domains
+    #
+    # domain    - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   event - [String] The type of the event.
+    #   start - [String] The starting time. Should be in RFC 2822 or unix epoch format.
+    #   end - [String] The ending date. Should be in RFC 2822 or unix epoch format
+    #   resolution - [String] Can be either hour, day or month. Default: day
+    #   duration - [String] Period of time with resoluton encoded
+    #
+    # Returns [Array] A list of domains (hash)
+    def get_domain_stats(domain, options = {})
+      fail(ParameterError, 'No domain given to list stats on Mailgun', caller) unless domain
+      @client.get("#{domain}/stats/total", options).to_h
+    end
   end
 end

data/lib/mailgun/messages/message_builder.rb

@@ -116,6 +116,14 @@ module Mailgun
       body_html(html_body)
     end
 
+    # Set an AMP part for the message object
+    #
+    # @param [String] amp The AMP HTML for the email.
+    # @return [void]
+    def amp_html(amp = nil)
+      set_single('amp-html', amp)
+    end
+
     # Adds a series of attachments, when called upon.
     #
     # @param [String|File] attachment A file object for attaching as an attachment.