Change SMTP Attributes (CHGSMTPA)
Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Change SMTP Attributes (CHGSMTPA) command is used to change common SMTP attributes such as retries, name delimiters, mail router, and the automatic registration of remote users into the system directory.
Changes for the following parameters take effect immediately the next time SMTP processes an email:
ADDRESS, ALLMAILMSF, ALWAUTH, ALWBARELF, ALWRLY, AUTOADD, CCSID, ETRNCLT, ETRNSVR, FIREWALL, FWDHUBSVR, FTRACN, IFCDMN, JOURNAL, KEEPUNTIL, MAILROUTER, MAXEMMSIZE, MAXINEMM, MAXOUTEMM, MIME8BIT, NFYDLVRY, OVRRJTCNNL, PCTRTGCHR, POPWDW, RBLSVR, RTYDAY, RTYHOUR, RTYMIN, RTYRMTSVR,SYSNAME, TBLSMTPIN, TBLSMTPOUT, TBLTYPE, USRIDPFX, VFYFROMUSR, VFYID, and VFYMSFMSG.
Changes for the following parameters take effect the next time SMTP is started:
AUTOSTART, ALWIMPSSL, COLDSTART, DIALSCD, DIRTYPE, SBSD, and USRIDDELIM.
Restrictions:
- You must have input/output system configuration (*IOSYSCFG) special authority to use this command.
Top |
Parameters
Keyword | Description | Choices | Notes |
---|---|---|---|
AUTOSTART | Autostart server | *SAME, *YES, *NO | Optional, Positional 1 |
COLDSTART | Clear e-mail on start-up | *SAME, *YES, *NO | Optional |
DIRTYPE | E-mail directory type | *SAME, *SMTP, *SMTPMSF, *SDD | Optional |
RTYMIN | Retries by minute | Element list | Optional |
Element 1: Number of retries | 0-99, *SAME, *DFT | ||
Element 2: Time interval | 0-99, *SAME, *DFT | ||
RTYDAY | Retries by day | Element list | Optional |
Element 1: Number of retries | 0-9, *SAME, *DFT | ||
Element 2: Time interval | 0-9, *SAME, *DFT | ||
RTYHOUR | Retries by hour | Element list | Optional |
Element 1: Number of retries | 0-99, *SAME, *DFT | ||
Element 2: Time interval | 0-99, *SAME, *DFT | ||
RTYRMTSVR | Retry remote name server | *SAME, *YES, *NO | Optional |
CCSID | Coded character set identifier | 1-65533, *SAME, *DFT | Optional |
JOURNAL | Journal | *SAME, *YES, *NO | Optional |
PCTRTGCHR | Percent routing character | *SAME, *YES, *NO | Optional |
ETRNSVR | Support ETRN for server | *SAME, *NO, *YES | Optional |
MIME8BIT | Support 8-bit MIME | *SAME, *NO, *YES | Optional |
NFYDLVRY | Delivery status notification | Element list | Optional |
Element 1: Responsible person | Character value, *SAME, *NONE | ||
SBSD | Subsystem description | Single values: *SAME, *DFT Other values: Qualified object name |
Optional |
Qualifier 1: Subsystem description | Name | ||
Qualifier 2: Library | Name | ||
RBLSVR | Realtime Blackhole List | Character value, *SAME, *NONE | Optional |
ALWRLY | Allow relayed mail | Single values: *SAME, *NONE, *ALL, *BOTH Other values (up to 3 repetitions): *LIST, *NEAR, *POPWDW |
Optional |
POPWDW | POP send mail window | 15-65535, *SAME, *NONE | Optional |
IFCDMN | Interface/domain association | *SAME, *NONE, *LIST | Optional |
FTRACN | Filter mail for virus | *SAME, *NONE, *KEEP, *DISCARD | Optional |
OVRRJTCNNL | Override reject connect list | *SAME, *NO, *YES | Optional |
ALWBARELF | Allow bare line feed | *SAME, *NO, *YES | Optional |
VFYID | Verify identification | *SAME, *NO, *YES | Optional |
ALWAUTH | Allow authentication | *SAME, *RELAY, *LCLRLY, *ANONYM, *NONE | Optional |
VFYMSFMSG | Verify MSF messages | *SAME, *YES, *NO | Optional |
VFYFROMUSR | Verify from user | *SAME, *ALL, *LIST, *NONE | Optional |
FWDHUBSVR | Forwarding mailhub server | Character value, *SAME, *NONE | Optional |
AUTOADD | Automatic registration | *SAME, *NO, *YES | Optional |
USRIDPFX | User ID prefix | Communications name, *SAME, *DFT | Optional |
ADDRESS | Address | Communications name, *SAME, *DFT | Optional |
SYSNAME | System name | Character value, *SAME, *DFT | Optional |
TBLTYPE | Alias table type | *SAME, *SYSTEM, *PERSONAL | Optional |
USRIDDELIM | User ID delimiter | *SAME, *DFT, '?', '=', '.', '&', $, #, '/', '+', '_', '-', *, '"' | Optional |
MAILROUTER | Mail router | Character value, *SAME, *NONE | Optional |
TBLSMTPOUT | Outgoing EBCDIC/ASCII table | Single values: *SAME, *CCSID, *DFT Other values: Element list |
Optional |
Element 1: Outgoing EBCDIC/ASCII table | Qualified object name | ||
Qualifier 1: Outgoing EBCDIC/ASCII table | Name | ||
Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
TBLSMTPIN | Incoming ASCII/EBCDIC table | Single values: *SAME, *CCSID, *DFT Other values: Element list |
Optional |
Element 1: Incoming ASCII/EBCDIC table | Qualified object name | ||
Qualifier 1: Incoming ASCII/EBCDIC table | Name | ||
Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
FIREWALL | Firewall | *SAME, *YES, *NO | Optional |
ALLMAILMSF | Process all mail through MSF | *SAME, *YES, *NO | Optional |
DIALSCD | Dial-up scheduler | Single values: *NO Other values: Element list |
Optional |
Element 1: Start with SMTP server | *SAME, *YES | ||
Element 2: Configuration profile | Name, *SAME | ||
Element 3: Connection time interval | 1-1440, *SAME, *NONE | ||
ETRNCLT | Support ETRN for client | Single values: *NO Other values: Element list |
Optional |
Element 1: Enable client ETRN | *SAME, *YES | ||
Element 2: Incoming mail server address | Character value, *SAME | ||
Element 3: Mail domain name | Character value, *SAME | ||
ALWIMPSSL | Allow e-mail over implicit SSL | *SAME, *YES, *NO | Optional |
MAXINEMM | Max incoming e-mail messages | 1-1240000, *SAME, *DFT | Optional |
MAXOUTEMM | Max outgoing e-mail messages | 1-1240000, *SAME, *DFT | Optional |
KEEPUNTIL | Keep until | 1-1240000, *SAME, *DFT | Optional |
MAXEMMSIZE | Maximum e-mail message size | 1000-2000000, *SAME, *DFT | Optional |
ALIASDMN | SMTP domain alias | Single values: *SAME, *NONE Other values (up to 10 repetitions): Character value |
Optional |
Top |
Autostart server (AUTOSTART)
Specifies whether to start the SMTP server automatically when TCP/IP is started by running the Start TCP/IP (STRTCP) command, or the Start TCP/IP Server (STRTCPSVR) command with SERVER(*AUTOSTART) specified. When SMTP is started by running the STRTCPSVR command, this parameter is ignored; the SMTP server is started regardless of the value of this parameter.
- *SAME
- The autostart value that was previously set does not change; otherwise, *YES is used.
- *YES
- Automatically start the SMTP server.
- *NO
- Do not automatically start the SMTP server.
Top |
Clear e-mail on start-up (COLDSTART)
Specifies whether or not to delete e-mails for the current directory type when the SMTP server starts.
- *SAME
- The COLDSTART previously set does not change; otherwise, *NO is used.
- *YES
- All e-mails will be deleted when the SMTP server is started. After a successful start and purge of all e-mails COLDSTART will be set to *NO.
- *NO
- All e-mails will be retained when the SMTP server is started.
Top |
E-mail directory type (DIRTYPE)
Specifies which type of local e-mail directory to use.
- *SAME
- The DIRTYPE previously set does not change; otherwise, *SMTP is used.
- *SMTP
- The server will use the SMTP local directory. Users for this directory are specified via ADDUSRSMTP.
- *SMTPMSF
- The server will use the SMTP local directory and use MSF(Mail Server Framework) to deliver local e-mail. Users for this directory are specified via ADDUSRSMTP.
- *SDD
- The server will use the SDD (System Distribution Directory). Users for this directory are specified via ADDDIRE.
Top |
Retries by minute (RTYMIN)
Specifies the number of attempts and the number of minutes between attempts for SMTP to distribute mail and to retry the remote name server. If the number specified is used and is not successful, the daily retries that are specified by the RTYHOUR parameter are attempted.
Element 1: Number of retries
- *SAME
- The number of retries that was previously set does not change; otherwise, 3 is used.
- *DFT
- The number of first-level distribution retries is set to the default of 3.
- 0-99
- Specify the number of retries to be attempted.
Element 2: Time interval
- *SAME
- The number of minutes between retries that was previously set does not change; otherwise, 30 is used.
- *DFT
- The number of minutes between retries is set to the default of 30 minutes.
- 0-99
- Specify the number of minutes between retries. If a number of retries is set, the time interval must be set to something other than 0. A recommended time interval is something greater than 5 minutes.
Top |
Retries by day (RTYDAY)
Specifies the number of attempts and the number of days between attempts for SMTP to distribute mail and to retry the remote name server. The RTYDAY parameter is used when the RTYMIN parameter was not successful. If the number of RTYDAY attempts is used and is not successful in distributing mail, a status distribution note is returned to the sender. Because the default on the RTYDAY parameter is set to 0 for the number of retries, this level of retry is not used unless intentionally set by the customer. Either, the RTYDAY or RTYHOUR parameter may be chosen for Second Level retry, but not both.
Element 1: Number of retries
- *SAME
- The number of retries that was previously set does not change; otherwise, 0 is used.
- *DFT
- The number of retries is set to the default of 0.
- 0-9
- Specify the number of retries to be attempted. If the number of retries is set, the time interval must be something other than 0.
Element 2: Time interval
- *SAME
- The number of days between retries that was previously set does not change; otherwise, 0 is used.
- *DFT
- The number of days between retries is set to the default of 0 day.
- 0-9
- Specify the number of days between retries. If the number of retries is set, the time interval must be something other than 0.
Top |
Retries by hour (RTYHOUR)
Specifies the number of attempts and the number of hours between attempts for SMTP to distribute mail and to retry the remote name server. The RTYHOUR parameter is used when the RTYMIN parameter was not successful. If the number of retries is greater than zero, and the time interval is greater than zero for RTYHOUR parameter, the RTYDAY parameter values are not used. If the number of RTYHOUR attempts is used and is not successful in distributing mail, a status distribution note is returned to the sender. Because the default on the RTYHOUR parameter is set to 0 for the number of retries, this level of retry is not used unless intentionally set by the customer.
Element 1: Number of retries
- *SAME
- The number of retries that was previously set does not change; otherwise, 0 is used.
- *DFT
- The number of retries is set to the default of 0.
- 0-99
- Specify the number of retries to be attempted. If the number of retries is set, the time interval must be something other than 0.
Element 2: Time interval
- *SAME
- The number of hours between retries that was previously set does not change; otherwise, 0 is used.
- *DFT
- The number of hours between retries is set to the default of 0 minutes.
- 0-99
- Specify the number of hours between retries. If the number of retries is set, the time interval must be something other than 0.
Top |
Retry remote name server (RTYRMTSVR)
Specifies whether SMTP should retry contacting the remote name server when attempts to contact it are unsuccessful. The RTYMIN and RTYHOUR/RTYDAY parameters are used to determine the frequency of retries. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The value for the RTYRMTSVR parameter that was previously set does not change; otherwise, *NO is used.
- *YES
- Try to contact the remote name server again.
- *NO
- Do not attempt to contact the remote name server again.
Top |
Coded character set identifier (CCSID)
Specifies the ASCII coded character set identifier (CCSID) that is used to map all single-byte character set (SBCS) data on outgoing mail. This value is also assumed to be the ASCII CCSID for mapping all SBCS data for incoming mail. Mapping is determined by the specified ASCII CCSID and the EBCDIC CCSID of the job.
The CCSID value chosen is the default used by SMTP for ASCII-to-EBCDIC and EBCDIC-to-ASCII mapping. Outgoing and incoming mapping can be done optionally with mapping tables defined in the TBLSMTPOUT and TBLSMTPIN parameters. Normally the TBLSMTPOUT and TBLSMTPIN parameters are set to the default of *CCSID or *DFT. Both values indicate that the value used in the CCSID parameter is used for mapping.
If a mapping table is used for outgoing mapping, a table object can be specified in the TBLSMTPOUT parameter. The table object specified in the TBLSMTPOUT parameter is used instead of the CCSID value.
Incoming mapping can be changed to use a mapping table by specifying a table object in the TBLSMTPIN parameter. This mapping table overrides the specified CCSID value and is used for incoming mapping.
Double-byte character set (DBCS) CCSID values are not permitted for this parameter. DBCS data is self-identifying in SMTP mail.
- *SAME
- The CCSID value that was previously set does not change; otherwise, 00819 (ISO 8859-1 8-bit ASCII) is used.
- *DFT
- The CCSID value is 00819 (ISO 8859-1 8-bit ASCII).
- 1-65533
- Specify the CCSID value to be used. This value is validated to ensure a valid SBCS CCSID was requested.
Top |
Journal (JOURNAL)
Specifies whether SMTP should write additional journal entries which show mail message transitions, events, and informational data to the Mail Server Framework journal (QUSRSYS/QZMF) as each mail item passes through SMTP.
- *SAME
- The value for the JOURNAL parameter that was previously set does not change; otherwise, *NO is used.
- *YES
- Write additional journal entries as the mail passes throuth MSF. For DIRTYPE *SMTP no journal entries will be cut because MSF is not used. More verbose logging data will be written to the e-mail tracking data used by WRKSMPTEMM when the DIRTYPE keyword for CHGSMTPA is set to *SMTP or *SMTPMSF.
- *NO
- Do not make any additional journal entries.
Top |
Percent routing character (PCTRTGCHR)
Specifies whether the SMTP Server should interpret the '%' character as an SMTP routing character, or allow the character to just pass through. Lotus Notes uses the '%' character as a default separator character for fully qualifying a Lotus Note domain name, ie. John_Smith%NotesDomain1%NotesDomain2@host.domain. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The value for the PCTRTGCHR parameter that was previously set does not change; otherwise, *NO is used.
- *YES
- Interpret the '%' character as an SMTP routing character.
- *NO
- Treat the '%' as just another character.
Note: You should select *NO, if you use Lotus Notes, or you exchange mail with a Lotus Notes domain.
Top |
Support ETRN for server (ETRNSVR)
Specifies whether the SMTP server will support the Service Extension for Remote Message Queue Starting (ETRN) command from a remote host's client. ETRN is described in RFC 1985 SMTP Service Extension for Remote Message Queue Starting.
- *SAME
- The value for the ETRNSVR parameter that was previously set does not change; otherwise, *NO is used.
- *YES
- The server will retry all its mail when an ETRN command is received from a host.domain that is in the accept ETRN list. The accept ETRN list can be specified by using the IBM i Navigator SMTP properties pages or by using the ADDSMTPLE(Add SMTP List Entry) command and specifying *ETRNSVR for the TYPE parameter.
- *NO
- The server will respond with the "502 Command not implemented" when the ETRN command is received. Note:ETRN will not be included in the list of supported extensions when an EHLO response is sent to a querying client.
Top |
Support 8-bit MIME (MIME8BIT)
Specifies whether the 8BITMIME extension is honored by the SMTP server. The SMTP client will try to send the 8BITMIME message (for relayed mail cases), but will send a non-delivery notice to the originator if the destination's mail server does not support 8BITMIME. No conversion will be done. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD, the other directory types handle 8BITMIME by default and do not allow it to be turned off.
- *SAME
- Use the same value for MIME8BIT that was previously set; otherwise, *NO is used.
- *YES
- The server will honor 8BITMIME mail transfers.
- *NO
- The server will not honor 8BITMIME transfers.
Top |
Delivery status notification (NFYDLVRY)
Specifies whether Delivery Status Notification (DSN) is supported and, if supported, the address to use in the "from" field in the delivery status notification.
- *SAME
- Use the same value for NFYDLVRY that was previously set; otherwise, *NONE is used.
- *NONE
- Delivery Status Notification will not be supported. No "from" field address is provided.
- character-value
- Specify the SMTP address, in the format "userid@host.domain", that is used in the "from" field inside a delivery status notification. This should be a valid SMTP address. Up to 255 characters can be specified.
The server will honor a request for Delivery Status Notification from a SMTP client. Status notes, indicating delivery, delay, relay or failure of a note to a recipient, will be generated as requested.
Top |
Subsystem description (SBSD)
Specifies the subsystem description of the subsystem where SMTP server jobs are to run. If the specified subsystem description does not exist, it is created. If the library does not exist where the description is to be created, the command will fail.
If a subsystem description other than an IBM-supplied *SBSD QSYSWRK is specified, a job queue is also created with the same name and in the same library as the specified subsystem description. This job queue is used for submitting SMTP server jobs.
*READ, *ADD, and *EXECUTE authorities are required to the library where the subsystem description and/or job queue are created. If the subsystem description already exists, *READ, *EXECUTE, *OBJMGT and *OBJOPR authorities to the object are required otherwise this command will fail. If the job queue already exists, *READ, *EXECUTE, *OBJMGT, and *OBJOPR authorities are required to that object; otherwise the command will fail. For an existing subsystem description and job queue, the QTCP user profile will be granted *USE authority to these objects.
Single values
- *SAME
- Use the same value for SBSD that was previously set; otherwise, *DFT is used.
- *DFT
- When *DFT is specified, the SMTP server jobs are submitted to job queue QSYSNOMAX in library QSYS and run in the QSYSWRK subsystem.
Qualifier 1: Subsystem description
- name
- Specify the name of the subsystem description that SMTP will use for its server jobs.
Qualifier 2: Library
- name
- Specify the name of the library to be searched.
Top |
Realtime Blackhole List (RBLSVR)
Specify the fully-qualified domain names of the servers to query that are running a Realtime Blackhole List (RBL). If no entry is found for the mail originator's address in the reject connections list, a query will be sent to each RBL server specified in this parameter before mail is accepted for delivery or relay. The reject connections list can be set by using IBM i Navigator SMTP properties pages or by using the ADDSMTPLE command with *REJECT specified for the TYPE parameter.
- *SAME
- Use the same value for RBLSVR that was previously set; otherwise, *NONE is used.
- *NONE
- No Realtime Blackhole List is used.
- character-value
- Specify the list of Realtime Blackhole List servers to be searched, up to three server names may be specified, separated by spaces and enclosed in apostrophes.
Top |
Allow relayed mail (ALWRLY)
Specifies whether to allow relay mail through this server. Relaying email is when the server detects that the email is not local and sends it to another server for delivery. The values of MAILROUTER and FWDMAILHUB only affect the destination to where the mail will be relayed, they do not control if a relay will take place. The value specified for this parameter is ignored if *RELAY or *LCLRLY is specified or in effect for the Allow authentication (ALWAUTH) parameter.
Single values
- *SAME
- Use the same value for ALWRLY that was previously set; otherwise, *NONE is used.
- *NONE
- No mail will be relayed.
- *ALL
- All relayed mail will be allowed.
- *BOTH
- Allow both addresses listed in the relay messages list (*LIST) and addresses to recipients in the near domains (*NEAR) to be relayed.
Other values (up to 3 repetitions)
- *LIST
- Addresses listed in the accept relay messages list will be relayed. The accept relay messages list can be specified by using IBM i Navigator SMTP properties pages or by using the ADDSMTPLE command with a value of *ACCEPT specified for the TYPE parameter.
Note: IBM i POP users on this system should be added to this list if this system is to act as their outbound SMTP server. Any message from POP users must be relayed.
- *NEAR
- Relay mail addressed to any recipients in the near domain list. The domain list can be defined using IBM i Navigator SMTP properties pages or by using the ADDSMTPLE (Add SMTP List Entry) command and specifying *NEAR for the TYPE parameter.
- *POPWDW
- Relay mail for any client who has logged on to the Post Office Protocol (POP) server within the number of minutes specified by the parameter POP send mail window (POPWDW). This requires that a receive POP mail must be done before a send mail is requested by the client.
Top |
POP send mail window (POPWDW)
Specifies the number of minutes to allow a client to send mail, using the SMTP server, to addresses other than a local address. The time starts for each client when the client logs on to the POP server to receive mail.
- *SAME
- The value does not change if it was previously set; otherwise *NONE is used.
- *NONE
- The clients will not be allowed to relay mail after logging on to the POP server.
- 15-65535
- Specify the time interval, in minutes, after logging on to POP that the client can send relay mail using SMTP.
Top |
Interface/domain association (IFCDMN)
Specifies whether SMTP should associate domains with specific interfaces.
- *SAME
- The value for the IFCDMN parameter that was previously set does not change; otherwise, *NONE is used.
- *NONE
- No domains will be associated with a specific interface. The local domain is associated with all interfaces.
- *LIST
- Use the association that is defined in the domain list. The domain list contains the IP address and the domain names that are associated with them. The domain list can be defined by using the IBM i Navigator SMTP properties pages or by using the ADDSMTPLE (Add SMTP List Entry) command and specifying *DOMAIN for the TYPE parameter.
Top |
Filter mail for virus (FTRACN)
Allows mail to be scanned and either discarded or quarantined if a set of conditions are met. These conditions are:
- Subject comparison
- Filename/Extension comparison
- Type/Subtype in Content-Type comparison
- Originator's address
The Subject comparison records are defined by using IBM i Navigator SMTP properties pages or by using the Add SMTP List Entry (ADDSMTPLE) command with a value of *FTRSUBJECT.
The Filename/Extension records are defined by using IBM i Navigator SMTP properties pages or by using the ADDSMTPLE command with a value of *FTRFILNAME.
The Type/Subtype records are defined by using IBM i Navigator SMTP properties pages or by using the ADDSMTPLE command with a value of *FTRTYPE.
The Originator records are defined by using IBM i Navigator SMTP properties pages or by using the ADDSMTPLE command with a value of *FTRORIGIN.
- *SAME
- Use the same value for FTRACN that was previously set; otherwise, *NONE is used.
- *NONE
- No comparison will be made.
- *KEEP
- Keep this message and move it to '/qtcptmm/ftrfiles' but do not send it if the comparison is made.
- *DISCARD
- Discard this message if a comparison is made.
Top |
Override reject connect list (OVRRJTCNNL)
Specifies whether the SMTP server will support a POP-before-mail authorization to override the reject connection list.
- *SAME
- The value for the OVRRJTCNNL parameter that was previously set does not change; otherwise, *NO is used.
- *YES
- If the user is already logged on via POP, he is authorized to the server even if the userid is on the reject connection list.
- *NO
- The server will not authorize the user if he is on the reject connection list.
Top |
Allow bare line feed (ALWBARELF)
Specifies whether the SMTP server will support bare linefeed (LF) instead of carriage return and linefeed (CRLF).
- *SAME
- The value for the ALWBARELF parameter that was previously set does not change; otherwise, *YES is used.
- *YES
- The server will accept emails that contains either linefeed (LF) or carriage return and linefeed (CRLF). Bare linefeed is defined in RFC 2821. Setting this parameter to *YES will enforce this definition.
- *NO
- The server will accept email sent with carriage return and linefeed (CRLF). The server will reject email sent with only linefeed (LF).
Top |
Verify identification (VFYID)
Specifies whether the SMTP server will verify whether the user is in the specified email directory for local delivery. The directory type is specified by the DIRTYPE keyword.
- *SAME
- The value for the VFYID parameter that was previously set does not change; otherwise, *NO is used.
- *NO
- The server will permit any user to logon to SMTP.
- *YES
- The server will only permit users on the authorized list to logon to SMTP.
Top |
Allow authentication (ALWAUTH)
Specifies whether the SMTP server will support transport layer security (TLS) and secure socket layer (SSL), and when authentication of the user will occur. If *RELAY or *LCLRLY is specified or in effect, the value specified for the Allow relayed mail (ALWRLY) parameter is ignored. If *ANONYM or *NONE is specified or in effect, the value specified for the Allow relayed mail (ALWRLY) parameter is used.
- *SAME
- The value for the ALWAUTH parameter that was previously set does not change; otherwise, *NONE is used.
- *NONE
- The server will not use TLS/SSL and no authentication will be done.
- *RELAY
- The server will allow relay mail through this server. The server will use TLS/SSL and authenticate only the relay.
- *LCLRLY
- The server will allow relay mail through this server. The server will use TLS/SSL and authenticate it locally and when using the relay.
- *ANONYM
- The server will use the Allow relayed mail (ALWRLY) parameter to determine whether to allow relay mail through this server. The server will use TLS/SSL and won't do authentication either in relay or local.
Top |
Verify MSF messages (VFYMSFMSG)
Specifies whether the SMTP server will allow the SMTP mail server framework (MSF) snap-ins functions to reject an email that is not verified. For backwards compatibility this will only be valid when the ALWAUTH parameter is set to *LCLRLY. If the email doesn't come from an authenticated source then the user that issued the QzmfCrtMailMsg() function must match the originator of the MSF message.
- *SAME
- The value for the VFYMSFMSG parameter that was previously set does not change; otherwise, *YES is used.
- *YES
- The server will reject unverified MSF messages.
- *NO
- The server will process all MSF messages.
Top |
Verify from user (VFYFROMUSR)
Specifies whether the SMTP server will verify the Mail From: address to see if the user is in the directory specified by the DIRTYPE keyword and if the email address matches. If there isn't a match, and *ALL or *LIST is specified or in effect for this parameter, the user will be rejected. For backwards compatibility this will only be valid when the ALWAUTH parameter is set to *LCLRLY.
- *SAME
- The value for the VFYFROMUSR parameter that was previously set does not change; otherwise, *ALL is used.
- *ALL
- Verification will be done on all users.
- *NONE
- No verification of the users will be done.
- *LIST
- The server will only verify users that are not on the accept list. The accept list is defined by the ADDSMTPLE TYPE(*ACCEPT) CL command.
Top |
Forwarding mailhub server (FWDHUBSVR)
Specifies domain name of the SMTP server that this SMTP server should forward all non-local emails. This makes this SMTP server behave like a mailhub. If you do not want the mail forwarded, you must specify *NONE.
- *SAME
- The mailhub previously set does not change; otherwise, *NONE is used.
- *NONE
- No mail will be forwarded to another SMTP server without resolving the email address of the remote recipient. Instead the SMTP server will directly send to the server of the recipient if no other options that affect the destination address are set.
- character-value
- Specify the fully qualified mail exchanger domain name of the SMTP server that non-local mail on the local system is to take first. The order of DNS records for resolution of a mail exchanger are described in RFC2821. A hostname may be specified provided that the DNS records used in the resolution for mail exchangers are not present for the specified hostname. If an IP address is specified instead of a domain name the IP address will be connected to directly not following the mail exchanger resolution rules from RFC2821. Up to 255 characters can be specified.
Top |
Automatic registration (AUTOADD)
Specifies, for incoming mail, whether the remote user ID and address are automatically added to the system directory and, if necessary, to an alias table. This enables the local user to respond to the mail without first entering the necessary data into the directory and the alias table. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The automatic registration value that was previously set does not change; otherwise, *NO is used.
- *NO
- Do not automatically add remote users into the system directory and the alias table.
- *YES
- Automatically add remote users into the system directory and the alias table.
Top |
User ID prefix (USRIDPFX)
Specifies the 3-character prefix that is to be used with the generated 5-digit number that together make up the SNADS user ID. The SNADS user ID is automatically added to the system directory and the alias table. This parameter takes effect only if the AUTOADD parameter is set to *YES. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The user ID prefix value that was previously set does not change; otherwise, QSM is used.
- *DFT
- The 3-character user ID prefix is set to the default of QSM.
- communications-name
- Specify the 3-character user ID prefix to be used.
Top |
Address (ADDRESS)
Specifies the SNADS address to be generated when remote users are to be automatically added to the system directory and the alias table. This parameter takes effect only if the AUTOADD parameter is set to *YES. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The address value that was previously set does not change; otherwise, QSMRMTAD is used.
- *DFT
- The SNADS address to be automatically added is the default of QSMRMTAD.
- communications-name
- Specify the SNADS address to be automatically added to the system directory and the alias table. Up to 8 characters can be specified.
Top |
System name (SYSNAME)
Specifies the name that SNADS uses to route mail to SMTP. This name should match the distribution routing specified when SMTP was configured. This parameter takes effect only if the AUTOADD parameter is set to *YES. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The system name value that was previously set does not change; otherwise, TCPIP is used.
- *DFT
- SNADS uses the default system name of TCPIP to route mail to SMTP.
- character-value
- Specify the system name to be used by SNADS to route mail to SMTP. Up to 8 characters can be specified.
Top |
Alias table type (TBLTYPE)
Specifies the type of SMTP alias table to be updated with the remote users information if remote users are to be automatically added to the system directory. This parameter takes effect only if the AUTOADD parameter is set to *YES. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The table type value that was previously set does not change; otherwise, *SYSTEM is used.
- *SYSTEM
- Update the SMTP system alias table with the remote user information.
- *PERSONAL
- Update the SMTP personal alias table for the local user with the remote user information.
Top |
User ID delimiter (USRIDDELIM)
Specifies the single character delimiter to be used to separate parts of the SMTP user ID. All subsequent entries in the system and personal alias tables use this new character. The special characters must be enclosed in apostrophes. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The user ID delimiter value that was previously set does not change; otherwise, a question mark ('?') is used.
- *DFT
- The single character delimiter is the question mark (?).
- delimiter-character
- The single character delimiter to be used to separate parts for the SMTP user ID. Only one of the following characters can be specified:
- Question mark (?)
- Equal sign (=)
- Period (.)
- Plus sign (+)
- Ampersand (&)
- Underscore (_)
- Dash (-)
- Dollar sign ($)
- Number sign (#)
- Asterisk (*)
- Quotation marks (")
- Forward slash(/)
Top |
Mail router (MAILROUTER)
Specifies that a mail router should be used when SMTP cannot find the name and address of the recipient in the system or personal alias tables or when SMTP is not able to resolve the address of the recipient. The mail router specified is a server that does know the address of the recipient. Routing is meant for when the recipient cannot be found in the local host table, from the DNS resolution, or from a source route. The use of routing was deprecated in RFC 2821. If you do not want mail routing, you must specify *NONE.
Note: When MAILROUTER(*NONE) is defined, then the FIREWALL parameter will be ignored by the SMTP server.
For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The mail router previously set does not change; otherwise, *NONE is used.
- *NONE
- No mail router is used.
- character-value
- Specify the route that outgoing mail on the local system is to take first. Up to 256 characters can be specified.
Top |
Outgoing EBCDIC/ASCII table (TBLSMTPOUT)
Specifies the outgoing mapping table used by the SMTP client to map outgoing mail from EBCDIC to ASCII.
If a table object is specified for TBLSMTPOUT, the table object is used for outgoing mapping. Otherwise, the CCSID parameter is used to determine outgoing mapping. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
Single values
- *SAME
- The TBLSMTPOUT value does not change if it was previously set; otherwise, *CCSID is used.
- *CCSID
- The CCSID parameter is used to determine outgoing mapping.
- *DFT
- The CCSID parameter is used to determine outgoing mapping.
Qualifier 1: Outgoing EBCDIC/ASCII table
- name
- Specify the name of the outgoing mapping table.
Qualifier 2: Library
- *LIBL
- All libraries in the user and system portions of the job's library list are searched until the first match is found.
- *CURLIB
- The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
- name
- Specify the name of the library to be searched.
Top |
Incoming ASCII/EBCDIC table (TBLSMTPIN)
Specifies the incoming mapping table used by the SMTP server to map incoming data from ASCII to EBCDIC.
If a table object is specified for the TBLSMTPIN parameter, the table object is used for incoming mapping. Otherwise, the CCSID parameter is used to determine incoming mapping. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The TBLSMTPIN value does not change if it was previously set; otherwise, *CCSID is used.
- *CCSID
- The CCSID parameter is used to determine incoming mapping.
- *DFT
- The CCSID parameter is used to determine incoming mapping.
Qualifier 1: Outgoing EBCDIC/ASCII table
- name
- Specify the name of the incoming mapping table.
Qualifier 2: Library
- *LIBL
- All libraries in the user and system portions of the job's library list are searched until the first match is found.
- *CURLIB
- The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
- name
- Specify the name of the library to be searched.
Top |
Firewall (FIREWALL)
Specifies whether outbound mail, destined for a host in a remote domain which didn't resolve, should be routed to the configured mail router to get through the network's firewall.
Note: When MAILROUTER(*NONE) is defined, then the FIREWALL parameter will be ignored by the SMTP server.
For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The firewall value that was previously set does not change; otherwise, *NO is used.
- *YES
- Route the mail to the mail router machine, if it is for a host that is outside the system's domain and the domain did not resolve.
- *NO
- Just send the mail to the recipient's host machine.
Top |
Process all mail through MSF (ALLMAILMSF)
Specifies whether the SMTP server should process all mail that it receives, even mail that is not addressed to the IBM i that the server is running on, and pass it into the Mail Server Framework. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
- *SAME
- The value for the ALLMAILMSF parameter that was previously set does not change; otherwise, *NO is used.
- *YES
- Pass all mail that the SMTP Server receives into the Mail Server Framework.
- *NO
- Only pass mail into the Mail Server Framework if it is addressed to the IBM i the server is running on.
Top |
Dial-up scheduler (DIALSCD)
Determines if the SMTP scheduler should be started to handle dial-up connections. The scheduler is started as a separate SMTP job. An initial connection is first made using the communications profile to establish a Point-to-Point Protocol (PPP) link. The waiting mail is sent, then the job sleeps for the time interval specified. When the time interval expires, the Scheduler reestablishes the communication link and sends any waiting mail accumulated during the interval.
For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
Note: Delivery attempts resulting from the scheduler are not counted as retries (see RTYMIN and RTYHOUR parameters).
Single values
- *NO
- Do not start the SMTP scheduler when the SMTP server is started. If *NO is specified, values for the configuration profile name and the time interval are ignored.
Element 1: Start with SMTP server
- *SAME
- The requested use of the scheduler that was previously set does not change; otherwise, *NO is used.
- *YES
- Start the SMTP scheduler when the SMTP server is started. If *YES is specified, the configuration profile name (element 2) must be specified on this invocation or a previous invocation of the command.
Element 2: Configuration profile
- *SAME
- The requested configuration profile that was previously entered is not changed.
- name
- Specify the name of the configuration profile (PPP or SLIP connection profile) to be used by the scheduler.
Element 3: Connection time interval
- *SAME
- The requested time interval that was previously set is not changed; otherwise, 30 minutes is used.
- *NONE
- No retries will be performed.
- 1-1440
- Specify the number of minutes between connection attempts. This time measurement begins when the scheduler sees that the connection has been successful or receives a failure indication other that the profile not existing. Any other failure as a result of an attempted connection will cause the scheduler to end with message TCP2285 sent to to the QSYSOPR message queue.
Top |
Support ETRN for client (ETRNCLT)
Specifies whether the Service Extension for Remote Message Queue Starting (ETRN) command will be issued to an internet service provider's (ISP's) incoming mail server when a dial-out connection is made. The connection's profile is the one defined in the DIALSCD parameter. ETRN is described in RFC 1985 SMTP Service Extension for Remote Message Queue Starting. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SDD.
Single values
- *NO
- Do not enable the client's ETRN. If *NO is specified, values for address of incoming mail server and mail domain name are ignored.
Element 1: Enable client ETRN
- *SAME
- The requested use of the client's ETRN that was previously set does not change; otherwise, *NO is used.
- *YES
- The SMTP job will make an SMTP connection to the Internet Service's provider incoming mail server's IP address. Once a successful connection is received, the ETRN command will be sent to that server. When *YES is entered, the address of incoming mail server (element 2) and mail domain name (element 3) must be specified on this invocation or a previous invocation of CHGSMTPA.
Element 2: Incoming mail server address
- *SAME
- The configured internet address that was previously entered is not changed.
- character-value
- Specify the address of the ISP's incoming mail server.
Element 3: Mail domain name
- *SAME
- The configured mail domain name that was previously entered is not changed.
- character-value
- Specify the name of the host.domain that the ISP provides mail storage service for on behalf of this IBM i system.
Top |
Allow e-mail over implicit SSL (ALWIMPSSL)
Specifies whether or not to listen on the SMTP implicit SSL port. The port number will be acquired from the system services table the default port is 465. SSL is always required over this port, and the SSL handshake is expected to be done immediately after connect. The value specified for this parameter is ignored if the Allow authentication (ALWAUTH) parameter is set to *NONE. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SMTP or *SMTPMSF.
- *SAME
- The ALWIMPSSL previously set does not change; otherwise, *NO is used.
- *YES
- The SMTP server will listen on the implicit SMTP SSL port.
- *NO
- The SMTP server will not listen on the implicit SMTP SSL port.
Top |
Max incoming e-mail messages (MAXINEMM)
Specifies the maximum number of incoming e-mail messages to process at one time. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SMTP or *SMTPMSF.
- *SAME
- The MAXINEMM previously set does not change; otherwise, *DFT is used.
- *DFT
- The SMTP server will not be constrained and will process as many e-mail messages as system resources allow.
- 1-1240000
- Specify the maximum concurrent email messages to process at a single time, may not be able to be reached if constrained by system resources.
Top |
Max outgoing e-mail messages (MAXOUTEMM)
Specifies the maximum number of outgoing e-mail messages to process at one time. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SMTP or *SMTPMSF.
- *SAME
- The MAXOUTEMM previously set does not change; otherwise, *DFT is used.
- *DFT
- The SMTP server will not be constrained and will process as many e-mail messages as system resources allow.
- 1-1240000
- Specify the maximum concurrent email messages to process at a single time, may not be able to be reached if constrained by system resources.
Top |
Keep until (KEEPUNTIL)
Specifies the length of time to retain e-mail tracking information. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SMTP or *SMTPMSF.
- *SAME
- The KEEPUNTIL previously set does not change; otherwise, *DFT is used.
- *DFT
- The SMTP server will not retain any e-mail tracking information after the e-mail has been put into a final state.
- 1-1240000
- Specify the maximum number of seconds to retain e-mail tracking information after the e-mail has been put into a final state.
Top |
Maximum e-mail message size (MAXEMMSIZE)
Specifies the maximum size of an email message to be accepted. For backwards compatibility this will only be valid when the DIRTYPE parameter is set to *SMTP or *SMTPMSF.
- *SAME
- The MAXEMMSIZE previously set does not change; otherwise, *DFT is used.
- *DFT
- The SMTP server will accept e-mail messages up to 10 megabytes in size.
- 1000-2000000
- Specify the maximum size of an e-mail message to be accepted in kilobytes.
Top |
SMTP domain alias (ALIASDMN)
Specifies the enabled aliases for the email domain, if the SMTP user also specified the alias, alias address should be the preferred originator email address.
Single values
- *SAME
- The ALIASDMN previously set does not change; otherwise, *NONE is used.
- *NONE
- The SMTP server will not use alias for the email domain.
Other value (up to 10 repetitions)
- character-value
- Specifies the alias for the email domain. The characters specified must be upper or lower case latin characters (A-Z, a-z), digits(0-9), or underscore, period, or -. Up to 255 characters can be specified.
Top |
Examples
Example 1: Changing the POP Send Time to two Hours
CHGSMTPA ALWRLY(*POPWDW) POPWDW(120)
This command changes the SMTP attributes to allow a POP client to send mail using the local SMTP server to any remote address for 2 hours (120 minutes) after logging on to the POP server to check mail.
Example 2: Allow Relay for Addresses on List
CHGSMTPA ALWRLY(*LIST)
This command changes the SMTP attributes to allow clients using IP address on a list to send relay mail.
Example 3: Require authentication for Relay
CHGSMTPA ALWAUTH(*RELAY)
This command changes the SMTP attributes to authenticate the SMTP relay prior to accepting email forwarded from that relay.
Example 4: Require Users Not on List be Verified
CHGSMTPA VFYFROMUSR(*LIST)
This command changes the SMTP attributes to require all emails not in the list defined in the ADDSMTPLE *ACCEPT CL command to have the username verified.
Top |
Error messages
*ESCAPE Messages
- CPF0011
- Error detected by prompt override program.
- TCP160B
- Search list limited to six domain names.
- TCP1901
- Internet address &2 not valid.
- TCP1903
- Specified host name not valid.
- TCP2432
- User name exceeds maximum length of &1 bytes.
- TCP2434
- Specified user name not valid.
- TCP2436
- Configuration profile name required.
- TCP261D
- Process did not complete successfully
- TCP264D
- Error occurred processing file.
- TCP4993
- CCSID parameter value &1 not valid.
- TCP4994
- CCSID parameter value &1 not found.
- TCP499A
- Error accessing configuration member.
- TCP8050
- *IOSYSCFG authority required to use &1.
- TCP9503
- File &3 in library &2 not available.
- TCP9999
- Internal system error in program &1.
Top |