Pulumi Mailgun

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-mailgun repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-mailgun repo.

class pulumi_mailgun.Domain(resource_name, opts=None, name=None, region=None, spam_action=None, wildcard=None, __props__=None, __name__=None, __opts__=None)

Provides a Mailgun App resource. This can be used to create and manage applications on Mailgun.

After DNS records are set, domain verification should be triggered manually using PUT /domains/<domain&gt;/verify

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The domain to add to Mailgun

  • region (pulumi.Input[str]) – The region where domain will be created. Default value is us.

  • spam_action (pulumi.Input[str]) – disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged with a spam header.

  • wildcard (pulumi.Input[bool]) – Boolean that determines whether the domain will accept email for sub-domains.

name = None

The domain to add to Mailgun

receiving_records = None

A list of DNS records for receiving validation.

  • priority (str) - The priority of the record.

  • recordType (str) - The record type.

  • valid (str) - "valid" if the record is valid.

  • value (str) - The value of the record.

region = None

The region where domain will be created. Default value is us.

sending_records = None

A list of DNS records for sending validation.

  • name (str) - The domain to add to Mailgun

  • recordType (str) - The record type.

  • valid (str) - "valid" if the record is valid.

  • value (str) - The value of the record.

smtp_login = None

The login email for the SMTP server.

smtp_password = None

The password to the SMTP server.

spam_action = None

disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged with a spam header.

wildcard = None

Boolean that determines whether the domain will accept email for sub-domains.

static get(resource_name, id, opts=None, name=None, receiving_records=None, region=None, sending_records=None, smtp_login=None, smtp_password=None, spam_action=None, wildcard=None)

Get an existing Domain resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The domain to add to Mailgun

  • receiving_records (pulumi.Input[list]) – A list of DNS records for receiving validation.

  • region (pulumi.Input[str]) – The region where domain will be created. Default value is us.

  • sending_records (pulumi.Input[list]) – A list of DNS records for sending validation.

  • smtp_login (pulumi.Input[str]) – The login email for the SMTP server.

  • smtp_password (pulumi.Input[str]) – The password to the SMTP server.

  • spam_action (pulumi.Input[str]) – disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged with a spam header.

  • wildcard (pulumi.Input[bool]) – Boolean that determines whether the domain will accept email for sub-domains.

The receiving_records object supports the following:

  • priority (pulumi.Input[str]) - The priority of the record.

  • recordType (pulumi.Input[str]) - The record type.

  • valid (pulumi.Input[str]) - "valid" if the record is valid.

  • value (pulumi.Input[str]) - The value of the record.

The sending_records object supports the following:

  • name (pulumi.Input[str]) - The domain to add to Mailgun

  • recordType (pulumi.Input[str]) - The record type.

  • valid (pulumi.Input[str]) - "valid" if the record is valid.

  • value (pulumi.Input[str]) - The value of the record.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mailgun.Provider(resource_name, opts=None, api_key=None, __props__=None, __name__=None, __opts__=None)

The provider type for the mailgun package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Parameters
static get(resource_name, id, opts=None)

Get an existing Provider resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mailgun.Route(resource_name, opts=None, actions=None, description=None, expression=None, priority=None, region=None, __props__=None, __name__=None, __opts__=None)

Provides a Mailgun Route resource. This can be used to create and manage routes on Mailgun.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • expression (pulumi.Input[str]) – A filter expression like match_recipient('.*@gmail.com')

  • priority (pulumi.Input[float]) – Smaller number indicates higher priority. Higher priority routes are handled first.

  • region (pulumi.Input[str]) – The region where domain will be created. Default value is us.

expression = None

A filter expression like match_recipient('.*@gmail.com')

priority = None

Smaller number indicates higher priority. Higher priority routes are handled first.

region = None

The region where domain will be created. Default value is us.

static get(resource_name, id, opts=None, actions=None, description=None, expression=None, priority=None, region=None)

Get an existing Route resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • expression (pulumi.Input[str]) – A filter expression like match_recipient('.*@gmail.com')

  • priority (pulumi.Input[float]) – Smaller number indicates higher priority. Higher priority routes are handled first.

  • region (pulumi.Input[str]) – The region where domain will be created. Default value is us.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str