E-mails and notifications
There are two different things that can be customized in Signer e-mails:
- How each organization's e-mails look, with logo, colors and some fixed texts. Configured by the organization administrator, in the application itself.
- The e-mail and notification texts, overriding any text, in any language. Configured by the system administrator.
tip
To configure the sending server (your own SMTP), see E-mail server (SMTP), in the Integration section.
Per-organization customization
Each organization has its own e-mail settings, applied to the notifications of that organization's documents:
| Setting | What it does |
|---|---|
Logo | Logo shown at the top of the e-mails. When not provided, the instance light-logo is used |
ThemeColor | Main e-mail color |
ThemeLinkColor | Link color |
ButtonBackgroundColor | Button background color |
ButtonTextColor | Button text color |
SupportEmailAddress | Support e-mail shown to the recipient |
EmailSubjectPrefix | Prefix added to the subject of every e-mail of the organization |
EmailExtraContent | Extra content included in the e-mail body |
Through the API, these settings live in the mail object of the organization settings:
GET /api/organizations/{orgId}/settings
PUT /api/organizations/{orgId}/settings
{
"mail": {
"themeColor": "#1B4965",
"themeLinkColor": "#5FA8D3",
"buttonBackgroundColor": "#1B4965",
"buttonTextColor": "#FFFFFF",
"supportEmailAddress": "support@yourcompany.com",
"emailSubjectPrefix": "[Your Company]",
"emailExtraContent": "If you have any questions, talk to your account manager."
}
}
The logo is sent as an upload, as shown in
Getting Started, and referenced in the mail.logo
field.
tip
This is the customization most customers are after, and it does not depend on the deployment team: the organization administrator does it alone, from the organization settings screen.
E-mail and notification texts
Any e-mail or notification text can be overridden through the CustomResources configuration section,
with no product change. It is the mechanism used, for example, to replace "Sign document" with a term of
your own.
The configuration is organized in localizers (Localizers), each one matching a set of texts:
| Localizer | What it holds |
|---|---|
MailFormatter | E-mail body texts: greetings, buttons, instructions, invoice texts |
NotificationRepository | Titles and descriptions of the in-app notifications |
NotificationService | E-mail subjects and document event messages |
For each key you can set the value per language (pt, en, es) and a Default value, used when there
is no value for the requested language:
CustomResources__Localizers__MailFormatter__Resources__Sign__en=Sign contract
CustomResources__Localizers__MailFormatter__Resources__Sign__Default=Sign contract
In JSON format (appsettings.json):
{
"CustomResources": {
"Localizers": {
"MailFormatter": {
"Resources": {
"Sign": {
"pt": "Assinar contrato",
"en": "Sign contract",
"es": "Firmar contrato",
"Default": "Sign contract"
}
}
}
}
}
}
note
The CustomResources section is available since version 1.37.0. See also the reference in
Signer settings.
Available keys
The keys below are the ones that can be overridden in each localizer.
MailFormatter (114 keys)
AcceptInviteAddedActionsAddedObserverTextAddedObserversAdministrationAreaApprovalCompletedTextApproveApproverAuthenticationCodeBankSlipAttachmentFileNameBatchTextApproveBatchTextDeleteBatchTextMoveBatchTextRefuseBatchTextSignButtonViewAllDocumentsCancelReasonClosedInvoiceOrganizationTextClosedInvoicePersonalTextClosedInvoiceSubjectCompletedFastSignatureTextContactMessageCreatedInvoiceOrganizationTextCreatedInvoicePersonalTextCreatedInvoiceSubjectDeletedActionsDeletedDocumentTextDeletedObserversDocumentAttachmentDeletedTextDocumentAttachmentsAddedTextDocumentCanceledTextDocumentInfoUpdatedTextDocumentPausedTextDocumentRefusalTextDocumentResumedTextDocumentVersionAddedTextDocumentsDocumentsConcludedIntroPluralDocumentsDeletedIntroPluralDownloadReportEditedFlowIntroExpiredDocumentTextExtraLinkMessageFailedInvoiceChargeFailedInvoiceChargeOrganizationTextFailedInvoiceChargePersonalTextFailoverMessageFirstAccessFirstDocumentGrantAccessGreetingsGreetingsUserHelloUserInfoCurrentTagsInfoDeletedTagsInfoDescriptionInfoExpirationDateInfoFromToInfoNameInfoRemovedInstructionsJoinOrganizationInviteNewTermsOfUseTextObserversIntroParticipatedDocumentConcludedPauseReasonPendingActionIntroPendingActionIntroPluralPendingActionIntroPluralMobilePendingApprovalTextPendingApprovalTextMobilePendingDocumentsTextPendingSignatureTextPendingSignatureTextMobilePendingSignatureTextSMSPixPaymentTextPixPaymentTitleReceiptIssuedOrganizationTextReceiptIssuedPersonalTextReceiptIssuedSubjectRefusalReasonReminderInvoiceReminderInvoiceOrganizationTextReminderInvoicePersonalTextReportAvailableReportErrorRequestAccessUserInfoRuleSetPasswordSignSignIsEasySignWithQrCodeSignatureCompletedTextSignatureConcludedTextSignerStartSubjectAuthenticationCodeSubjectReportAvailableSubjectReportErrorSuccessInvoiceChargeSuccessInvoiceChargeOrganizationTextSuccessInvoiceChargePersonalTextTermsOfUseUpdatedAdminTextTryCompleteRegistrationTryNowUnsubscribeUnsubscribeErrorUnsubscribeSuccessViewDocumentViewDocumentsViewInvoiceViewTermsOfUseWelcomeToWelcomeUser
NotificationRepository (22 keys)
AccessRequestAddedAsObserverCreateBatchApprovedCreateBatchDeletedCreateBatchMovedCreateBatchRefusedCreateBatchSignedDocumentCompletedDocumentInformationUpdatedDocumentSignedDocumentsCompletedDocumentsDeletedElectronicSignatureAuthCodeObserversDocumentsPendingActionPendingActionMobilePendingApprovalPendingApprovalMobilePendingSignaturePendingSignatureMobileTermsOfUseUpdatedAdminUpdateTermsOfUse
NotificationService (31 keys)
CreateBatchDeletedDocumentApprovedDocumentAttachmentDeletedDocumentAttachmentsAddedDocumentCanceledDocumentDeletedDocumentExpiredDocumentFlowEditedDocumentHasNoPendingFlowActionDocumentIsPausedDocumentPausedDocumentRefusedDocumentResumedDocumentSignedDocumentVersionAddedSubjectDocumentCanceledSubjectDocumentConcludedSubjectDocumentDeletedSubjectDocumentExpiredSubjectDocumentPausedSubjectDocumentRefusedSubjectDocumentResumedSubjectDocumentVersionAddedSubjectElectronicSignatureAuthenticationCodeSubjectFastSignatureCompletedSubjectFlowActionCompletedSubjectFlowEditedSubjectMultiplePendingActionsSubjectObserverAddedSubjectPendingApprovalSubjectPendingSignature
See also
- E-mail server (SMTP) covers configuring the sending server.
- Visual identity has the default logo used in the instance e-mails.
- Generated documents covers per-organization customization of the printer friendly version.
- Signer settings is the complete reference of the configuration sections.