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 here). 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 here

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 4.0.0
• Package version: 4.0.23
• Build package: org.openapitools.codegen.languages.PythonPriorClientCodegen

Python >=3.6

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/elasticemail/elasticemail-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/elasticemail/elasticemail-python.git)

Then import the package:

import ElasticEmail

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ElasticEmail

Below is a code snippet that will allow you to send your first email with us. Please make sure that you have registered an account and created an API key before trying to run the code.

Please follow the installation procedure and then run the following:

import ElasticEmail
from ElasticEmail.api import emails_api
from ElasticEmail.model.email_message_data import EmailMessageData
from ElasticEmail.model.email_recipient import EmailRecipient

from pprint import pprint

configuration = ElasticEmail.Configuration()
configuration.api_key['apikey'] = '<your API key>'
 
with ElasticEmail.ApiClient(configuration) as api_client:
    api_instance = emails_api.EmailsApi(api_client)
    email_message_data = EmailMessageData(
        recipients=[
            EmailRecipient(
                email="<to address>"
            ),
        ],
        content={
	    "Body": [
		{
		    "ContentType":"HTML",
		    "Content":"My test email content ;)"
		}
	    ],
	    "Subject": "Python EE lib test",
	    "From": "<from address>"
	}
    )
 
    try:
        api_response = api_instance.emails_post(email_message_data)
        pprint(api_response)
    except ElasticEmail.ApiException as e:
        print("Exception when calling EmailsApi->emails_post: %s\n" % e)

All URIs are relative to https://api.elasticemail.com/v4

• AccessLevel
• AccountStatusEnum
• ApiKey
• ApiKeyPayload
• BodyContentType
• BodyPart
• Campaign
• CampaignOptions
• CampaignRecipient
• CampaignStatus
• CampaignTemplate
• ChannelLogStatusSummary
• CompressionFormat
• ConsentData
• ConsentTracking
• Contact
• ContactActivity
• ContactPayload
• ContactSource
• ContactStatus
• ContactUpdatePayload
• ContactsList
• DeliveryOptimizationType
• EmailContent
• EmailData
• EmailMessageData
• EmailRecipient
• EmailSend
• EmailStatus
• EmailTransactionalMessageData
• EmailValidationResult
• EmailValidationStatus
• EmailView
• EmailsPayload
• EncodingType
• EventType
• EventsOrderBy
• ExportFileFormats
• ExportLink
• ExportStatus
• FileInfo
• FilePayload
• FileUploadResult
• InboundPayload
• InboundRoute
• InboundRouteActionType
• InboundRouteFilterType
• ListPayload
• ListUpdatePayload
• LogJobStatus
• LogStatusSummary
• MergeEmailPayload
• MessageAttachment
• MessageCategory
• NewApiKey
• NewSmtpCredentials
• Options
• RecipientEvent
• Segment
• SegmentPayload
• SmtpCredentials
• SmtpCredentialsPayload
• SortOrderItem
• SplitOptimizationType
• SplitOptions
• SubAccountInfo
• SubaccountEmailCreditsPayload
• SubaccountEmailSettings
• SubaccountEmailSettingsPayload
• SubaccountPayload
• SubaccountSettingsInfo
• SubaccountSettingsInfoPayload
• Suppression
• Template
• TemplatePayload
• TemplateScope
• TemplateType
• TransactionalRecipient
• Utm
• VerificationFileResult
• VerificationFileResultDetails
• VerificationStatus

• Type: API key
• API key parameter name: X-ElasticEmail-ApiKey
• Location: HTTP header

support@elasticemail.com

If the OpenAPI document is large, imports in ElasticEmail.apis and ElasticEmail.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from ElasticEmail.api.default_api import DefaultApi
• from ElasticEmail.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import ElasticEmail
from ElasticEmail.apis import *
from ElasticEmail.models import *