Show / Hide Table of Contents

Class ConsentManagementEmail

Inheritance
object
ConsentManagementEmail
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.dll
Syntax
public class ConsentManagementEmail

Properties

HasTemplate

Declaration
public bool HasTemplate { get; }
Property Value
Type Description
bool

Methods

CreateAsync(Person, CancellationToken)

Declaration
public static Task<ConsentManagementEmail> CreateAsync(Person person, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Person person
CancellationToken cancellationToken
Returns
Type Description
Task<ConsentManagementEmail>

CreateAsync(int, string, int, int, string, CancellationToken)

Declaration
public static Task<ConsentManagementEmail> CreateAsync(int personId, string emailAddress, int emailTemplateId, int cultureLcidId, string subject, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int personId
string emailAddress
int emailTemplateId
int cultureLcidId
string subject
CancellationToken cancellationToken
Returns
Type Description
Task<ConsentManagementEmail>

GetBestLanguageForPersonAsync(int, int, CancellationToken)

Declaration
public static Task<string> GetBestLanguageForPersonAsync(int personId, int templateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int personId
int templateId
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetBestLanguageForPersonAsync(int, string[], int, int, CancellationToken)

Declaration
public static Task<string> GetBestLanguageForPersonAsync(int supportLangId, string[] supportedLanguages, int countryId, int overrideLcid, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int supportLangId
string[] supportedLanguages
int countryId
int overrideLcid
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetBestLanguageForPersonAsync(string[], int, CancellationToken)

Declaration
public static Task<string> GetBestLanguageForPersonAsync(string[] supportedLanguages, int personId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string[] supportedLanguages
int personId
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetFromAddress()

Get the From: address to use.

  1. Get the default email address (first) of the logged in user If in a context without logged in user:
  2. If override address is provided, use this (default sender adress from smtp config is provided here)

returns empty string otherwise.

Declaration
public string GetFromAddress()
Returns
Type Description
string

From address to use or empty string

GetPersonEmailAsync(CancellationToken)

Declaration
public Task<string> GetPersonEmailAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<string>

GetSupportedLanguagesForDocTemplateAsync(string, CancellationToken)

Gets template languages for a given document template filename

Declaration
public static Task<string[]> GetSupportedLanguagesForDocTemplateAsync(string tmplName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string tmplName

Template filename

CancellationToken cancellationToken
Returns
Type Description
Task<string[]>

SuperOffice language codes: ["US", "SW", "GE"] or empty array if no language-specific variant exists

GetTemplateVariables()

Declaration
public TemplateVariables GetTemplateVariables()
Returns
Type Description
TemplateVariables

SendNewPersonConfirmationEmailAsync(CancellationToken)

Send email to the new person and archive as a document on the newly created person.

Declaration
public Task SendNewPersonConfirmationEmailAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

SmtpConnectionExists()

Declaration
public bool SmtpConnectionExists()
Returns
Type Description
bool

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top