Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Googleworkspace Provider
  3. API Docs
  4. GmailSendAsAlias
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

googleworkspace.GmailSendAsAlias

Explore with Pulumi AI

googleworkspace logo
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as googleworkspace from "@pulumi/googleworkspace";

const example = googleworkspace.getUser({
    primaryEmail: "user.with.gmail.license@example.com",
});
const alias = new googleworkspace.User("alias", {
    primaryEmail: "alias@example.com",
    password: "34819d7beeabb9260a5c854bc85b3e44",
    hashFunction: "MD5",
    name: {
        familyName: "Scott",
        givenName: "Michael",
    },
});
const test = new googleworkspace.GmailSendAsAlias("test", {
    primaryEmail: example.then(example => example.primaryEmail),
    sendAsEmail: alias.primaryEmail,
});

    import pulumi
import pulumi_googleworkspace as googleworkspace

example = googleworkspace.get_user(primary_email="user.with.gmail.license@example.com")
alias = googleworkspace.User("alias",
    primary_email="alias@example.com",
    password="34819d7beeabb9260a5c854bc85b3e44",
    hash_function="MD5",
    name={
        "family_name": "Scott",
        "given_name": "Michael",
    })
test = googleworkspace.GmailSendAsAlias("test",
    primary_email=example.primary_email,
    send_as_email=alias.primary_email)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/googleworkspace/googleworkspace"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := googleworkspace.LookupUser(ctx, &googleworkspace.LookupUserArgs{
			PrimaryEmail: pulumi.StringRef("user.with.gmail.license@example.com"),
		}, nil)
		if err != nil {
			return err
		}
		alias, err := googleworkspace.NewUser(ctx, "alias", &googleworkspace.UserArgs{
			PrimaryEmail: pulumi.String("alias@example.com"),
			Password:     pulumi.String("34819d7beeabb9260a5c854bc85b3e44"),
			HashFunction: pulumi.String("MD5"),
			Name: &googleworkspace.UserNameArgs{
				FamilyName: pulumi.String("Scott"),
				GivenName:  pulumi.String("Michael"),
			},
		})
		if err != nil {
			return err
		}
		_, err = googleworkspace.NewGmailSendAsAlias(ctx, "test", &googleworkspace.GmailSendAsAliasArgs{
			PrimaryEmail: pulumi.String(example.PrimaryEmail),
			SendAsEmail:  alias.PrimaryEmail,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Googleworkspace = Pulumi.Googleworkspace;

return await Deployment.RunAsync(() => 
{
    var example = Googleworkspace.GetUser.Invoke(new()
    {
        PrimaryEmail = "user.with.gmail.license@example.com",
    });

    var @alias = new Googleworkspace.User("alias", new()
    {
        PrimaryEmail = "alias@example.com",
        Password = "34819d7beeabb9260a5c854bc85b3e44",
        HashFunction = "MD5",
        Name = new Googleworkspace.Inputs.UserNameArgs
        {
            FamilyName = "Scott",
            GivenName = "Michael",
        },
    });

    var test = new Googleworkspace.GmailSendAsAlias("test", new()
    {
        PrimaryEmail = example.Apply(getUserResult => getUserResult.PrimaryEmail),
        SendAsEmail = @alias.PrimaryEmail,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.googleworkspace.GoogleworkspaceFunctions;
import com.pulumi.googleworkspace.inputs.GetUserArgs;
import com.pulumi.googleworkspace.User;
import com.pulumi.googleworkspace.UserArgs;
import com.pulumi.googleworkspace.inputs.UserNameArgs;
import com.pulumi.googleworkspace.GmailSendAsAlias;
import com.pulumi.googleworkspace.GmailSendAsAliasArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = GoogleworkspaceFunctions.getUser(GetUserArgs.builder()
            .primaryEmail("user.with.gmail.license@example.com")
            .build());

        var alias = new User("alias", UserArgs.builder()
            .primaryEmail("alias@example.com")
            .password("34819d7beeabb9260a5c854bc85b3e44")
            .hashFunction("MD5")
            .name(UserNameArgs.builder()
                .familyName("Scott")
                .givenName("Michael")
                .build())
            .build());

        var test = new GmailSendAsAlias("test", GmailSendAsAliasArgs.builder()
            .primaryEmail(example.applyValue(getUserResult -> getUserResult.primaryEmail()))
            .sendAsEmail(alias.primaryEmail())
            .build());

    }
}

    resources:
  alias:
    type: googleworkspace:User
    properties:
      primaryEmail: alias@example.com
      password: 34819d7beeabb9260a5c854bc85b3e44
      hashFunction: MD5
      name:
        familyName: Scott
        givenName: Michael
  test:
    type: googleworkspace:GmailSendAsAlias
    properties:
      primaryEmail: ${example.primaryEmail}
      sendAsEmail: ${alias.primaryEmail}
variables:
  example:
    fn::invoke:
      function: googleworkspace:getUser
      arguments:
        primaryEmail: user.with.gmail.license@example.com

    Create GmailSendAsAlias Resource

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

    Constructor syntax

    new GmailSendAsAlias(name: string, args: GmailSendAsAliasArgs, opts?: CustomResourceOptions);
    @overload
def GmailSendAsAlias(resource_name: str,
                     args: GmailSendAsAliasArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def GmailSendAsAlias(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     primary_email: Optional[str] = None,
                     send_as_email: Optional[str] = None,
                     display_name: Optional[str] = None,
                     is_default: Optional[bool] = None,
                     reply_to_address: Optional[str] = None,
                     signature: Optional[str] = None,
                     smtp_msa: Optional[GmailSendAsAliasSmtpMsaArgs] = None,
                     treat_as_alias: Optional[bool] = None)
    func NewGmailSendAsAlias(ctx *Context, name string, args GmailSendAsAliasArgs, opts ...ResourceOption) (*GmailSendAsAlias, error)
    public GmailSendAsAlias(string name, GmailSendAsAliasArgs args, CustomResourceOptions? opts = null)
    public GmailSendAsAlias(String name, GmailSendAsAliasArgs args)
public GmailSendAsAlias(String name, GmailSendAsAliasArgs args, CustomResourceOptions options)

    type: googleworkspace:GmailSendAsAlias
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 GmailSendAsAliasArgs
    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 GmailSendAsAliasArgs
    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 GmailSendAsAliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GmailSendAsAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GmailSendAsAliasArgs
    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 gmailSendAsAliasResource = new Googleworkspace.GmailSendAsAlias("gmailSendAsAliasResource", new()
{
    PrimaryEmail = "string",
    SendAsEmail = "string",
    DisplayName = "string",
    IsDefault = false,
    ReplyToAddress = "string",
    Signature = "string",
    SmtpMsa = new Googleworkspace.Inputs.GmailSendAsAliasSmtpMsaArgs
    {
        Host = "string",
        Port = 0,
        Password = "string",
        SecurityMode = "string",
        Username = "string",
    },
    TreatAsAlias = false,
});

    example, err := googleworkspace.NewGmailSendAsAlias(ctx, "gmailSendAsAliasResource", &googleworkspace.GmailSendAsAliasArgs{
PrimaryEmail: pulumi.String("string"),
SendAsEmail: pulumi.String("string"),
DisplayName: pulumi.String("string"),
IsDefault: pulumi.Bool(false),
ReplyToAddress: pulumi.String("string"),
Signature: pulumi.String("string"),
SmtpMsa: &.GmailSendAsAliasSmtpMsaArgs{
Host: pulumi.String("string"),
Port: pulumi.Float64(0),
Password: pulumi.String("string"),
SecurityMode: pulumi.String("string"),
Username: pulumi.String("string"),
},
TreatAsAlias: pulumi.Bool(false),
})

    var gmailSendAsAliasResource = new GmailSendAsAlias("gmailSendAsAliasResource", GmailSendAsAliasArgs.builder()
    .primaryEmail("string")
    .sendAsEmail("string")
    .displayName("string")
    .isDefault(false)
    .replyToAddress("string")
    .signature("string")
    .smtpMsa(GmailSendAsAliasSmtpMsaArgs.builder()
        .host("string")
        .port(0)
        .password("string")
        .securityMode("string")
        .username("string")
        .build())
    .treatAsAlias(false)
    .build());

    gmail_send_as_alias_resource = googleworkspace.GmailSendAsAlias("gmailSendAsAliasResource",
    primary_email="string",
    send_as_email="string",
    display_name="string",
    is_default=False,
    reply_to_address="string",
    signature="string",
    smtp_msa={
        "host": "string",
        "port": 0,
        "password": "string",
        "security_mode": "string",
        "username": "string",
    },
    treat_as_alias=False)

    const gmailSendAsAliasResource = new googleworkspace.GmailSendAsAlias("gmailSendAsAliasResource", {
    primaryEmail: "string",
    sendAsEmail: "string",
    displayName: "string",
    isDefault: false,
    replyToAddress: "string",
    signature: "string",
    smtpMsa: {
        host: "string",
        port: 0,
        password: "string",
        securityMode: "string",
        username: "string",
    },
    treatAsAlias: false,
});

    type: googleworkspace:GmailSendAsAlias
properties:
    displayName: string
    isDefault: false
    primaryEmail: string
    replyToAddress: string
    sendAsEmail: string
    signature: string
    smtpMsa:
        host: string
        password: string
        port: 0
        securityMode: string
        username: string
    treatAsAlias: false

    GmailSendAsAlias 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 GmailSendAsAlias resource accepts the following input properties:

    PrimaryEmail string
    User's primary email address.
    SendAsEmail string
    The email address that appears in the 'From:' header for mail sent using this alias.
    DisplayName string
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    IsDefault bool
    ReplyToAddress string
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    Signature string
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    SmtpMsa GmailSendAsAliasSmtpMsa
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    TreatAsAlias bool
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
    PrimaryEmail string
    User's primary email address.
    SendAsEmail string
    The email address that appears in the 'From:' header for mail sent using this alias.
    DisplayName string
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    IsDefault bool
    ReplyToAddress string
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    Signature string
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    SmtpMsa GmailSendAsAliasSmtpMsaArgs
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    TreatAsAlias bool
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
    primaryEmail String
    User's primary email address.
    sendAsEmail String
    The email address that appears in the 'From:' header for mail sent using this alias.
    displayName String
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    isDefault Boolean
    replyToAddress String
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    signature String
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    smtpMsa GmailSendAsAliasSmtpMsa
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    treatAsAlias Boolean
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
    primaryEmail string
    User's primary email address.
    sendAsEmail string
    The email address that appears in the 'From:' header for mail sent using this alias.
    displayName string
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    isDefault boolean
    replyToAddress string
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    signature string
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    smtpMsa GmailSendAsAliasSmtpMsa
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    treatAsAlias boolean
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
    primary_email str
    User's primary email address.
    send_as_email str
    The email address that appears in the 'From:' header for mail sent using this alias.
    display_name str
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    is_default bool
    reply_to_address str
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    signature str
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    smtp_msa GmailSendAsAliasSmtpMsaArgs
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    treat_as_alias bool
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
    primaryEmail String
    User's primary email address.
    sendAsEmail String
    The email address that appears in the 'From:' header for mail sent using this alias.
    displayName String
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    isDefault Boolean
    replyToAddress String
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    signature String
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    smtpMsa Property Map
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    treatAsAlias Boolean
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IsPrimary bool
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    VerificationStatus string
    Indicates whether this address has been verified for use as a send-as alias.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsPrimary bool
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    VerificationStatus string
    Indicates whether this address has been verified for use as a send-as alias.
    id String
    The provider-assigned unique ID for this managed resource.
    isPrimary Boolean
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    verificationStatus String
    Indicates whether this address has been verified for use as a send-as alias.
    id string
    The provider-assigned unique ID for this managed resource.
    isPrimary boolean
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    verificationStatus string
    Indicates whether this address has been verified for use as a send-as alias.
    id str
    The provider-assigned unique ID for this managed resource.
    is_primary bool
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    verification_status str
    Indicates whether this address has been verified for use as a send-as alias.
    id String
    The provider-assigned unique ID for this managed resource.
    isPrimary Boolean
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    verificationStatus String
    Indicates whether this address has been verified for use as a send-as alias.

    Look up Existing GmailSendAsAlias Resource

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

    public static get(name: string, id: Input<ID>, state?: GmailSendAsAliasState, opts?: CustomResourceOptions): GmailSendAsAlias
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        is_default: Optional[bool] = None,
        is_primary: Optional[bool] = None,
        primary_email: Optional[str] = None,
        reply_to_address: Optional[str] = None,
        send_as_email: Optional[str] = None,
        signature: Optional[str] = None,
        smtp_msa: Optional[GmailSendAsAliasSmtpMsaArgs] = None,
        treat_as_alias: Optional[bool] = None,
        verification_status: Optional[str] = None) -> GmailSendAsAlias
    func GetGmailSendAsAlias(ctx *Context, name string, id IDInput, state *GmailSendAsAliasState, opts ...ResourceOption) (*GmailSendAsAlias, error)
    public static GmailSendAsAlias Get(string name, Input<string> id, GmailSendAsAliasState? state, CustomResourceOptions? opts = null)
    public static GmailSendAsAlias get(String name, Output<String> id, GmailSendAsAliasState state, CustomResourceOptions options)
    resources:  _:    type: googleworkspace:GmailSendAsAlias    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DisplayName string
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    IsDefault bool
    IsPrimary bool
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    PrimaryEmail string
    User's primary email address.
    ReplyToAddress string
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    SendAsEmail string
    The email address that appears in the 'From:' header for mail sent using this alias.
    Signature string
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    SmtpMsa GmailSendAsAliasSmtpMsa
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    TreatAsAlias bool
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
    VerificationStatus string
    Indicates whether this address has been verified for use as a send-as alias.
    DisplayName string
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    IsDefault bool
    IsPrimary bool
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    PrimaryEmail string
    User's primary email address.
    ReplyToAddress string
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    SendAsEmail string
    The email address that appears in the 'From:' header for mail sent using this alias.
    Signature string
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    SmtpMsa GmailSendAsAliasSmtpMsaArgs
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    TreatAsAlias bool
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
    VerificationStatus string
    Indicates whether this address has been verified for use as a send-as alias.
    displayName String
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    isDefault Boolean
    isPrimary Boolean
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    primaryEmail String
    User's primary email address.
    replyToAddress String
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    sendAsEmail String
    The email address that appears in the 'From:' header for mail sent using this alias.
    signature String
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    smtpMsa GmailSendAsAliasSmtpMsa
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    treatAsAlias Boolean
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
    verificationStatus String
    Indicates whether this address has been verified for use as a send-as alias.
    displayName string
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    isDefault boolean
    isPrimary boolean
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    primaryEmail string
    User's primary email address.
    replyToAddress string
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    sendAsEmail string
    The email address that appears in the 'From:' header for mail sent using this alias.
    signature string
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    smtpMsa GmailSendAsAliasSmtpMsa
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    treatAsAlias boolean
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
    verificationStatus string
    Indicates whether this address has been verified for use as a send-as alias.
    display_name str
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    is_default bool
    is_primary bool
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    primary_email str
    User's primary email address.
    reply_to_address str
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    send_as_email str
    The email address that appears in the 'From:' header for mail sent using this alias.
    signature str
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    smtp_msa GmailSendAsAliasSmtpMsaArgs
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    treat_as_alias bool
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
    verification_status str
    Indicates whether this address has been verified for use as a send-as alias.
    displayName String
    A name that appears in the 'From:' header for mail sent using this alias. For custom 'from' addresses, when this is empty, Gmail will populate the 'From:' header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
    isDefault Boolean
    isPrimary Boolean
    Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases.
    primaryEmail String
    User's primary email address.
    replyToAddress String
    An optional email address that is included in a 'Reply-To:' header for mail sent using this alias. If this is empty, Gmail will not generate a 'Reply-To:' header.
    sendAsEmail String
    The email address that appears in the 'From:' header for mail sent using this alias.
    signature String
    An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
    smtpMsa Property Map
    An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom 'from' aliases.
    treatAsAlias Boolean
    Defaults to true. Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom 'from' aliases. See https://support.google.com/a/answer/1710338 for help on making this decision
    verificationStatus String
    Indicates whether this address has been verified for use as a send-as alias.

    Supporting Types

    GmailSendAsAliasSmtpMsa, GmailSendAsAliasSmtpMsaArgs

    Host string
    The hostname of the SMTP service.
    Port double
    The port of the SMTP service.
    Password string
    The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    SecurityMode string
    Defaults to securityModeUnspecified. The protocol that will be used to secure communication with the SMTP service.
    Username string
    The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    Host string
    The hostname of the SMTP service.
    Port float64
    The port of the SMTP service.
    Password string
    The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    SecurityMode string
    Defaults to securityModeUnspecified. The protocol that will be used to secure communication with the SMTP service.
    Username string
    The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    host String
    The hostname of the SMTP service.
    port Double
    The port of the SMTP service.
    password String
    The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    securityMode String
    Defaults to securityModeUnspecified. The protocol that will be used to secure communication with the SMTP service.
    username String
    The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    host string
    The hostname of the SMTP service.
    port number
    The port of the SMTP service.
    password string
    The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    securityMode string
    Defaults to securityModeUnspecified. The protocol that will be used to secure communication with the SMTP service.
    username string
    The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    host str
    The hostname of the SMTP service.
    port float
    The port of the SMTP service.
    password str
    The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    security_mode str
    Defaults to securityModeUnspecified. The protocol that will be used to secure communication with the SMTP service.
    username str
    The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    host String
    The hostname of the SMTP service.
    port Number
    The port of the SMTP service.
    password String
    The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
    securityMode String
    Defaults to securityModeUnspecified. The protocol that will be used to secure communication with the SMTP service.
    username String
    The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.

    Import

    $ pulumi import googleworkspace:index/gmailSendAsAlias:GmailSendAsAlias alias user@example.com:alias@anotherexample.com

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    googleworkspace hashicorp/terraform-provider-googleworkspace
    License
    Notes
    This Pulumi package is based on the googleworkspace Terraform Provider.
    googleworkspace logo
    googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
    hashicorp/terraform-provider-googleworkspace