Module: ElasticEmail
- Defined in:
- lib/ElasticEmail/version.rb,
lib/ElasticEmail.rb,
lib/ElasticEmail/api_error.rb,
lib/ElasticEmail/api_client.rb,
lib/ElasticEmail/models/utm.rb,
lib/ElasticEmail/api/files_api.rb,
lib/ElasticEmail/api/lists_api.rb,
lib/ElasticEmail/configuration.rb,
lib/ElasticEmail/api/emails_api.rb,
lib/ElasticEmail/api/events_api.rb,
lib/ElasticEmail/models/api_key.rb,
lib/ElasticEmail/models/contact.rb,
lib/ElasticEmail/models/options.rb,
lib/ElasticEmail/models/segment.rb,
lib/ElasticEmail/models/campaign.rb,
lib/ElasticEmail/models/template.rb,
lib/ElasticEmail/api/contacts_api.rb,
lib/ElasticEmail/api/security_api.rb,
lib/ElasticEmail/api/segments_api.rb,
lib/ElasticEmail/models/body_part.rb,
lib/ElasticEmail/models/file_info.rb,
lib/ElasticEmail/api/campaigns_api.rb,
lib/ElasticEmail/api/templates_api.rb,
lib/ElasticEmail/models/email_data.rb,
lib/ElasticEmail/models/email_send.rb,
lib/ElasticEmail/models/email_view.rb,
lib/ElasticEmail/models/event_type.rb,
lib/ElasticEmail/api/statistics_api.rb,
lib/ElasticEmail/models/export_link.rb,
lib/ElasticEmail/models/new_api_key.rb,
lib/ElasticEmail/models/suppression.rb,
lib/ElasticEmail/models/access_level.rb,
lib/ElasticEmail/models/consent_data.rb,
lib/ElasticEmail/models/email_status.rb,
lib/ElasticEmail/models/file_payload.rb,
lib/ElasticEmail/models/list_payload.rb,
lib/ElasticEmail/api/sub_accounts_api.rb,
lib/ElasticEmail/api/suppressions_api.rb,
lib/ElasticEmail/models/contacts_list.rb,
lib/ElasticEmail/models/email_content.rb,
lib/ElasticEmail/models/encoding_type.rb,
lib/ElasticEmail/models/export_status.rb,
lib/ElasticEmail/models/inbound_route.rb,
lib/ElasticEmail/models/split_options.rb,
lib/ElasticEmail/models/template_type.rb,
lib/ElasticEmail/api/inbound_route_api.rb,
lib/ElasticEmail/api/verifications_api.rb,
lib/ElasticEmail/models/contact_source.rb,
lib/ElasticEmail/models/contact_status.rb,
lib/ElasticEmail/models/emails_payload.rb,
lib/ElasticEmail/models/log_job_status.rb,
lib/ElasticEmail/models/template_scope.rb,
lib/ElasticEmail/models/api_key_payload.rb,
lib/ElasticEmail/models/campaign_status.rb,
lib/ElasticEmail/models/contact_history.rb,
lib/ElasticEmail/models/contact_payload.rb,
lib/ElasticEmail/models/email_recipient.rb,
lib/ElasticEmail/models/events_order_by.rb,
lib/ElasticEmail/models/inbound_payload.rb,
lib/ElasticEmail/models/recipient_event.rb,
lib/ElasticEmail/models/segment_payload.rb,
lib/ElasticEmail/models/sort_order_item.rb,
lib/ElasticEmail/models/campaign_options.rb,
lib/ElasticEmail/models/consent_tracking.rb,
lib/ElasticEmail/models/contact_activity.rb,
lib/ElasticEmail/models/message_category.rb,
lib/ElasticEmail/models/smtp_credentials.rb,
lib/ElasticEmail/models/sub_account_info.rb,
lib/ElasticEmail/models/template_payload.rb,
lib/ElasticEmail/models/body_content_type.rb,
lib/ElasticEmail/models/campaign_template.rb,
lib/ElasticEmail/models/campaign_recipient.rb,
lib/ElasticEmail/models/compression_format.rb,
lib/ElasticEmail/models/email_message_data.rb,
lib/ElasticEmail/models/file_upload_result.rb,
lib/ElasticEmail/models/log_status_summary.rb,
lib/ElasticEmail/models/message_attachment.rb,
lib/ElasticEmail/models/subaccount_payload.rb,
lib/ElasticEmail/models/account_status_enum.rb,
lib/ElasticEmail/models/export_file_formats.rb,
lib/ElasticEmail/models/list_update_payload.rb,
lib/ElasticEmail/models/merge_email_payload.rb,
lib/ElasticEmail/models/template_scope_type.rb,
lib/ElasticEmail/models/verification_status.rb,
lib/ElasticEmail/models/new_smtp_credentials.rb,
lib/ElasticEmail/models/contact_update_payload.rb,
lib/ElasticEmail/models/contact_hist_event_type.rb,
lib/ElasticEmail/models/email_validation_result.rb,
lib/ElasticEmail/models/email_validation_status.rb,
lib/ElasticEmail/models/split_optimization_type.rb,
lib/ElasticEmail/models/transactional_recipient.rb,
lib/ElasticEmail/models/smtp_credentials_payload.rb,
lib/ElasticEmail/models/subaccount_settings_info.rb,
lib/ElasticEmail/models/verification_file_result.rb,
lib/ElasticEmail/models/inbound_route_action_type.rb,
lib/ElasticEmail/models/inbound_route_filter_type.rb,
lib/ElasticEmail/models/subaccount_email_settings.rb,
lib/ElasticEmail/models/channel_log_status_summary.rb,
lib/ElasticEmail/models/delivery_optimization_type.rb,
lib/ElasticEmail/models/email_transactional_message_data.rb,
lib/ElasticEmail/models/subaccount_email_credits_payload.rb,
lib/ElasticEmail/models/subaccount_settings_info_payload.rb,
lib/ElasticEmail/models/verification_file_result_details.rb,
lib/ElasticEmail/models/email_predicted_validation_status.rb,
lib/ElasticEmail/models/subaccount_email_settings_payload.rb
Overview
#Elastic Email REST API
#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target="_blank" href="app.elasticemail.com/marketing/settings/new/manage-api">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target="_blank" href="github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme">here</a>
The version of the OpenAPI document: 4.0.0 Contact: support@elasticemail.com Generated by: openapi-generator.tech OpenAPI Generator version: 6.3.0
Defined Under Namespace
Classes: AccessLevel, AccountStatusEnum, ApiClient, ApiError, ApiKey, ApiKeyPayload, BodyContentType, BodyPart, Campaign, CampaignOptions, CampaignRecipient, CampaignStatus, CampaignTemplate, CampaignsApi, ChannelLogStatusSummary, CompressionFormat, Configuration, ConsentData, ConsentTracking, Contact, ContactActivity, ContactHistEventType, ContactHistory, ContactPayload, ContactSource, ContactStatus, ContactUpdatePayload, ContactsApi, ContactsList, DeliveryOptimizationType, EmailContent, EmailData, EmailMessageData, EmailPredictedValidationStatus, EmailRecipient, EmailSend, EmailStatus, EmailTransactionalMessageData, EmailValidationResult, EmailValidationStatus, EmailView, EmailsApi, EmailsPayload, EncodingType, EventType, EventsApi, EventsOrderBy, ExportFileFormats, ExportLink, ExportStatus, FileInfo, FilePayload, FileUploadResult, FilesApi, InboundPayload, InboundRoute, InboundRouteActionType, InboundRouteApi, InboundRouteFilterType, ListPayload, ListUpdatePayload, ListsApi, LogJobStatus, LogStatusSummary, MergeEmailPayload, MessageAttachment, MessageCategory, NewApiKey, NewSmtpCredentials, Options, RecipientEvent, SecurityApi, Segment, SegmentPayload, SegmentsApi, SmtpCredentials, SmtpCredentialsPayload, SortOrderItem, SplitOptimizationType, SplitOptions, StatisticsApi, SubAccountInfo, SubAccountsApi, SubaccountEmailCreditsPayload, SubaccountEmailSettings, SubaccountEmailSettingsPayload, SubaccountPayload, SubaccountSettingsInfo, SubaccountSettingsInfoPayload, Suppression, SuppressionsApi, Template, TemplatePayload, TemplateScope, TemplateScopeType, TemplateType, TemplatesApi, TransactionalRecipient, Utm, VerificationFileResult, VerificationFileResultDetails, VerificationStatus, VerificationsApi
Constant Summary collapse
- VERSION =
'4.0.22'
Class Method Summary collapse
-
.configure ⇒ Object
Customize default settings for the SDK using block.
Class Method Details
.configure ⇒ Object
Customize default settings for the SDK using block.
ElasticEmail.configure do |config|
config.username = "xxx"
config.password = "xxx"
end
If no block given, return the default Configuration object.
128 129 130 131 132 133 134 |
# File 'lib/ElasticEmail.rb', line 128 def configure if block_given? yield(Configuration.default) else Configuration.default end end |