Package: amply-mail
AmplyThis is the Amply Python SDK that integrates with thev1 API.Table of ContentsInstallQuick StartMethodsemailInstallPrerequisitesPython 2.7, 3.5, 3.6, 3.7, or 3.8Amply account,sign up here.Access TokenObtain your access token from theAmply UI.Install Packagepip install amply-mailDomain VerificationAdd domains you want to sendfromvia theVerified Domainstab on your dashboard.Any emails you attempt to send from an unverified domain will be rejected.  Once verified, Amply immediately starts warming up your domain and IP reputation.  This warmup process will take approximately one week before maximal deliverability has been reached.Quick StartThe following is the minimum needed code to send a simple email. Use this example, and modify thetoandfromvariables:importamplyimportosamply.set_access_token(os.environ.get('AMPLY_ACCESS_TOKEN'))try:response=amply.email.create({'to':'test@example.com','from':'test@verifieddomain.com','subject':'My first Amply email!','text':'This is easy','html':'<strong>and fun :)</strong>'})exceptExceptionase:ifhasattr(e,'errors'):print('Validation or resource not found error')print(e.errors)elifhasattr(e,'text'):print('Generic API error:%s'%(e.text))else:raiseeOnce you execute this code, you should have an email in the inbox of the recipient.  You can check the status of your email in the UI from theSearch,SQL, orUserspage.MethodsemailParameter(s)Descriptionto, cc, bccEmail address of the recipient(s).  This may be a stringTest <test@example.com>, an object{name: 'Test', email: 'test@example.com'}, or an array of strings and objects.personalizationsFor fine tuned access, you may override the to, cc, and bcc keys and use advanced personalizations.  See the API guidehere.fromEmail address of the sender.  This may be formatted as a string or object.  An array of senders is not allowed.subjectSubject of the message.htmlHTML portion of the message.textText portion of the message.contentAn array of objects containing the following keys:type(required),value(required).templateThe template to use. This may be a string (the UUID of the template), an array of UUID's (useful for A/B/... testing where one is randomly selected), or an object of the format{template1Uuid: 0.25, template2Uuid: 0.75}(useful for weighted A/B/... testing).dynamic_template_dataThe dynamic data to be replaced in your template.  This is an object of the format{variable1: 'replacement1', ...}. Variables should be defined in your template body using handlebars syntax{{variable1}}.reply_toEmail address of who should receive replies.  This may be a string or an object withnameandemailkeys.headersAn object where the header name is the key and header value is the value.ip_or_pool_uuidThe UUID of the IP address or IP pool you want to send from.  Default is your Global pool.unsubscribe_group_uuidThe UUID of the unsubscribe group you want to associate with this email.attachments[][content]A base64 encoded string of your attachment's content.attachments[][type]The MIME type of your attachment.attachments[][filename]The filename of your attachment.attachments[][disposition]The disposition of your attachment (inlineorattachment).attachments[][content_id]The content ID of your attachment.clicktrackingEnable or disable clicktracking.categoriesAn array of email categories you can associate with your message.substitutionsAn object of the format{subFrom: 'subTo', ...}of substitutions.send_atDelay sending until a specified time. An ISO8601 formatted string with timezone information.Exampleamply.email.create({'to':'example@test.com','from':'From <example@verifieddomain.com>','text':'Text part','html':'HTML part','personalizations':[{'to':[{'name':'Override To','email':'test@example.com'}]}],'content':[{'type':'text/testing','value':'some custom content type'}],'subject':'A new email!','reply_to':'Reply To <test@example.com>','template':'faecb75b-371e-4062-89d5-372b8ff0effd','dynamic_template_data':{'name':'Jimmy'},'unsubscribe_group_uuid':'5ac48b43-6e7e-4c51-817d-f81ea0a09816','ip_or_pool_uuid':'2e378fc9-3e23-4853-bccb-2990fda83ca9','attachments':[{'content':'dGVzdA==','filename':'test.txt','type':'text/plain','disposition':'inline'}],'headers':{'X-Testing':'Test'},'categories':['Test'],'clicktracking':True,'substitutions':{'sub1':'replacement1'},'send_at':datetime.datetime.utcnow().replace(tzinfo=datetime.timezone.utc).isoformat()})