Skip to main content

UpdateEmailConfigInput

Changes to the organization's email settings. Omitted fields stay as they are.

input UpdateEmailConfigInput {
  apiKey: String
  dailyReportTime: String
  defaultRecipients: [String!]
  emailSignature: String
  fromEmail: String
  fromName: String
  isEnabled: Boolean
  monthlyReportDate: Int
  provider: EmailProvider
  replyToEmail: String
  sendAlerts: Boolean
  sendNotifications: Boolean
  sendReports: Boolean
  smtpHost: String
  smtpPassword: String
  smtpPort: Int
  smtpSecure: Boolean
  smtpUser: String
  weeklyReportDay: Int
}

Fields

`UpdateEmailConfigInput.apiKey` ● `String` scalar

The provider API key. It is write-only.

`UpdateEmailConfigInput.dailyReportTime` ● `String` scalar

The time of day the daily report is sent.

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

The addresses reports and alerts go to by default.

`UpdateEmailConfigInput.emailSignature` ● `String` scalar

The signature added to mail.

`UpdateEmailConfigInput.fromEmail` ● `String` scalar

The address mail is sent from.

`UpdateEmailConfigInput.fromName` ● `String` scalar

The name mail is sent from.

`UpdateEmailConfigInput.isEnabled` ● `Boolean` scalar

True when sending is switched on.

`UpdateEmailConfigInput.monthlyReportDate` ● `Int` scalar

The day of the month the monthly report is sent.

`UpdateEmailConfigInput.provider` ● `EmailProvider` enum

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

`UpdateEmailConfigInput.replyToEmail` ● `String` scalar

The address replies go to.

`UpdateEmailConfigInput.sendAlerts` ● `Boolean` scalar

True to send alert emails.

`UpdateEmailConfigInput.sendNotifications` ● `Boolean` scalar

True to send notification emails.

`UpdateEmailConfigInput.sendReports` ● `Boolean` scalar

True to send report emails.

`UpdateEmailConfigInput.smtpHost` ● `String` scalar

The SMTP server.

`UpdateEmailConfigInput.smtpPassword` ● `String` scalar

The SMTP password. It is write-only.

`UpdateEmailConfigInput.smtpPort` ● `Int` scalar

The SMTP port.

`UpdateEmailConfigInput.smtpSecure` ● `Boolean` scalar

True to use a secure connection.

`UpdateEmailConfigInput.smtpUser` ● `String` scalar

The SMTP user name.

`UpdateEmailConfigInput.weeklyReportDay` ● `Int` scalar

The day of the week the weekly report is sent.

Member Of

updateEmailConfig mutation

Fields
Member Of