Interface "Email Connector"
An e-mail connector interface used to creating e-mail accounts and sending an e-mail.
Methods
Send
Sends an e-mail using the provided account.
procedure Send(EmailMessage: Codeunit "Email Message", AccountId: Guid)
Parameters
Name | Type | Description |
---|---|---|
EmailMessage | System.Email."Email Message" |
The email message that is to be sent out. |
AccountId | Guid |
The email account ID which is used to send out the email. |
GetAccounts
Gets the e-mail accounts registered for the connector.
procedure GetAccounts(var Accounts: Record "Email Account" temporary)
Parameters
Name | Type | Description |
---|---|---|
Accounts | Record "Email Account" temporary |
Out variable that holds the registered e-mail accounts for the connector. |
ShowAccountInformation
Shows the information for an e-mail account.
procedure ShowAccountInformation(AccountId: Guid)
Parameters
Name | Type | Description |
---|---|---|
AccountId | Guid |
The ID of the e-mail account |
RegisterAccount
Registers an e-mail account for the connector.
procedure RegisterAccount(var EmailAccount: Record "Email Account" temporary): Boolean
Parameters
Name | Type | Description |
---|---|---|
EmailAccount | Record "Email Account" temporary |
Returns
Type | Description |
---|---|
Boolean |
True if an account was registered. |
Remarks
The out parameter must hold the account ID of the added account.
DeleteAccount
Deletes an e-mail account for the connector.
procedure DeleteAccount(AccountId: Guid): Boolean
Parameters
Name | Type | Description |
---|---|---|
AccountId | Guid |
The ID of the e-mail account |
Returns
Type | Description |
---|---|
Boolean |
True if an account was deleted. |
GetLogoAsBase64
Provides a custom logo for the connector that shows in the Setup Email Account Guide.
procedure GetLogoAsBase64(): Text
Returns
Type | Description |
---|---|
Text |
Base64 encoded image. |
Remarks
The recomended image size is 128x128.
GetDescription
Provides a more detailed description of the connector.
procedure GetDescription(): Text[250]
Returns
Type | Description |
---|---|
Text[250] |
A more detailed desctiption of the connector. |