Service - Contact Method Email
Revision as of 00:52, 9 March 2025 by Sven the Barbarian (talk | contribs)
Overview
Manages email contact methods for users, details are not part of the public transparency followed across the majority of the project in order to protect against emails being scraped.
Repository
https://bitbucket.org/izara-core-shared/izara-core-shared-contact-method-email
DynamoDB tables
EmailAddress
Fields
- userContactId
- (partition key)
- string
- a UUID generated when creating the email record, or sent by Service - User Contact Manager
- string
Object Schemas
objType
{
objectType: "email",
extendObjType: { // core object that this object extends
objectType: "userContact",
serviceTag: "UserContactManager",
},
storageResources: {},
fieldNames: {}
}
emailAddress
{
objectType: "emailAddress",
canDelete: false,
complexFilterServiceTag: "complexFilter",
overWriteHandlers: { // optional, if not set will create default handlers, if empty will not create handler and main function
create: ['hdrSqs'], // default: ['hdrApi', 'hdrSqs']
update: [], // default: ['hdrApi', 'hdrSqs']
get: [], // default: ['hdrApi', 'hdrInv']
delete: [], // default: ['hdrApi', 'hdrSqs']
},
overwriteGeneratedMainFunction: ["update", "get", "delete"],
storageResources: {
dynamoDB: {
storageType: "dynamoDB",
tableName: "EmailAddress"
}
},
fieldNames: { // see Per Service Schemas
userContactId: {
type: "string",
optionalOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
},
email: {
type: "string",
requiredOnCreate: true,
canUpdate: false,
validation: {
pattern: pattern
},
storageResourceTags: ['dynamoDB']
}
},
identifiers: [
{
type: "partitionKey",
fieldName: "userContactId"
}
]
}
fieldNames
- userContactId
- a UUID generated when creating the email record, or sent by Service - User Contact Manager
- string
Notes
- Service - User Contact Manager sets the notification group's uniqueID to be {emailUniqueId}_{uuid}, we could split the notificationGroupUniqueId to pull out the emailUniqueId, alternative is we also add the emailID to notification group's additionalData which is what we will do because it is more strongly defined