跳到主要内容

SmtpSettingsDto

The mail server the portal sends its letters through.

NameTypeDescriptionNotes
hostStringThe host name or address of the mail server. On a cloud portal that has saved no relay of its own every field of this object comes back empty, because the installation's own server is not disclosed - only isDefaultSettings is set there.[optional] [example: mail.example.com] [minLength: 0] [maxLength: 255] [nullable]
portInteger (int32)The port the mail server is reached on - conventionally 25 or 587 without encryption from the start, 465 with it. It is empty when no port was stored, in which case the portal falls back to its own default.[optional] [example: 25] [min: 1] [max: 65535] [nullable]
senderAddressStringThe address the letters are sent from, which appears in the From header and is what a reply goes to.[optional] [example: notify@example.com] [minLength: 0] [maxLength: 255] [nullable]
senderDisplayNameStringThe name shown beside that address in a recipient's mailbox.[optional] [example: Postman] [minLength: 0] [maxLength: 255] [nullable]
credentialsUserNameStringThe account the portal signs in to the mail server as, meaningful only while enableAuth is true.[optional] [example: notify@example.com] [minLength: 0] [maxLength: 255] [nullable]
credentialsUserPasswordStringAlways empty here: the stored password is never returned, so a client that sends these settings back has to supply it again rather than echoing what it read.[optional] [nullable]
enableSSLBooleanWhether the connection to the mail server is encrypted.[optional] [example: true]
enableAuthBooleanWhether the portal signs in to the mail server at all. While it is false the credentials above are ignored and the server is expected to accept mail unauthenticated.[optional] [example: true]
useNtlmBooleanAlways false here: the flag is accepted when settings are saved but is not stored, so it never comes back set and says nothing about how the portal authenticates.[optional] [example: false]
isDefaultSettingsBooleanWhether the portal is still on the mail configuration of the installation rather than on a relay of its own. DELETE api/2.0/smtpsettings/smtp puts it back to true, and while it is true on a cloud portal the fields above are blank rather than showing the installation's server.[optional] [example: true]