Skip to content

Encrypted

Overview

The Encrypted property of the Account class is used to specify whether the account credentials are encrypted. When using encrypted credentials, it uses AES 256-bit password protected encryption. This can be found by calling the EncodeKey() method, which will return your encrypted credential.

If using Mailgun, only API Key encryption is supported, the url must be left in plaintext. If using MS Graph API, only Client Secret encryption is supported.

For example, if you want to use an encrypted API key so not to expose sensitive information, you would call EncodeKey() in the immediate window with your api key as the sole parameter. You would collect this value, and then, when adding an account replace your plain text API key with the encrypted versions, and set the encrypted flag to true.

Then when sending the email, we decrypt the encrypted credentials and go through the sending process. This means that your plain text API key will never be exposed in the code. Further, the key used to encrypt the api-key is never exposed, as it is entirely held on the back-end .dll.

Syntax

vba
' To check whether account is encrypted
Account.Encrypted

' To set the encrypted flag
Account.Encrypted = true

Return Value

When getting Encrypted, it returns a Boolean that specifies whether the flag is set to true.

Example

This example demonstrates how to set an encrypted account:

vba
Sub SetEncryptedMailgunAccount()
    MailerApp.Accounts.Add SMTPAddress:="test@example.com", _
                            ApiKey:="encrypted-api-key", _
                            ApiUrl:="api-url", _
                            Encrypted:=True
                            AccountType:=olMailgun  
End Sub