/******************************************************************************* * Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * Licensed under the Apache License, Version 2.0 (the "License"). You may not use * this file except in compliance with the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.SimpleEmail; using Amazon.SimpleEmail.Model; namespace Amazon.PowerShell.Cmdlets.SES { /// /// Enables or disables the custom MAIL FROM domain setup for a verified identity (an /// email address or a domain). /// /// /// To send emails using the specified MAIL FROM domain, you must add an MX record to /// your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy /// Framework (SPF) checks, you must also add or update an SPF record. For more information, /// see the Amazon /// SES Developer Guide. /// /// You can execute this operation no more than once per second. /// /// [Cmdlet("Set", "SESIdentityMailFromDomain", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon Simple Email Service (SES) SetIdentityMailFromDomain API operation.", Operation = new[] {"SetIdentityMailFromDomain"}, SelectReturnType = typeof(Amazon.SimpleEmail.Model.SetIdentityMailFromDomainResponse))] [AWSCmdletOutput("None or Amazon.SimpleEmail.Model.SetIdentityMailFromDomainResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.SimpleEmail.Model.SetIdentityMailFromDomainResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class SetSESIdentityMailFromDomainCmdlet : AmazonSimpleEmailServiceClientCmdlet, IExecutor { #region Parameter BehaviorOnMXFailure /// /// /// The action that you want Amazon SES to take if it cannot successfully read the required /// MX record when you send an email. If you choose UseDefaultValue, Amazon /// SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you /// choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified /// error and not send the email.The action specified in BehaviorOnMXFailure is taken when the custom /// MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure /// states. /// /// [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.SimpleEmail.BehaviorOnMXFailure")] public Amazon.SimpleEmail.BehaviorOnMXFailure BehaviorOnMXFailure { get; set; } #endregion #region Parameter Identity /// /// /// The verified identity for which you want to enable or disable the specified custom /// MAIL FROM domain. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Identity { get; set; } #endregion #region Parameter MailFromDomain /// /// /// The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM /// domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" /// address if the MAIL FROM domain is the destination of email feedback forwarding (for /// more information, see the Amazon /// SES Developer Guide), and 3) not be used to receive emails. A value of null /// disables the custom MAIL FROM setting for the identity. /// /// [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] public System.String MailFromDomain { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleEmail.Model.SetIdentityMailFromDomainResponse). /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Identity parameter. /// The -PassThru parameter is deprecated, use -Select '^Identity' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Identity' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.Identity), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Set-SESIdentityMailFromDomain (SetIdentityMailFromDomain)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.Identity; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.BehaviorOnMXFailure = this.BehaviorOnMXFailure; context.Identity = this.Identity; #if MODULAR if (this.Identity == null && ParameterWasBound(nameof(this.Identity))) { WriteWarning("You are passing $null as a value for parameter Identity which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.MailFromDomain = this.MailFromDomain; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.SimpleEmail.Model.SetIdentityMailFromDomainRequest(); if (cmdletContext.BehaviorOnMXFailure != null) { request.BehaviorOnMXFailure = cmdletContext.BehaviorOnMXFailure; } if (cmdletContext.Identity != null) { request.Identity = cmdletContext.Identity; } if (cmdletContext.MailFromDomain != null) { request.MailFromDomain = cmdletContext.MailFromDomain; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.SimpleEmail.Model.SetIdentityMailFromDomainResponse CallAWSServiceOperation(IAmazonSimpleEmailService client, Amazon.SimpleEmail.Model.SetIdentityMailFromDomainRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Simple Email Service (SES)", "SetIdentityMailFromDomain"); try { #if DESKTOP return client.SetIdentityMailFromDomain(request); #elif CORECLR return client.SetIdentityMailFromDomainAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public Amazon.SimpleEmail.BehaviorOnMXFailure BehaviorOnMXFailure { get; set; } public System.String Identity { get; set; } public System.String MailFromDomain { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }