1. Packages
  2. ImprovMX
  3. API Docs
  4. SmtpCredential
Viewing docs for ImprovMX v0.2.7
published on Tuesday, Mar 24, 2026 by lokkju
improvmx logo
Viewing docs for ImprovMX v0.2.7
published on Tuesday, Mar 24, 2026 by lokkju

    Manages an ImprovMX SMTP credential for sending email.

    Create SmtpCredential Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SmtpCredential(name: string, args: SmtpCredentialArgs, opts?: CustomResourceOptions);
    @overload
    def SmtpCredential(resource_name: str,
                       args: SmtpCredentialArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def SmtpCredential(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       domain: Optional[str] = None,
                       password: Optional[str] = None,
                       username: Optional[str] = None)
    func NewSmtpCredential(ctx *Context, name string, args SmtpCredentialArgs, opts ...ResourceOption) (*SmtpCredential, error)
    public SmtpCredential(string name, SmtpCredentialArgs args, CustomResourceOptions? opts = null)
    public SmtpCredential(String name, SmtpCredentialArgs args)
    public SmtpCredential(String name, SmtpCredentialArgs args, CustomResourceOptions options)
    
    type: improvmx:SmtpCredential
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args SmtpCredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SmtpCredentialArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SmtpCredentialArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SmtpCredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SmtpCredentialArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var smtpCredentialResource = new Improvmx.SmtpCredential("smtpCredentialResource", new()
    {
        DomainName = "string",
        Password = "string",
        Username = "string",
    });
    
    example, err := improvmx.NewSmtpCredential(ctx, "smtpCredentialResource", &improvmx.SmtpCredentialArgs{
    	Domain:   pulumi.String("string"),
    	Password: pulumi.String("string"),
    	Username: pulumi.String("string"),
    })
    
    var smtpCredentialResource = new SmtpCredential("smtpCredentialResource", SmtpCredentialArgs.builder()
        .domain("string")
        .password("string")
        .username("string")
        .build());
    
    smtp_credential_resource = improvmx.SmtpCredential("smtpCredentialResource",
        domain="string",
        password="string",
        username="string")
    
    const smtpCredentialResource = new improvmx.SmtpCredential("smtpCredentialResource", {
        domain: "string",
        password: "string",
        username: "string",
    });
    
    type: improvmx:SmtpCredential
    properties:
        domain: string
        password: string
        username: string
    

    SmtpCredential Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SmtpCredential resource accepts the following input properties:

    DomainName string
    The domain this SMTP credential belongs to.
    Password string
    The SMTP password.
    Username string
    The SMTP username.
    Domain string
    The domain this SMTP credential belongs to.
    Password string
    The SMTP password.
    Username string
    The SMTP username.
    domain String
    The domain this SMTP credential belongs to.
    password String
    The SMTP password.
    username String
    The SMTP username.
    domain string
    The domain this SMTP credential belongs to.
    password string
    The SMTP password.
    username string
    The SMTP username.
    domain str
    The domain this SMTP credential belongs to.
    password str
    The SMTP password.
    username str
    The SMTP username.
    domain String
    The domain this SMTP credential belongs to.
    password String
    The SMTP password.
    username String
    The SMTP username.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SmtpCredential resource produces the following output properties:

    Created int
    Unix timestamp when the credential was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Created int
    Unix timestamp when the credential was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    created Integer
    Unix timestamp when the credential was created.
    id String
    The provider-assigned unique ID for this managed resource.
    created number
    Unix timestamp when the credential was created.
    id string
    The provider-assigned unique ID for this managed resource.
    created int
    Unix timestamp when the credential was created.
    id str
    The provider-assigned unique ID for this managed resource.
    created Number
    Unix timestamp when the credential was created.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    improvmx lokkju/pulumi-improvmx
    License
    improvmx logo
    Viewing docs for ImprovMX v0.2.7
    published on Tuesday, Mar 24, 2026 by lokkju
      Try Pulumi Cloud free. Your team will thank you.