Table of Contents

Codeunit "Mail Management"

ID 9520
Namespace: System.EMail

Properties

Name Value
Permissions TableData "Email Attachments" = rimd
EventSubscriberInstance Manual

Methods

AddSource

procedure AddSource(TableId: Integer; SystemId: Guid)

Parameters

Name Type Description
TableId Integer
SystemId Guid

AddSendTo

procedure AddSendTo(EmailAddresses: Text)

Parameters

Name Type Description
EmailAddresses Text

InitializeFrom

procedure InitializeFrom(NewHideMailDialog: Boolean; NewHideEmailSendingError: Boolean)

Parameters

Name Type Description
NewHideMailDialog Boolean
NewHideEmailSendingError Boolean

SetHideMailDialog

procedure SetHideMailDialog(NewHideMailDialog: Boolean)

Parameters

Name Type Description
NewHideMailDialog Boolean

SetHideEmailSendingError

procedure SetHideEmailSendingError(NewHideEmailSendingError: Boolean)

Parameters

Name Type Description
NewHideEmailSendingError Boolean

CheckValidEmailAddresses

procedure CheckValidEmailAddresses(Recipients: Text)

Parameters

Name Type Description
Recipients Text

CheckValidEmailAddress

[TryFunction]
procedure CheckValidEmailAddress(EmailAddress: Text): Boolean

Parameters

Name Type Description
EmailAddress Text

Returns

Type Description
Boolean

ValidateEmailAddressField

[TryFunction]
procedure ValidateEmailAddressField(var EmailAddress: Text): Boolean

Parameters

Name Type Description
EmailAddress Text

Returns

Type Description
Boolean

IsEnabled

procedure IsEnabled(): Boolean

Returns

Type Description
Boolean

IsCancelled

procedure IsCancelled(): Boolean

Returns

Type Description
Boolean

IsSent

procedure IsSent(): Boolean

Returns

Type Description
Boolean

Send

procedure Send(var ParmEmailItem: Record "Email Item"; EmailScenario: Enum "Email Scenario"): Boolean

Parameters

Name Type Description
ParmEmailItem Table System.EMail."Email Item"
EmailScenario Enum System.Email."Email Scenario"

Returns

Type Description
Boolean

Send

procedure Send(var ParmEmailItem: Record "Email Item"; EmailScenario: Enum "Email Scenario"; Enqueue: Boolean): Boolean

Parameters

Name Type Description
ParmEmailItem Table System.EMail."Email Item"
EmailScenario Enum System.Email."Email Scenario"
Enqueue Boolean

Returns

Type Description
Boolean

SendMailOrDownload

procedure SendMailOrDownload(var TempEmailItem: Record "Email Item" temporary; HideMailDialog: Boolean; EmailScenario: Enum "Email Scenario")

Parameters

Name Type Description
TempEmailItem Table System.EMail."Email Item"
HideMailDialog Boolean
EmailScenario Enum System.Email."Email Scenario"

SendMailOrDownload

procedure SendMailOrDownload(var TempEmailItem: Record "Email Item" temporary; HideMailDialog: Boolean; EmailScenario: Enum "Email Scenario"; Enqueue: Boolean)

Parameters

Name Type Description
TempEmailItem Table System.EMail."Email Item"
HideMailDialog Boolean
EmailScenario Enum System.Email."Email Scenario"
Enqueue Boolean

DownloadPdfAttachment

procedure DownloadPdfAttachment(var TempEmailItem: Record "Email Item" temporary)

Parameters

Name Type Description
TempEmailItem Table System.EMail."Email Item"

GetSenderEmailAddress

procedure GetSenderEmailAddress(EmailScenario: Enum "Email Scenario"): Text[250]

Parameters

Name Type Description
EmailScenario Enum System.Email."Email Scenario"

Returns

Type Description
Text[250]

IsHandlingGetEmailBody

procedure IsHandlingGetEmailBody(): Boolean

Returns

Type Description
Boolean

IsHandlingGetEmailBodyCustomer

procedure IsHandlingGetEmailBodyCustomer(): Boolean

Returns

Type Description
Boolean

IsHandlingGetEmailBodyVendor

procedure IsHandlingGetEmailBodyVendor(): Boolean

Returns

Type Description
Boolean

Events

OnSetIsHandlingGetEmailBodyCustomer

[IntegrationEvent(False,False)]
local procedure OnSetIsHandlingGetEmailBodyCustomer(var Result: Boolean)

Parameters

Name Type Description
Result Boolean

OnSetIsHandlingGetEmailBodyVendor

[IntegrationEvent(False,False)]
local procedure OnSetIsHandlingGetEmailBodyVendor(var Result: Boolean)

Parameters

Name Type Description
Result Boolean

OnBeforeCheckValidEmailAddresses

[IntegrationEvent(False,False)]
local procedure OnBeforeCheckValidEmailAddresses(Recipients: Text; var IsHandled: Boolean)

Parameters

Name Type Description
Recipients Text
IsHandled Boolean

OnBeforeCheckValidEmailAddr

[IntegrationEvent(False,False)]
local procedure OnBeforeCheckValidEmailAddr(EmailAddress: Text; var IsHandled: Boolean)

Parameters

Name Type Description
EmailAddress Text
IsHandled Boolean

OnBeforeDoSending

[IntegrationEvent(False,False)]
local procedure OnBeforeDoSending(var CancelSending: Boolean)

Parameters

Name Type Description
CancelSending Boolean

OnBeforeIsEnabled

[IntegrationEvent(False,False)]
local procedure OnBeforeIsEnabled(OutlookSupported: Boolean; var Result: Boolean; var IsHandled: Boolean)

Parameters

Name Type Description
OutlookSupported Boolean
Result Boolean
IsHandled Boolean

OnBeforeDownloadPdfAttachment

[IntegrationEvent(False,False)]
local procedure OnBeforeDownloadPdfAttachment(var TempEmailItem: Record "Email Item" temporary; var IsHandled: Boolean)

Parameters

Name Type Description
TempEmailItem Table System.EMail."Email Item"
IsHandled Boolean

OnBeforeQualifyFromAddress

[IntegrationEvent(False,False)]
local procedure OnBeforeQualifyFromAddress(var TempEmailItem: Record "Email Item" temporary)

Parameters

Name Type Description
TempEmailItem Table System.EMail."Email Item"

OnBeforeValidateEmailAddressField

[IntegrationEvent(False,False)]
local procedure OnBeforeValidateEmailAddressField(var EmailAddress: Text; var IsHandled: Boolean)

Parameters

Name Type Description
EmailAddress Text
IsHandled Boolean

OnBeforeSendMailOnWinClient

Obsolete

This element will become obsolete from version 27.0. This event is never raised.

[Obsolete(This event is never raised.,27.0)]
[IntegrationEvent(False,False)]
local procedure OnBeforeSendMailOnWinClient(var TempEmailItem: Record "Email Item" temporary)

Parameters

Name Type Description
TempEmailItem Table System.EMail."Email Item"

OnAfterDeleteTempAttachments

Obsolete

This element will become obsolete from version 27.0. This event is never raised.

[Obsolete(This event is never raised.,27.0)]
[IntegrationEvent(False,False)]
local procedure OnAfterDeleteTempAttachments(var EmailItem: Record "Email Item")

Parameters

Name Type Description
EmailItem Table System.EMail."Email Item"

OnAfterGetSenderEmailAddress

[IntegrationEvent(False,False)]
local procedure OnAfterGetSenderEmailAddress(var EmailItem: Record "Email Item")

Parameters

Name Type Description
EmailItem Table System.EMail."Email Item"

OnAfterIsBackground

[IntegrationEvent(True,False)]
local procedure OnAfterIsBackground(var Result: Boolean)

Parameters

Name Type Description
Result Boolean

OnAfterGetAttachmentName

[IntegrationEvent(False,False)]
local procedure OnAfterGetAttachmentName(AttachmentNames: List of [Text]; Index: Integer; var AttachmentName: Text[250]; var TempEmailItem: Record "Email Item" temporary)

Parameters

Name Type Description
AttachmentNames List of [Text]
Index Integer
AttachmentName Text[250]
TempEmailItem Table System.EMail."Email Item"

OnAfterSendMailOrDownload

[IntegrationEvent(False,False)]
local procedure OnAfterSendMailOrDownload(var TempEmailItem: Record "Email Item" temporary; var MailSent: Boolean)

Parameters

Name Type Description
TempEmailItem Table System.EMail."Email Item"
MailSent Boolean

OnBeforeImageBase64ToUrl

[IntegrationEvent(False,False)]
local procedure OnBeforeImageBase64ToUrl(var BodyText: Text; var SearchText: Text; Regex: DotNet "System.Text.RegularExpressions.Regex"; MemoryStream: DotNet "System.IO.MemoryStream"; var MediaId: Guid; var Base64: Text; Convert: DotNet "System.Convert"; var IsHandled: Boolean)

Parameters

Name Type Description
BodyText Text
SearchText Text
Regex "System.Text.RegularExpressions.Regex"
MemoryStream "System.IO.MemoryStream"
MediaId Guid
Base64 Text
Convert "System.Convert"
IsHandled Boolean

OnQualifyFromAddressOnAfterGetEmailAccount

[IntegrationEvent(False,False)]
local procedure OnQualifyFromAddressOnAfterGetEmailAccount(var TempEmailItem: Record "Email Item" temporary; EmailScenario: Enum "Email Scenario"; var TempEmailAccount: Record "Email Account" temporary)

Parameters

Name Type Description
TempEmailItem Table System.EMail."Email Item"
EmailScenario Enum System.Email."Email Scenario"
TempEmailAccount Table System.Email."Email Account"

OnSendOnBeforeQualifyFromAddress

[IntegrationEvent(False,False)]
local procedure OnSendOnBeforeQualifyFromAddress(var TempEmailItem: Record "Email Item" temporary; EmailScenario: Enum "Email Scenario")

Parameters

Name Type Description
TempEmailItem Table System.EMail."Email Item"
EmailScenario Enum System.Email."Email Scenario"

OnSendMailOrDownloadOnBeforeMailManagementIsSent

[IntegrationEvent(False,False)]
local procedure OnSendMailOrDownloadOnBeforeMailManagementIsSent(var MailManagement: Codeunit "Mail Management"; TempEmailItem: Record "Email Item" temporary)

Parameters

Name Type Description
MailManagement Codeunit System.EMail."Mail Management"
TempEmailItem Table System.EMail."Email Item"

OnSendViaEmailModuleOnAfterAddAttachments

[IntegrationEvent(False,False)]
local procedure OnSendViaEmailModuleOnAfterAddAttachments(var Message: Codeunit "Email Message"; var TempEmailItem: Record "Email Item" temporary)

Parameters

Name Type Description
Message Codeunit System.Email."Email Message"
TempEmailItem Table System.EMail."Email Item"

OnSendViaEmailModuleOnAfterCreateMessage

[IntegrationEvent(False,False)]
local procedure OnSendViaEmailModuleOnAfterCreateMessage(var Message: Codeunit "Email Message"; var TempEmailItem: Record "Email Item" temporary)

Parameters

Name Type Description
Message Codeunit System.Email."Email Message"
TempEmailItem Table System.EMail."Email Item"

OnSendViaEmailModuleOnAfterEmailSend

[IntegrationEvent(False,False)]
local procedure OnSendViaEmailModuleOnAfterEmailSend(var Message: Codeunit "Email Message"; var TempEmailItem: Record "Email Item" temporary; var MailSent: Boolean; var Cancelled: Boolean; var HideEmailSendingError: Boolean)

Parameters

Name Type Description
Message Codeunit System.Email."Email Message"
TempEmailItem Table System.EMail."Email Item"
MailSent Boolean
Cancelled Boolean
HideEmailSendingError Boolean

OnBeforeSendViaEmailModule

[IntegrationEvent(False,False)]
local procedure OnBeforeSendViaEmailModule(var TempEmailItem: Record "Email Item" temporary; EmailScenario: Enum "Email Scenario"; var TempEmailAccount: Record "Email Account" temporary; HideMailDialog: Boolean; var IsHandled: Boolean; var Result: Boolean)

Parameters

Name Type Description
TempEmailItem Table System.EMail."Email Item"
EmailScenario Enum System.Email."Email Scenario"
TempEmailAccount Table System.Email."Email Account"
HideMailDialog Boolean
IsHandled Boolean
Result Boolean

OnAfterDownloadPDFAttachment

[IntegrationEvent(False,False)]
local procedure OnAfterDownloadPDFAttachment()

OnSendViaEmailModuleOnBeforeOpenInEditorModally

[IntegrationEvent(False,False)]
local procedure OnSendViaEmailModuleOnBeforeOpenInEditorModally(EmailScenario: Enum "Email Scenario"; var TempEmailAccount: Record "Email Account" temporary; var Message: Codeunit "Email Message"; var HideMailDialog: Boolean)

Parameters

Name Type Description
EmailScenario Enum System.Email."Email Scenario"
TempEmailAccount Table System.Email."Email Account"
Message Codeunit System.Email."Email Message"
HideMailDialog Boolean

See also