Skip to main content

EmailConfig

The organization's email settings. Secrets are never returned.

type EmailConfig {
  createdAt: DateTime!
  createdBy: String!
  dailyReportTime: String
  defaultRecipients: [String!]
  emailSignature: String
  fromEmail: String!
  fromName: String!
  hasApiKey: Boolean
  hasSmtpPassword: Boolean
  id: String!
  isEnabled: Boolean!
  monthlyReportDate: Int
  organizationId: String!
  provider: EmailProvider!
  replyToEmail: String
  sendAlerts: Boolean!
  sendNotifications: Boolean!
  sendReports: Boolean!
  smtpHost: String
  smtpPort: Int
  smtpSecure: Boolean
  smtpUser: String
  updatedAt: DateTime!
  updatedBy: String!
  weeklyReportDay: Int
}

Fields

`EmailConfig.createdAt` ● `DateTime!` non-null scalar

When the record was created.

`EmailConfig.createdBy` ● `String!` non-null scalar

The ID of the user who created the settings.

`EmailConfig.dailyReportTime` ● `String` scalar

The time of day the daily report is sent.

`EmailConfig.defaultRecipients` ● `[String!]` list scalar

The addresses reports and alerts go to by default.

`EmailConfig.emailSignature` ● `String` scalar

The signature added to mail.

`EmailConfig.fromEmail` ● `String!` non-null scalar

The address mail is sent from.

`EmailConfig.fromName` ● `String!` non-null scalar

The name mail is sent from.

`EmailConfig.hasApiKey` ● `Boolean` scalar

True when an API key is stored.

`EmailConfig.hasSmtpPassword` ● `Boolean` scalar

True when an SMTP password is stored.

`EmailConfig.id` ● `String!` non-null scalar

The unique ID of this record.

`EmailConfig.isEnabled` ● `Boolean!` non-null scalar

True when sending is switched on.

`EmailConfig.monthlyReportDate` ● `Int` scalar

The day of the month the monthly report is sent.

`EmailConfig.organizationId` ● `String!` non-null scalar

The ID of the organization the record belongs to.

`EmailConfig.provider` ● `EmailProvider!` non-null enum

The email provider: SMTP, SENDGRID, AWS_SES, MAILGUN, RESEND or GOOGLE.

`EmailConfig.replyToEmail` ● `String` scalar

The address replies go to.

`EmailConfig.sendAlerts` ● `Boolean!` non-null scalar

True to send alert emails.

`EmailConfig.sendNotifications` ● `Boolean!` non-null scalar

True to send notification emails.

`EmailConfig.sendReports` ● `Boolean!` non-null scalar

True to send report emails.

`EmailConfig.smtpHost` ● `String` scalar

The SMTP server.

`EmailConfig.smtpPort` ● `Int` scalar

The SMTP port.

`EmailConfig.smtpSecure` ● `Boolean` scalar

True to use a secure connection.

`EmailConfig.smtpUser` ● `String` scalar

The SMTP user name.

`EmailConfig.updatedAt` ● `DateTime!` non-null scalar

When the record was last changed.

`EmailConfig.updatedBy` ● `String!` non-null scalar

The ID of the user who last changed the record.

`EmailConfig.weeklyReportDay` ● `Int` scalar

The day of the week the weekly report is sent.

Returned By

createEmailConfig mutation ● emailConfig query ● updateEmailConfig mutation

Fields
Returned By