Class: OCI::EmailDataPlane::EmailDPClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/email_data_plane/email_dp_client.rb

Overview

Use the Email Delivery API to send high-volume and application-generated emails. For more information, see Overview of the Email Delivery Service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ EmailDPClient

Creates a new EmailDPClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/email_data_plane/email_dp_client.rb', line 56

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20220926'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "EmailDPClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



16
17
18
 
# File 'lib/oci/email_data_plane/email_dp_client.rb', line 16

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/email_data_plane/email_dp_client.rb', line 20

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/email_data_plane/email_dp_client.rb', line 30

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



26
27
28
 
# File 'lib/oci/email_data_plane/email_dp_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



95
96
97
 
# File 'lib/oci/email_data_plane/email_dp_client.rb', line 95

def logger
  @api_client.config.logger
end

#submit_email(submit_email_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use submit_email API.

Submits a formatted email.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The request ID for tracing from the system

Returns:



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/email_data_plane/email_dp_client.rb', line 112

def submit_email(submit_email_details, opts = {})
  logger.debug 'Calling operation EmailDPClient#submit_email.' if logger

  raise "Missing the required parameter 'submit_email_details' when calling submit_email." if submit_email_details.nil?

  path = '/actions/submitEmail'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(submit_email_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'EmailDPClient#submit_email') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::EmailDataPlane::Models::EmailSubmittedResponse'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#submit_raw_email(content_type, compartment_id, sender, recipients, raw_message, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use submit_raw_email API.

Submits a raw email.

Parameters:

  • content_type (String) —

    The media type of the body. Allowed values are: message/rfc822, message/global

  • compartment_id (String) —

    The OCID of the compartment that contains the approved sender resource.

  • sender (String) —

    The envelope and the header from email address, that is sending the email. Email address must be an approved sender.

  • recipients (Array<String>) —

    The destination for the email, all recipients including to, cc and bcc addresses.

  • raw_message (String, IO) —

    This should be formatted in valid MIME format. Message can include attachments. MIME libraries should be used to convert the content into the appropriate format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The request ID for tracing from the system

  • :content_length (Integer) —

    The content length of the body.

Returns:



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/email_data_plane/email_dp_client.rb', line 172

def submit_raw_email(content_type, compartment_id, sender, recipients, raw_message, opts = {})
  logger.debug 'Calling operation EmailDPClient#submit_raw_email.' if logger

  raise "Missing the required parameter 'content_type' when calling submit_raw_email." if content_type.nil?
  unless %w[message/rfc822 message/global].include?(content_type)
    raise "Invalid value for 'content_type', must be one of message/rfc822, message/global."
  end
  raise "Missing the required parameter 'compartment_id' when calling submit_raw_email." if compartment_id.nil?
  raise "Missing the required parameter 'sender' when calling submit_raw_email." if sender.nil?
  raise "Missing the required parameter 'recipients' when calling submit_raw_email." if recipients.nil?
  raise "Missing the required parameter 'raw_message' when calling submit_raw_email." if raw_message.nil?

  path = '/actions/submitRawEmail'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = content_type
  header_params[:'compartment-id'] = compartment_id
  header_params[:sender] = sender
  header_params[:recipients] = OCI::ApiClient.build_collection_params(recipients, :csv)
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'content-length'] = opts[:content_length] if opts[:content_length]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(raw_message)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'EmailDPClient#submit_raw_email') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::EmailDataPlane::Models::EmailRawSubmittedResponse'
    )
  end
  # rubocop:enable Metrics/BlockLength
end