# Gmail API . users . settings . sendAs

## Instance Methods

Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

Deletes the specified send-as alias. Revokes any verification that may have been required for using it.

Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.

Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases.

Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method supports patch semantics.

Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

Sends a verification email to the specified send-as alias address. The verification status must be pending.

### Method Details

`create(userId, body)`

    Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

    Args:
      userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
      "smtpMsa": { # Configuration for communication with an SMTP service. # 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.
        "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
        "username": "A 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": "A String", # The hostname of the SMTP service. Required.
        "password": "A 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.
        "port": 42, # The port of the SMTP service. Required.
      },
      "displayName": "A 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.
      "replyToAddress": "A 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": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
      "treatAsAlias": True or False, # Whether Gmail should  treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
      "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
      "isPrimary": True or False, # 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. This field is read-only.
      "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
      "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
    }

    Returns:
      An object of the form:

        { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
        "smtpMsa": { # Configuration for communication with an SMTP service. # 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.
          "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
          "username": "A 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": "A String", # The hostname of the SMTP service. Required.
          "password": "A 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.
          "port": 42, # The port of the SMTP service. Required.
        },
        "displayName": "A 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.
        "replyToAddress": "A 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": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
        "treatAsAlias": True or False, # Whether Gmail should  treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
        "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
        "isPrimary": True or False, # 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. This field is read-only.
        "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
        "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
      }

`delete(userId, sendAsEmail)`

    Deletes the specified send-as alias. Revokes any verification that may have been required for using it.

    Args:
      userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
      sendAsEmail: string, The send-as alias to be deleted. (required)

`get(userId, sendAsEmail)`

    Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.

    Args:
      userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
      sendAsEmail: string, The send-as alias to be retrieved. (required)

    Returns:
      An object of the form:

        { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
        "smtpMsa": { # Configuration for communication with an SMTP service. # 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.
          "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
          "username": "A 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": "A String", # The hostname of the SMTP service. Required.
          "password": "A 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.
          "port": 42, # The port of the SMTP service. Required.
        },
        "displayName": "A 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.
        "replyToAddress": "A 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": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
        "treatAsAlias": True or False, # Whether Gmail should  treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
        "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
        "isPrimary": True or False, # 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. This field is read-only.
        "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
        "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
      }

`list(userId)`

    Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases.

    Args:
      userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)

    Returns:
      An object of the form:

        { # Response for the ListSendAs method.
        "sendAs": [ # List of send-as aliases.
          { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
            "smtpMsa": { # Configuration for communication with an SMTP service. # 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.
              "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
              "username": "A 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": "A String", # The hostname of the SMTP service. Required.
              "password": "A 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.
              "port": 42, # The port of the SMTP service. Required.
            },
            "displayName": "A 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.
            "replyToAddress": "A 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": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
            "treatAsAlias": True or False, # Whether Gmail should  treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
            "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
            "isPrimary": True or False, # 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. This field is read-only.
            "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
            "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
          },
        ],
      }

`patch(userId, sendAsEmail, body)`

    Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method supports patch semantics.

    Args:
      userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
      sendAsEmail: string, The send-as alias to be updated. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
      "smtpMsa": { # Configuration for communication with an SMTP service. # 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.
        "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
        "username": "A 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": "A String", # The hostname of the SMTP service. Required.
        "password": "A 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.
        "port": 42, # The port of the SMTP service. Required.
      },
      "displayName": "A 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.
      "replyToAddress": "A 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": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
      "treatAsAlias": True or False, # Whether Gmail should  treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
      "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
      "isPrimary": True or False, # 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. This field is read-only.
      "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
      "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
    }

    Returns:
      An object of the form:

        { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
        "smtpMsa": { # Configuration for communication with an SMTP service. # 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.
          "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
          "username": "A 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": "A String", # The hostname of the SMTP service. Required.
          "password": "A 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.
          "port": 42, # The port of the SMTP service. Required.
        },
        "displayName": "A 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.
        "replyToAddress": "A 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": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
        "treatAsAlias": True or False, # Whether Gmail should  treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
        "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
        "isPrimary": True or False, # 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. This field is read-only.
        "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
        "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
      }

`update(userId, sendAsEmail, body)`

    Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

    Args:
      userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
      sendAsEmail: string, The send-as alias to be updated. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
      "smtpMsa": { # Configuration for communication with an SMTP service. # 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.
        "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
        "username": "A 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": "A String", # The hostname of the SMTP service. Required.
        "password": "A 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.
        "port": 42, # The port of the SMTP service. Required.
      },
      "displayName": "A 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.
      "replyToAddress": "A 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": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
      "treatAsAlias": True or False, # Whether Gmail should  treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
      "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
      "isPrimary": True or False, # 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. This field is read-only.
      "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
      "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
    }

    Returns:
      An object of the form:

        { # Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
        "smtpMsa": { # Configuration for communication with an SMTP service. # 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.
          "securityMode": "A String", # The protocol that will be used to secure communication with the SMTP service. Required.
          "username": "A 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": "A String", # The hostname of the SMTP service. Required.
          "password": "A 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.
          "port": 42, # The port of the SMTP service. Required.
        },
        "displayName": "A 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.
        "replyToAddress": "A 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": "A String", # An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
        "treatAsAlias": True or False, # Whether Gmail should  treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
        "sendAsEmail": "A String", # The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
        "isPrimary": True or False, # 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. This field is read-only.
        "verificationStatus": "A String", # Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
        "isDefault": True or False, # Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
      }

`verify(userId, sendAsEmail)`

    Sends a verification email to the specified send-as alias address. The verification status must be pending.

    Args:
      userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
      sendAsEmail: string, The send-as alias to be verified. (required)