ERPNext DocType Inspector

Email Account

Module: Email

Export API Coming Soon

Total Fields

Required Fields

Read-only Fields

Link Fields

DocType Properties

Is Submittable: No
Is Tree: No
Track Changes: Yes

Custom: No
Naming Series: Not set
Search By: Not set

Fields (60)

Field Name	Label	Type	Options	Properties	Default
`email_id`	Email Address	Data	Email	Required	-
`email_account_name`	Email Account Name	Data	-	Unique	-
`enable_incoming`	Enable Incoming	Check	-		0
`enable_outgoing`	Enable Outgoing	Check	-		0
`service`	Service	Select	Frappe Mail GMail +5 more		-
`domain`	Domain	Link	Email Domain		-
`frappe_mail_site`	Frappe Mail Site	Data	-		https://frappemail.com
`auth_method`	Method	Select	Basic OAuth		Basic
`backend_app_flow`	Authenticate as Service Principal	Check	-		0
`authorize_api_access`	Authorize API Access	Button	-		-
`validate_frappe_mail_settings`	Validate Frappe Mail Settings	Button	-		-
`password`	Password	Password	-		-
`awaiting_password`	Awaiting password	Check	-		0
`ascii_encode_password`	Use ASCII encoding for password	Check	-		0
`api_key`	API Key	Data	-		-
`api_secret`	API Secret	Password	-		-
`connected_app`	Connected App	Link	Connected App		-
`connected_user`	Connected User	Link	User		-
`login_id_is_different`	Use different Email ID	Check	-		0
`login_id`	Alternative Email ID	Data	-		-
`default_incoming`	Default Incoming	Check	-		0
`attachment_limit`	Attachment Limit (MB)	Int	-		-
`last_received_at`	Last Received At	Datetime	-		-
`use_imap`	Use IMAP	Check	-		0
`use_ssl`	Use SSL	Check	-		0
`validate_ssl_certificate`	Validate SSL Certificate	Check	-		1
`use_starttls`	Use STARTTLS	Check	-		0
`email_server`	Incoming Server	Data	-		-
`incoming_port`	Port	Data	-		-
`email_sync_option`	Email Sync Option	Select	ALL UNSEEN		UNSEEN
`initial_sync_count`	Initial Sync Count	Select	100 250 500		250
`imap_folder`	IMAP Folder	Table	IMAP Folder		-
`append_emails_to_sent_folder`	Append Emails to Sent Folder	Check	-		0
`sent_folder_name`	Sent Folder Name	Data	-		-
`append_to`	Append To	Link	DocType		-
`create_contact`	Create Contacts from Incoming Emails	Check	-		1
`enable_automatic_linking`	Enable Automatic Linking in Documents	Check	-		0
`notify_if_unreplied`	Notify if unreplied	Check	-		0
`unreplied_for_mins`	Notify if unreplied for (in mins)	Int	-		30
`send_notification_to`	Send Notification to	Small Text	-		-
`default_outgoing`	Default Outgoing	Check	-		0
`always_use_account_email_id_as_sender`	Always use this email address as sender address	Check	-		0
`always_use_account_name_as_sender_name`	Always use this name as sender name	Check	-		0
`send_unsubscribe_message`	Send unsubscribe message in email	Check	-		1
`track_email_status`	Track Email Status	Check	-		1
`use_tls`	Use TLS	Check	-		0
`use_ssl_for_outgoing`	Use SSL	Check	-		0
`smtp_server`	Outgoing Server	Data	-		-
`smtp_port`	Port	Data	-		-
`no_smtp_authentication`	Disable SMTP server authentication	Check	-		0
`always_bcc`	Always BCC Address	Data	Email		-
`add_signature`	Add Signature	Check	-		0
`signature`	Signature	Text Editor	-		-
`enable_auto_reply`	Enable Auto Reply	Check	-		0
`auto_reply_message`	Auto Reply Message	Text Editor	-		-
`footer`	Footer Content	Text Editor	-		-
`brand_logo`	Brand Logo	Attach Image	-		-
`uidvalidity`	UIDVALIDITY	Data	-	Hidden	-
`uidnext`	UIDNEXT	Int	-	Hidden	-
`no_failed`	no failed attempts	Int	-	Read-only Hidden	-

Raw DocType Data

export enum Enable_incomingEnum { 0, 1 }

export enum Enable_outgoingEnum { 0, 1 }

export enum ServiceEnum { 'Frappe Mail', 'GMail', 'Sendgrid', 'SparkPost', 'Yahoo Mail', 'Outlook.com', 'Yandex.Mail' }

export enum Auth_methodEnum { 'Basic', 'OAuth' }

export enum Backend_app_flowEnum { 0, 1 }

export enum Awaiting_passwordEnum { 0, 1 }

export enum Ascii_encode_passwordEnum { 0, 1 }

export enum Login_id_is_differentEnum { 0, 1 }

export enum Default_incomingEnum { 0, 1 }

export enum Use_imapEnum { 0, 1 }

export enum Use_sslEnum { 0, 1 }

export enum Validate_ssl_certificateEnum { 0, 1 }

export enum Use_starttlsEnum { 0, 1 }

export enum Email_sync_optionEnum { 'ALL', 'UNSEEN' }

export enum Initial_sync_countEnum { '100', '250', '500' }

export enum Append_emails_to_sent_folderEnum { 0, 1 }

export enum Create_contactEnum { 0, 1 }

export enum Enable_automatic_linkingEnum { 0, 1 }

export enum Notify_if_unrepliedEnum { 0, 1 }

export enum Default_outgoingEnum { 0, 1 }

export enum Always_use_account_email_id_as_senderEnum { 0, 1 }

export enum Always_use_account_name_as_sender_nameEnum { 0, 1 }

export enum Send_unsubscribe_messageEnum { 0, 1 }

export enum Track_email_statusEnum { 0, 1 }

export enum Use_tlsEnum { 0, 1 }

export enum Use_ssl_for_outgoingEnum { 0, 1 }

export enum No_smtp_authenticationEnum { 0, 1 }

export enum Add_signatureEnum { 0, 1 }

export enum Enable_auto_replyEnum { 0, 1 }

export interface Email AccountSchema {
  email_id: string;
  email_account_name?: string;
  enable_incoming?: Enable_incomingEnum;
  enable_outgoing?: Enable_outgoingEnum;
  service?: ServiceEnum;
  domain?: string;
  frappe_mail_site?: string;
  auth_method?: Auth_methodEnum;
  backend_app_flow?: Backend_app_flowEnum;
  authorize_api_access?: string;
  validate_frappe_mail_settings?: string;
  password?: string;
  awaiting_password?: Awaiting_passwordEnum;
  ascii_encode_password?: Ascii_encode_passwordEnum;
  api_key?: string;
  api_secret?: string;
  connected_app?: string;
  connected_user?: string;
  login_id_is_different?: Login_id_is_differentEnum;
  login_id?: string;
  default_incoming?: Default_incomingEnum;
  attachment_limit?: number;
  last_received_at?: string;
  use_imap?: Use_imapEnum;
  use_ssl?: Use_sslEnum;
  validate_ssl_certificate?: Validate_ssl_certificateEnum;
  use_starttls?: Use_starttlsEnum;
  email_server?: string;
  incoming_port?: string;
  email_sync_option?: Email_sync_optionEnum;
  initial_sync_count?: Initial_sync_countEnum;
  imap_folder?: Record[];
  append_emails_to_sent_folder?: Append_emails_to_sent_folderEnum;
  sent_folder_name?: string;
  append_to?: string;
  create_contact?: Create_contactEnum;
  enable_automatic_linking?: Enable_automatic_linkingEnum;
  notify_if_unreplied?: Notify_if_unrepliedEnum;
  unreplied_for_mins?: number;
  send_notification_to?: string;
  default_outgoing?: Default_outgoingEnum;
  always_use_account_email_id_as_sender?: Always_use_account_email_id_as_senderEnum;
  always_use_account_name_as_sender_name?: Always_use_account_name_as_sender_nameEnum;
  send_unsubscribe_message?: Send_unsubscribe_messageEnum;
  track_email_status?: Track_email_statusEnum;
  use_tls?: Use_tlsEnum;
  use_ssl_for_outgoing?: Use_ssl_for_outgoingEnum;
  smtp_server?: string;
  smtp_port?: string;
  no_smtp_authentication?: No_smtp_authenticationEnum;
  always_bcc?: string;
  add_signature?: Add_signatureEnum;
  signature?: string;
  enable_auto_reply?: Enable_auto_replyEnum;
  auto_reply_message?: string;
  footer?: string;
  brand_logo?: string;
  uidvalidity?: string;
  uidnext?: number;
  no_failed?: number;
}