Connect / Client / send_outbound_email

send_outbound_email

Connect.Client.send_outbound_email(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.send_outbound_email(
    InstanceId='string',
    FromEmailAddress={
        'EmailAddress': 'string',
        'DisplayName': 'string'
    },
    DestinationEmailAddress={
        'EmailAddress': 'string',
        'DisplayName': 'string'
    },
    AdditionalRecipients={
        'CcEmailAddresses': [
            {
                'EmailAddress': 'string',
                'DisplayName': 'string'
            },
        ]
    },
    EmailMessage={
        'MessageSourceType': 'TEMPLATE'|'RAW',
        'TemplatedMessageConfig': {
            'KnowledgeBaseId': 'string',
            'MessageTemplateId': 'string',
            'TemplateAttributes': {
                'CustomAttributes': {
                    'string': 'string'
                },
                'CustomerProfileAttributes': 'string'
            }
        },
        'RawMessage': {
            'Subject': 'string',
            'Body': 'string',
            'ContentType': 'string'
        }
    },
    TrafficType='GENERAL'|'CAMPAIGN',
    SourceCampaign={
        'CampaignId': 'string',
        'OutboundRequestId': 'string'
    },
    ClientToken='string'
)

Parameters:

• InstanceId (string) – [REQUIRED]

• FromEmailAddress (dict) –

  [REQUIRED]

  • EmailAddress (string) – [REQUIRED]

  • DisplayName (string) –

• DestinationEmailAddress (dict) –

  [REQUIRED]

  • EmailAddress (string) – [REQUIRED]

  • DisplayName (string) –

• AdditionalRecipients (dict) –

  • CcEmailAddresses (list) –

    • (dict) –

      • EmailAddress (string) – [REQUIRED]

      • DisplayName (string) –

• EmailMessage (dict) –

  [REQUIRED]

  • MessageSourceType (string) – [REQUIRED]

  • TemplatedMessageConfig (dict) –

    • KnowledgeBaseId (string) – [REQUIRED]

    • MessageTemplateId (string) – [REQUIRED]

    • TemplateAttributes (dict) – [REQUIRED]

      • CustomAttributes (dict) –

        • (string) –

          • (string) –

      • CustomerProfileAttributes (string) –

  • RawMessage (dict) –

    • Subject (string) – [REQUIRED]

    • Body (string) – [REQUIRED]

    • ContentType (string) – [REQUIRED]

• TrafficType (string) – [REQUIRED]

• SourceCampaign (dict) –

  • CampaignId (string) –

  • OutboundRequestId (string) –

• ClientToken (string) – This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.ServiceQuotaExceededException

• Connect.Client.exceptions.AccessDeniedException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.InternalServiceException

• Connect.Client.exceptions.IdempotencyException